UT/UT_RLEBitArray.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:
 *      Rob Bairos,
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        UT_RLEBitArray.h ( UT Library, C++)
 *
 * COMMENTS:
 *
 *      run length encoded bit array
 *
 */

#ifndef __UT_RLEBitArray__
#define __UT_RLEBitArray__

#include "UT_API.h"
#include <limits.h>
#include "UT_LinkList.h"
#include "UT_Algorithm.h"

class UT_API UT_RLEBitArray
{
public:
    enum { LOWEST_INDEX = INT_MIN };

     UT_RLEBitArray();
    ~UT_RLEBitArray();

    void                 swap( UT_RLEBitArray &other );

    // For most efficient use, call the following increasing values of idx

    int                  numBitsSet() const;

    int                  getBit(int idx) const;
    bool                 getBitRun(int idx, int &start, int &end) const;

    void                 setBitTrue(int idx);
    void                 setBitFalse(int idx);
    void                 setBit( int idx, int value)
                         {
                             if( value )
                                 setBitTrue( idx );
                             else
                                 setBitFalse( idx );
                         }
    void                 setBitRunTrue( int start, int end );

    int                  toggleBit(int idx);

    void                 clear();
    bool                 isEmpty() const;
    int                  getNextRun(int &start, int &end, bool first=false);

    // returns true and sets currentBit to the next set bit
    // otherwise returns false leaving currentBit unchanged
    // to start off your search, set currentBit to LOWEST_INDEX (or below the
    // first set bit)
    // you could write, for example:
    // int      i = UT_RLEBitArray::LOWEST_INDEX; // (or -1 if applicable)
    // while( iterate( i ) ) { blah; }
    bool                 iterate( int &currentBit );

    int64                getMemoryUsage() const;

    void                 display() const;

    // operators
    int          operator()(int index) const { return getBit(index); }
    int          operator[](int index) const { return getBit(index); }
    // A and B
    const UT_RLEBitArray&operator&=(const UT_RLEBitArray &v);
    // A or B
    const UT_RLEBitArray&operator|=(const UT_RLEBitArray &v);
    // A and not B or not A and B
    const UT_RLEBitArray&operator^=(const UT_RLEBitArray &v);
    // A and not B
    const UT_RLEBitArray&operator-=(const UT_RLEBitArray &v);
    const UT_RLEBitArray&operator= (const UT_RLEBitArray &v);
    int          operator==(const UT_RLEBitArray &v) const;
    int          operator!=(const UT_RLEBitArray &v) const;

protected:
    void                 restartSearch() const;
    void                 restartSearchForIndex( int idx ) const;
    void                 advanceSearchNode() const;

    class                Node;

    UT_LinkList          myList;
    mutable Node        *mySearchNode;
    mutable int          myLastIndex;
};

UT_SWAPPER_CLASS( UT_RLEBitArray )

#endif

---