BALL::BitVector Class Reference
[Miscellaneous]

Bit vector class. More...

#include <bitVector.h>


Public Member Functions
Constructors and Destructors
	BitVector ()
	Default constructor.
	BitVector (Size size) throw (Exception::OutOfMemory)
	Detailled constructor.
	BitVector (const BitVector &bit_vector) throw (Exception::OutOfMemory)
	Copy constructor.
	BitVector (const char *bit_string) throw (Exception::OutOfMemory)
	Detailled constructor from an array of char.
virtual	~BitVector ()
	Destructor.
void	clear ()
	Clear method.
Assignment
void	set (const BitVector &bit_vector) throw (Exception::OutOfMemory)
	Assignment from an other BitVector instance.
void	set (const char *bit_string) throw (Exception::OutOfMemory)
	Assignment from a char string.
BitVector &	operator= (const BitVector &bit_vector) throw (Exception::OutOfMemory)
	Assignment from an other BitVector instance.
BitVector &	operator= (const char *bit_string) throw (Exception::OutOfMemory)
	Assignment from a char string.
void	get (BitVector &bitvector) const throw (Exception::OutOfMemory)
	Assignment to an other BitVector.
Accessors
BitVector	operator() (Index first, Index last) const throw (Exception::IndexUnderflow, Exception::IndexOverflow)
	Return a sub-BitVector.
void	setSize (Size size, bool keep=true) throw (Exception::OutOfMemory)
	Set the size of this instance.
Size	getSize () const
	Return the size of this instance.
Size	countValue (bool value) const
	Count a given bool value in this instance.
VectorType &	getBitSet ()
	Return a muteable pointer to the values of this instance.
const VectorType &	getBitSet () const
	Return a constant pointer to the values of this instance.
Bit	operator[] (Index index) throw (Exception::OutOfMemory)
	Random access to the components.
bool	operator[] (Index index) const throw (Exception::IndexUnderflow, Exception::IndexOverflow)
	Constant random access to the components.
void	setBit (Index index, bool value=true) throw (Exception::IndexUnderflow, Exception::OutOfMemory)
	Set the given Bit.
bool	getBit (Index index) throw (Exception::IndexUnderflow, Exception::OutOfMemory)
	Get the value of an element.
bool	getBit (Index index) const throw (Exception::IndexUnderflow, Exception::IndexOverflow)
	Get the value of an element (const version).
void	toggleBit (Index index) throw (Exception::IndexUnderflow, Exception::OutOfMemory)
	Toggle the value of an element.
void	fill (bool value=true, Index first=0, Index last=-1) throw (Exception::IndexUnderflow, Exception::OutOfMemory)
	Fill a part of this instance with a given value.
void	toggle (Index first=0, Index last=-1) throw (Exception::IndexUnderflow, Exception::OutOfMemory)
	Toggle the values of a part of this instance.
void	setUnsignedChar (unsigned char bit_pattern)
	Set a unsigned char as the bit pattern.
unsigned char	getUnsignedChar () const
	Get the bit pattern as unsigned char.
void	setUnsignedShort (unsigned short bit_pattern)
	Set a unsigned short as the bit pattern.
unsigned short	getUnsignedShort () const
	Get the bit pattern as unsigned short.
void	setUnsignedInt (unsigned int bit_pattern)
	Set a unsigned int as the bit pattern.
unsigned int	getUnsignedInt () const
	Get the bit pattern as unsigned int.
void	setUnsignedLong (unsigned long bit_pattern)
	Set a unsigned long as the bit pattern.
unsigned long	getUnsignedLong () const
	Get the bit pattern as unsigned long.
void	bitwiseOr (const BitVector &bit_vector) throw (Exception::OutOfMemory)
	Compute {this or bit_vector}.
void	bitwiseXor (const BitVector &bit_vector) throw (Exception::OutOfMemory)
	Compute {this xor bit_vector}.
