GPL_BitGroup

gpl

1998 12-05

CLASS

GPL_BitGroup - C++ generic, arbitrary size bit group

SYNOPSIS

GPL_BitGroup provides a bit group of arbitrary size. Specifically, bit group may have more bits than available in a word on the platform.

PARENTS

GPL_Depictable

public

OPERATORS

inline GPL_BitGroup operator~(void) const

Invert()

inline GPL_BitGroup operator|(const GPL_BitGroup & bitGroup) const
Return the value returned by Join().

inline GPL_BitGroup operator&(const GPL_BitGroup & bitGroup) const
Return the value returned by Intersect().

inline GPL_BitGroup operator-(const GPL_BitGroup & bitGroup) const
Return the value returned by Subtract().

inline GPL_Boolean operator==(const GPL_BitGroup & bitGroup) const
Return TRUE if Compare() returns zero and FALSE otherwise.

inline GPL_Boolean operator!=(const GPL_BitGroup & bitGroup) const
Return TRUE if Compare() does not return zero and FALSE otherwise.

inline GPL_Bit operator[](const unsigned long i)
Return the bit at the offset indicated by i, specifically GPL_Bit(i, this). If i is out of bounds (i.e., greater than or equal to the value returned by GetCount()), the returned GPL_Bit object will not be able to alter the bit group.

inline unsigned long GetCount(void) const
Return the number of bits in the bit group.

GPL_Boolean GetBit(const unsigned long i) const
Return TRUE if i is in bounds and the bit at i is set and FALSE otherwise.

unsigned long GetGroup(const unsigned long offset, const unsigned long mask)
Return the bits indicated by mask at the offset indicated by offset or zero if offset is out of bounds.

GPL_Boolean IsClear(void) const
Return TRUE if no bits are set. Return FALSE if any bit is set.

long Compare(const GPL_BitGroup & bitGroup) const
Return a value less than, equal to, or greater than zero if the bit group is less than, equal to, or greater than bitGroup, respectively.

GPL_BitGroup Invert(void) const
Return a bit group where each bit is the inverse of the bit at the corresponding offset in this bit group.

GPL_BitGroup Join(const GPL_BitGroup & bitGroup) const
Return a bit group which is the union of this bit group and bitGroup.

GPL_BitGroup Intersect(const GPL_BitGroup & bitGroup) const
Return a bit group which is the intersection of this bit group and bitGroup.

GPL_BitGroup Subtract(const GPL_BitGroup & bitGroup) const
Return a bit group which is the disjunction of this bit group and bitGroup.

void Resize(const unsigned long s)
Set the number of bits represented, and stored, by this bit group to be s. If s is less than the current length, data is lost. If s is greater than the current length, the new bits are cleared.

void Clear(void)
Remove all internal storage for the bit group.

void SetBit(const unsigned long i)
Set the bit at the offset indicated by i.

void SetRange(const unsigned long from, const unsigned long to)
Set the bits from the offset indicated by from to the offset indicated by to, inclusive.

void ClearBit(const unsigned long i)
Clear the bit at the offset indicated by i.

void ClearRange(const unsigned long from, const unsigned long to)
Clear the bits from the offset indicated by from to the offset indicated by to, inclusive.

void ClearAllBits(void)
Clear all bits.

void SetGroup(const unsigned long offset, const unsigned long group, const unsigned long mask)
Set the bits at the offset indicated by offset to the bits in group masked with the bits in mask. Does not alter the bit group if offset is out of bounds.