bit_set.h

Go to the documentation of this file.

/* Copyright, 2000 Nevrax Ltd.
 *
 * This file is part of NEVRAX NEL.
 * NEVRAX NEL is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.

 * NEVRAX NEL is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with NEVRAX NEL; see the file COPYING. If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */

#ifndef NL_BIT_SET_H
#define NL_BIT_SET_H


#include "types_nl.h"
#include "stream.h"


namespace   NLMISC
{

// Size in bit of base word.
#define NL_BITLEN           (4*8)
#define NL_BITLEN_SHIFT     5


// ***************************************************************************
class   CBitSet
{
public:
    /* ***********************************************
     *  WARNING: This Class/Method must be thread-safe (ctor/dtor/serial): no static access for instance
     *  It can be loaded/called through CAsyncFileManager for instance
     * ***********************************************/


    CBitSet();
    CBitSet(uint numBits);
    CBitSet(const CBitSet &bs);
    ~CBitSet();
    CBitSet &operator=(const CBitSet &bs);



    void    resize (uint numBits);
    void    resizeNoReset (uint numBits, bool value=false);
    void    clear();
    uint    size() const
    {
        return NumBits;
    }
    void    set(sint bitNumber, bool value)
    {
        nlassert(bitNumber>=0 && bitNumber<NumBits);

        uint    mask= bitNumber&(NL_BITLEN-1);
        mask= 1<<mask;
        if(value)
            Array[bitNumber >> NL_BITLEN_SHIFT]|= mask ;
        else
            Array[bitNumber >> NL_BITLEN_SHIFT]&= ~mask;
    }
    bool    get(sint bitNumber) const
    {
        nlassert(bitNumber>=0 && bitNumber<NumBits);

        uint    mask= bitNumber&(NL_BITLEN-1);
        mask= 1<<mask;
        return (Array[bitNumber >> NL_BITLEN_SHIFT] & mask) != 0;
    }
    bool    operator[](sint bitNumber) const
    {
        return get(bitNumber);
    }
    void    set(sint bitNumber) {set(bitNumber, true);}
    void    clear(sint bitNumber) {set(bitNumber, false);}
    void    setAll();
    void    clearAll();




    CBitSet operator~() const;
    CBitSet operator&(const CBitSet &bs) const;
    CBitSet operator|(const CBitSet &bs) const;
    CBitSet operator^(const CBitSet &bs) const;

    void    flip();
    CBitSet &operator&=(const CBitSet &bs);
    CBitSet &operator|=(const CBitSet &bs);
    CBitSet &operator^=(const CBitSet &bs);




    bool    compareRestrict(const CBitSet &bs) const;
    bool    operator==(const CBitSet &bs) const;
    bool    operator!=(const CBitSet &bs) const;
    bool    allSet();
    bool    allCleared();


    void    serial(NLMISC::IStream &f);

    const std::vector<uint32>& getVector() const { return Array; }

    void    setUint( uint32 srcValue, uint i ) { Array[i] = srcValue; }

    std::string toString() const;

private:
    std::vector<uint32> Array;
    sint                NumBits;
    uint32              MaskLast;   // Mask for the last uint32.
};


}



#endif // NL_BIT_SET_H

/* End of bit_set.h */