void	bitwiseAnd (const BitVector &bit_vector) throw (Exception::OutOfMemory)
	Compute {this and bit_vector}.
BitVector	operator\| (const BitVector &bit_vector) throw (Exception::OutOfMemory)
	Or Operator.
BitVector &	operator\|= (const BitVector &bit_vector) throw (Exception::OutOfMemory)
	Compute {this or bit_vector}.
BitVector	operator& (const BitVector &bit_vector) throw (Exception::OutOfMemory)
	And Operator.
BitVector &	operator&= (const BitVector &bit_vector) throw (Exception::OutOfMemory)
	Compute {this and bit_vector}.
BitVector	operator^ (const BitVector &bit_vector) throw (Exception::OutOfMemory)
	Xor Operator.
BitVector &	operator^= (const BitVector &bit_vector) throw (Exception::OutOfMemory)
	Compute {this xor bit_vector}.
BitVector	operator~ () throw (Exception::OutOfMemory)
	Negate Operator.
Predicates
bool	operator== (const BitVector &bit_vector) const
	Equality operator.
bool	operator!= (const BitVector &bit_vector) const
	Inequality operator.
bool	isAnyBit (bool value, Index first=0, Index last=-1) const throw (Exception::IndexUnderflow, Exception::IndexOverflow)
	Test if any bit in a given range has the given value.
bool	isEveryBit (bool value, Index first=0, Index last=-1) const throw (Exception::IndexUnderflow, Exception::IndexOverflow)
	Test if every bit in a given range has the given value.
Debugging and Diagnostics
bool	isValid () const
	Test if this instance is valid.
Protected Member Functions
void	validateIndex_ (Index &index) throw (Exception::IndexUnderflow, Exception::OutOfMemory)
void	validateIndex_ (Index &index) const throw (Exception::IndexUnderflow, Exception::IndexOverflow)
void	validateRange_ (Index &first, Index &last) const throw (Exception::IndexUnderflow, Exception::IndexOverflow)
Type Definitions and Constants
typedef unsigned char	BlockType
typedef std::vector< BlockType >	VectorType
static const Size	BlockSize
Storers
virtual void	read (std::istream &s) throw (Exception::OutOfMemory)
	Read the values of of type bool from an istream.
virtual void	write (std::ostream &s) const
	Write the values of of type bool to an ostream.
virtual void	write (PersistenceManager &pm) const
	Storable write method.
virtual bool	read (PersistenceManager &pm) throw (Exception::OutOfMemory)
	Storable read method.
BALL_EXPORT friend std::istream &	operator>> (std::istream &s, BitVector &bit_vector) throw (Exception::OutOfMemory)
	Input operator.
BALL_EXPORT friend std::ostream &	operator<< (std::ostream &s, const BitVector &bit_vector)
	Output operator.

Detailed Description

Bit vector class.

Indices may be given as negative arguments: start from the end -1 therefore means the last bit. Some functions resize the instance if a index greater than the size of the instance is given. Other functions throw exception in this case.

Constructor & Destructor Documentation

BALL::BitVector::BitVector ( const char * bit_string ) throw (Exception::OutOfMemory)

Detailled constructor from an array of char.

{Caveat:} the array of char has to be zero-terminated!

Member Function Documentation

void BALL::BitVector::bitwiseAnd ( const BitVector & bit_vector ) throw (Exception::OutOfMemory)

Compute {this and bit_vector}.

The result is saved in this instance.

void BALL::BitVector::bitwiseOr ( const BitVector & bit_vector ) throw (Exception::OutOfMemory)

Compute {this or bit_vector}.

The result is saved in this instance.

void BALL::BitVector::bitwiseXor ( const BitVector & bit_vector ) throw (Exception::OutOfMemory)

Compute {this xor bit_vector}.

The result is saved in this instance.

void BALL::BitVector::clear ( )

Clear method.

This method will set the size of this instance to 0.

Size BALL::BitVector::countValue ( bool value ) const

Count a given bool value in this instance.

