Bitset< S > Class Template Reference

#include <Bitset.hpp>

Public Member Functions
	Bitset ()
	Bitset (size_t val)
size_t	Size ()
void	Set (size_t pos)
void	Reset (size_t pos)
void	Flip (size_t pos)
bool	Test (size_t pos)
bool	operator[] (size_t pos)
size_t	FindFirstBit (bool isSet)
size_t	FindFirstRange (size_t count, bool isSet)

Private Member Functions
size_t	TypeSize ()
size_t	Index (size_t bit)
size_t	Offset (size_t bit)

Private Attributes
size_t	map [S]

Detailed Description

template<size_t S>
class Bitset< S >

Definition at line 21 of file Bitset.hpp.

Constructor & Destructor Documentation

Bitset() [1/2]

template<size_t S>

Bitset< S >::Bitset ( )

inline

Construct a new Bitset object and initalize the bitmap to zero.

Definition at line 28 of file Bitset.hpp.

    {
        memset(&map, 0, S);
    }

Bitset() [2/2]

template<size_t S>

Bitset< S >::Bitset ( size_t  val )

inline

Construct a new Bitset object and initialize the bitmap with the desired value.

Parameters

val	Initialization value

Definition at line 39 of file Bitset.hpp.

    {
        for (size_t i = 0; i < S; i++)
            map[i] = val;
    }

Member Function Documentation

FindFirstBit()

template<size_t S>

size_t Bitset< S >::FindFirstBit ( bool  isSet )

inline

Finds and returns the position of the first clear bit.

Parameters

isSet

If true, find the first bit that is set.

Returns

size_t Position of the first bit with desired polarity. If all bits are polarized, SIZE_MAX is returned.

Definition at line 116 of file Bitset.hpp.

    {
        for (size_t i = 0; i < S; i++) {
            if (Test(i) == isSet)
                return i;
        }
        return SIZE_MAX;
    }

Here is the caller graph for this function:

FindFirstRange()

template<size_t S>

size_t Bitset< S >::FindFirstRange ( size_t  count, bool  isSet  )

inline

Finds a range of count clear bits and returns the starting position.

Parameters

count	Number of clear bits desired
isSet	If true, find the first range of count bits that are set.

Returns

size_t Position of the first bit with desired range and polarity. If all bits are polarized, SIZE_MAX is returned.

Definition at line 133 of file Bitset.hpp.

    {
        size_t checkLow, checkHigh, check, idx, offset;
        size_t mask = ((size_t)1 << count) - (size_t)1;
        for (size_t i = 0UL; i < S - count; i++) {
            idx = Index(i);
            offset = Offset(i);
            checkLow = map[idx] >> offset;
            checkHigh = offset ? map[idx + 1] << (TypeSize() - offset) : 0;
            check = checkLow | checkHigh;
 
            if ((check & mask) == isSet)
                return i;
        }
        return SIZE_MAX;
    }

Flip()

template<size_t S>

void Bitset< S >::Flip ( size_t  pos )

inline

Flip the bit at the given position.

Parameters

pos	Target bit to be flipped

Definition at line 80 of file Bitset.hpp.

    {
        Test(pos) ? Reset(pos) : Set(pos);
    }

Index()

template<size_t S>

size_t Bitset< S >::Index ( size_t  bit )

inlineprivate

Definition at line 157 of file Bitset.hpp.

    {
        return bit / TypeSize();
    }

Here is the caller graph for this function:

Offset()

template<size_t S>

size_t Bitset< S >::Offset ( size_t  bit )

inlineprivate

Definition at line 162 of file Bitset.hpp.

    {
        return bit % TypeSize();
    }

Here is the caller graph for this function:

operator[]()

template<size_t S>

bool Bitset< S >::operator[] ( size_t  pos )

inline

Return the value of the bit at the given position Same functionality as Test() as an operator This operator cannot be used to set a bit, only test.

Parameters

pos	Position to be tested

Returns

bool Bit value

Definition at line 104 of file Bitset.hpp.

    {
        return Test(pos);
    }

Reset()

template<size_t S>

void Bitset< S >::Reset ( size_t  pos )

inline

Reset (clear) the bit at the given position.

Parameters

pos	Target bit to be reset

Definition at line 70 of file Bitset.hpp.

    {
        map[Index(pos)] &= ~(1UL << Offset(pos));
    }

Here is the caller graph for this function:

Set()

template<size_t S>

void Bitset< S >::Set ( size_t  pos )

inline

Set the bit for a given position.

Parameters

pos	Target bit to be set

Definition at line 60 of file Bitset.hpp.

    {
        map[Index(pos)] |= 1UL << Offset(pos);
    }

Here is the caller graph for this function:

Size()

template<size_t S>

size_t Bitset< S >::Size ( )

inline

Returns the size of the bitset in bytes.

Returns

size_t Size of the bitset in bytes

Definition at line 50 of file Bitset.hpp.

    {
        return S;
    }

Test()

template<size_t S>

bool Bitset< S >::Test ( size_t  pos )

inline

Return the value of the bit at the given position.

Parameters

pos	Position to be tested

Returns

bool Bit value

Definition at line 91 of file Bitset.hpp.

    {
        return map[Index(pos)] >> Offset(pos) & 1;
    }

Here is the caller graph for this function:

TypeSize()

template<size_t S>

size_t Bitset< S >::TypeSize ( )

inlineprivate

Definition at line 152 of file Bitset.hpp.

    {
        return sizeof(size_t) * CHAR_BIT;
    }

Here is the caller graph for this function:

Field Documentation

map

template<size_t S>

size_t Bitset< S >::map[S]

private

Definition at line 151 of file Bitset.hpp.

---

The documentation for this class was generated from the following file:

• Bitset.hpp