libnebular::bits Namespace Reference
[User API]

Routines to work with integers as with "bit vectors". More...

Functions

template<typename BitContainer >
Integer getContigLength (BitContainer a)
 Length of contiguous bits.
template<typename BitContainer >
Integer getHighestBitIndex (BitContainer a)
 Index of highest bit.
template<typename BitContainer >
bool areContig (BitContainer a)
 Are bits in being contiguous.
template<typename BitContainer >
bool areSubsetOf (BitContainer a, BitContainer b)
 Are bits in a being subset of bits in b.
template<typename BitContainer >
BitContainer generateContig (Integer length)
 Generate integer with length contiguous bits starting from offset 0.
template Integer getHighestBitIndex< Integer > (Integer a)
template Integer getContigLength< Integer > (Integer a)
template bool areContig (Integer a)
template bool areSubsetOf (Integer a, Integer b)
template Integer generateContig< Integer > (Integer length)

Variables

const Integer HAVE_NOT = -1
 Return value indicating that "have not".
const Integer ARE_NOT_CONTIG = HAVE_NOT
 Return value indicating that "bits aren't contiguous".

Detailed Description

Routines to work with integers as with "bit vectors".


Function Documentation

template bool libnebular::bits::areContig ( Integer  a  ) 
template<typename BitContainer >
bool libnebular::bits::areContig ( BitContainer  a  )  [inline]

Are bits in being contiguous.

template bool libnebular::bits::areSubsetOf ( Integer  a,
Integer  b 
)
template<typename BitContainer >
bool libnebular::bits::areSubsetOf ( BitContainer  a,
BitContainer  b 
) [inline]

Are bits in a being subset of bits in b.

template<typename BitContainer >
BitContainer libnebular::bits::generateContig ( Integer  length  )  [inline]

Generate integer with length contiguous bits starting from offset 0.

template Integer libnebular::bits::generateContig< Integer > ( Integer  length  ) 
template<typename BitContainer >
Integer libnebular::bits::getContigLength ( BitContainer  a  )  [inline]

Length of contiguous bits.

All bits in a should be contiguous.

Return values:
bits::ARE_NOT_CONTIG Allowed
template Integer libnebular::bits::getContigLength< Integer > ( Integer  a  ) 
template<typename BitContainer >
Integer libnebular::bits::getHighestBitIndex ( BitContainer  a  )  [inline]

Index of highest bit.

Return values:
bits::HAVE_NOT Allowed

Here is the caller graph for this function:

template Integer libnebular::bits::getHighestBitIndex< Integer > ( Integer  a  ) 

Variable Documentation

Return value indicating that "bits aren't contiguous".

Definition at line 114 of file libnebular.hpp.

Return value indicating that "have not".

Definition at line 112 of file libnebular.hpp.

Generated on Sun May 29 18:23:57 2011 for libnebular by  doxygen 1.6.3