Parameters:

value

the value to be counted

Returns:: Size the number of the given value

void BALL::BitVector::fill	(	bool	value = `true`,
		Index	first = `0`,
		Index	last = `-1`
	)			throw (Exception::IndexUnderflow, Exception::OutOfMemory)

Fill a part of this instance with a given value.

If a given index is greater than the size of this instance an exception is thrown.

Parameters:

	value	the value to be set
	first	the starting position
	last	the last element to be filled

bool BALL::BitVector::getBit ( Index index ) const throw (Exception::IndexUnderflow, Exception::IndexOverflow)

Get the value of an element (const version).

If the given index is greater than the size of this instance an exception is thrown. No resizing is done.

Parameters:

index

the index of the element

Returns:: bool the value of the element

bool BALL::BitVector::getBit ( Index index ) throw (Exception::IndexUnderflow, Exception::OutOfMemory)

Get the value of an element.

If the given index is greater than the size of this instance, this BitVector is increased to the given index.

Parameters:

index

the index of the element

Returns:: bool the value of the element

const VectorType& BALL::BitVector::getBitSet ( ) const

Return a constant pointer to the values of this instance.

Returns:: unsigned char* a constant pointer to the values of this instance

VectorType& BALL::BitVector::getBitSet ( )

Return a muteable pointer to the values of this instance.

Returns:: unsigned char* a muteable pointer to the values of this instance

unsigned char BALL::BitVector::getUnsignedChar ( ) const

Get the bit pattern as unsigned char.

For example: 00010110 => 22.

Returns:: unsigned char the bit-pattern

unsigned int BALL::BitVector::getUnsignedInt ( ) const

Get the bit pattern as unsigned int.

See also:: getUnsignedChar

unsigned long BALL::BitVector::getUnsignedLong ( ) const

Get the bit pattern as unsigned long.

See also:: getUnsignedChar

unsigned short BALL::BitVector::getUnsignedShort ( ) const

Get the bit pattern as unsigned short.

See also:: getUnsignedChar

bool BALL::BitVector::isAnyBit	(	bool	value,
		Index	first = `0`,
		Index	last = `-1`
	)			const throw (Exception::IndexUnderflow, Exception::IndexOverflow)

Test if any bit in a given range has the given value.

Parameters:

	value	the value to look for
	first	the index to start searching
	last	the index to stop searching

bool BALL::BitVector::isEveryBit	(	bool	value,
		Index	first = `0`,
		Index	last = `-1`
	)			const throw (Exception::IndexUnderflow, Exception::IndexOverflow)

Test if every bit in a given range has the given value.

Parameters:

	value	the value to look for
	first	the index to start searching
	last	the index to stop searching

BitVector BALL::BitVector::operator& ( const BitVector & bit_vector ) throw (Exception::OutOfMemory)

And Operator.

Creates a new BitVector object and fills it with the result of {this and bit_Vector}.

BitVector& BALL::BitVector::operator&= ( const BitVector & bit_vector ) throw (Exception::OutOfMemory)

Compute {this and bit_vector}.

The result is saved in this instance.

BitVector BALL::BitVector::operator()	(	Index	first,
		Index	last
	)			const throw (Exception::IndexUnderflow, Exception::IndexOverflow)

Return a sub-BitVector.

A new BitVector is created and filled with elements of this instance.

Parameters:

	first	the index of the first element to be copied
	last	the index of the last element to be copied

Returns:: BitVector a partial copy of this instance

BitVector& BALL::BitVector::operator= ( const char * bit_string ) throw (Exception::OutOfMemory)

Assignment from a char string.

If a char is different from '0', it is interpreted as true.

bool BALL::BitVector::operator[] ( Index index ) const throw (Exception::IndexUnderflow, Exception::IndexOverflow)

Constant random access to the components.

If the given index is greater than the size of this instance an exception is thrown.

Returns:: bool the value of the given index

