UT/UT_SparseArray.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Mark Elendt
 *      Side Effects
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        UT library (C++)
 *
 * COMMENTS:    Mantains a sparse array of values.
 *
 */

#ifndef __UT_SparseArray_h__
#define __UT_SparseArray_h__

#include "UT_API.h"
#include "UT_PtrArray.h"

class ut_SparseEntry;

class UT_API UT_SparseArray {
public:
     UT_SparseArray();
    ~UT_SparseArray();

    int          entries() const { return (int)myArray.entries(); }
    void         append(int index, void *data);
    void         remove(int index);

    // This method will not look up based on the array index, but rather on
    // the actual array which stores the sparse entries.
    void        *getRawEntry(int raw_index, int &index);

//
//  These operators find the index specified.  If the index doesn't exist
//      (i.e. hasn't been defined yet), a null value is returned.
    void        *operator()(unsigned int i);
    const void  *operator()(unsigned int i) const;
    void        *operator[](unsigned int i) { return operator()(i); }
    const void  *operator[](unsigned int i) const { return operator()(i); }

//
//  Find an index in the array, returns -1 if the entry doesn't exist.
    int          find(int index) const;
private:

    UT_PtrArray<ut_SparseEntry *>       myArray;
};

#endif

---