Bit BALL::BitVector::operator[] ( Index index ) throw (Exception::OutOfMemory)

Random access to the components.

If the given index is greater than the size of this instance, this BitVector is increased to the given index.

Returns:: Bit a Bit pointing to the given element of this instance

BitVector BALL::BitVector::operator^ ( const BitVector & bit_vector ) throw (Exception::OutOfMemory)

Xor Operator.

Creates a new BitVector object and fills it with the result of {this Xor bit_vector}.

BitVector& BALL::BitVector::operator^= ( const BitVector & bit_vector ) throw (Exception::OutOfMemory)

Compute {this xor bit_vector}.

The result is saved in this instance.

BitVector BALL::BitVector::operator| ( const BitVector & bit_vector ) throw (Exception::OutOfMemory)

Or Operator.

Creates a new BitVector object and fills it with the result of {this or bit_Vector}.

BitVector& BALL::BitVector::operator|= ( const BitVector & bit_vector ) throw (Exception::OutOfMemory)

Compute {this or bit_vector}.

The result is saved in this instance.

BitVector BALL::BitVector::operator~ ( ) throw (Exception::OutOfMemory)

Negate Operator.

Creates a new BitVector object and fills it with the negate result of this instance.

void BALL::BitVector::set ( const char * bit_string ) throw (Exception::OutOfMemory)

Assignment from a char string.

If a char is different from '0', it is interpreted as true. {Caveat:} the array of char has to be zero-terminated!

void BALL::BitVector::setBit	(	Index	index,
		bool	value = `true`
	)			throw (Exception::IndexUnderflow, Exception::OutOfMemory)

Set the given Bit.

The element at the given position is set to the given value. If the given index is greater than the size of this instance, this BitVector is increased to the given index.

Parameters:

	index	the index of the element
	value	the value to be set

void BALL::BitVector::setSize	(	Size	size,
		bool	keep = `true`
	)			throw (Exception::OutOfMemory)

Set the size of this instance.

Parameters:

	size	the new size
	keep	?????

void BALL::BitVector::setUnsignedChar ( unsigned char bit_pattern )

Set a unsigned char as the bit pattern.

For example: 22 => 00010110.

Parameters:

bit_pattern

the new pattern.

void BALL::BitVector::setUnsignedInt ( unsigned int bit_pattern )

Set a unsigned int as the bit pattern.

See also:: setUnsignedChar

void BALL::BitVector::setUnsignedLong ( unsigned long bit_pattern )

Set a unsigned long as the bit pattern.

See also:: setUnsignedChar

void BALL::BitVector::setUnsignedShort ( unsigned short bit_pattern )

Set a unsigned short as the bit pattern.

See also:: setUnsignedChar

void BALL::BitVector::toggle	(	Index	first = `0`,
		Index	last = `-1`
	)			throw (Exception::IndexUnderflow, Exception::OutOfMemory)

Toggle the values of a part of this instance.

If a given index is greater than the size of this instance an exception is thrown.

Parameters:

	value	the value to be set
	first	the starting position
	last	the last element to be filled

void BALL::BitVector::toggleBit ( Index index ) throw (Exception::IndexUnderflow, Exception::OutOfMemory)

Toggle the value of an element.

If the given index is greater than the size of this instance an exception is thrown.

Parameters:

index

the index of the element

Friends And Related Function Documentation

BALL_EXPORT friend std::ostream& operator<<	(	std::ostream &	s,
		const BitVector &	bit_vector
	)			`[friend]`

Output operator.

Writes the values of type bool to an ostream.

BALL_EXPORT friend std::istream& operator>>	(	std::istream &	s,
		BitVector &	bit_vector
	)			throw (Exception::OutOfMemory) `[friend]`

Input operator.

Reads the values of type bool from an istream.

BALL::BitVector Class Reference [Miscellaneous]

Public Member Functions

Protected Member Functions

Type Definitions and Constants

Storers

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

BALL::BitVector Class Reference
[Miscellaneous]