Regina Calculation Engine

A small but extremely fast bitmask class that can store up to 8 * sizeof(T) trueorfalse bits. More...
#include <utilities/nbitmask.h>
Public Member Functions  
NBitmask1 ()  
Creates a new bitmask with all bits set to false . More...  
NBitmask1 (size_t)  
Creates a new bitmask with all bits set to false . More...  
NBitmask1 (const NBitmask1< T > &cloneMe)  
Creates a clone of the given bitmask. More...  
void  reset () 
Sets all bits of this bitmask to false . More...  
void  reset (size_t) 
Sets all bits of this bitmask to false . More...  
NBitmask1< T > &  operator= (const NBitmask1< T > &other) 
Sets this bitmask to a copy of the given bitmask. More...  
void  truncate (size_t numBits) 
Leaves the first numBits bits of this bitmask intact, but sets all subsequent bits to false . More...  
bool  get (size_t index) const 
Returns the value of the given bit of this bitmask. More...  
void  set (size_t index, bool value) 
Sets the given bit of this bitmask to the given value. More...  
template<typename ForwardIterator >  
void  set (ForwardIterator indexBegin, ForwardIterator indexEnd, bool value) 
Sets all bits in the given sorted list to the given value. More...  
NBitmask1< T > &  operator&= (const NBitmask1< T > &other) 
Sets this to the intersection of this and the given bitmask. More...  
NBitmask1< T > &  operator= (const NBitmask1< T > &other) 
Sets this to the union of this and the given bitmask. More...  
NBitmask1< T > &  operator^= (const NBitmask1< T > &other) 
Sets this to the exclusive disjunction (XOR) of this and the given bitmask. More...  
NBitmask1< T > &  operator= (const NBitmask1< T > &other) 
Sets this to the set difference of this and the given bitmask. More...  
void  flip () 
Negates every bit in this bitmask. More...  
bool  operator== (const NBitmask1< T > &other) const 
Determines whether this and the given bitmask are identical. More...  
bool  lessThan (const NBitmask1< T > &other) const 
Determines whether this bitmask appears strictly before the given bitmask when bitmasks are sorted in lexicographical order. More...  
bool  operator<= (const NBitmask1< T > &other) const 
Determines whether this bitmask is entirely contained within the given bitmask. More...  
bool  inUnion (const NBitmask1< T > &x, const NBitmask1< T > &y) const 
Determines whether this bitmask is entirely contained within the union of the two given bitmasks. More...  
bool  containsIntn (const NBitmask1< T > &x, const NBitmask1< T > &y) const 
Determines whether this bitmask contains the intersection of the two given bitmasks. More...  
size_t  bits () const 
Returns the number of bits currently set to true in this bitmask. More...  
long  firstBit () const 
Returns the index of the first true bit in this bitmask, or 1 if there are no true bits. More...  
long  lastBit () const 
Returns the index of the last true bit in this bitmask, or 1 if there are no true bits. More...  
bool  atMostOneBit () const 
Determines whether at most one bit is set to true in this bitmask. More...  
Friends  
template<typename X >  
std::ostream &  operator<< (std::ostream &out, const NBitmask1< X > &mask) 
A small but extremely fast bitmask class that can store up to 8 * sizeof(T) trueorfalse bits.
This bitmask packs all of the bits together into a single variable of type T. This means that operations on bitmasks are extremely fast, because all of the bits can be processed at once.
The downside of course is that the number of bits that can be stored is limited to 8 * sizeof(T), where T must be a native unsigned integer type (such as unsigned char, unsigned int, or unsigned long long).
For another extremely fast bitmask class that can store twice as many bits, see NBitmask2. For a bitmask class that can store arbitrarily many bits, see NBitmask.

inline 
Creates a new bitmask with all bits set to false
.

inline 
Creates a new bitmask with all bits set to false
.
The integer argument is merely for compatibility with the NBitmask constructor, and will be ignored.

inline 
Creates a clone of the given bitmask.
cloneMe  the bitmask to clone. 

inline 
Determines whether at most one bit is set to true
in this bitmask.
If this bitmask is entirely false
or if only one bit is set to true
, then this routine will return true
. Otherwise this routine will return false
.
true
if and only if at most one bit is set to true
.

inline 
Returns the number of bits currently set to true
in this bitmask.
true
bits.

inline 
Determines whether this bitmask contains the intersection of the two given bitmasks.
For this routine to return true
, every bit that is set in both x and y must be set in this bitmask also.
x  the first bitmask used to form the intersection. 
y  the first bitmask used to form the intersection. 
true
if and only if this bitmask entirely contains the intersection of x and y.

inline 
Returns the index of the first true
bit in this bitmask, or 1 if there are no true
bits.
true
bit.

inline 
Negates every bit in this bitmask.
All true
bits will be set to false
and vice versa.
Unlike the more generic NBitmask, this optimised bitmask class does not store a length. This means that all 8 * sizeof(T) possible bits will be negated.

inline 
Returns the value of the given bit of this bitmask.
index  indicates which bit to query; this must be between 0 and (8 * sizeof(T)  1) inclusive. 

inline 
Determines whether this bitmask is entirely contained within the union of the two given bitmasks.
For this routine to return true
, every bit that is set in this bitmask must also be set in either x or y.
x  the first bitmask used to form the union. 
y  the first bitmask used to form the union. 
true
if and only if this bitmask is entirely contained within the union of x and y.

inline 
Returns the index of the last true
bit in this bitmask, or 1 if there are no true
bits.
true
bit.

inline 
Determines whether this bitmask appears strictly before the given bitmask when bitmasks are sorted in lexicographical order.
Here the bit at index 0 is least significant, and the bit at index length1 is most significant.
other  the bitmask to compare against this. 
true
if and only if this is lexicographically strictly smaller than the given bitmask.

inline 
Sets this to the intersection of this and the given bitmask.
Every bit that is unset in other will be unset in this bitmask.
other  the bitmask to intersect with this. 

inline 
Sets this to the set difference of this and the given bitmask.
Every bit that is set in other will be cleared in this bitmask.
other  the bitmask to XOR with this. 

inline 
Determines whether this bitmask is entirely contained within the given bitmask.
For this routine to return true
, every bit that is set in this bitmask must also be set in the given bitmask.
other  the bitmask to compare against this. 
true
if and only if this bitmask is entirely contained within the given bitmask.

inline 
Sets this bitmask to a copy of the given bitmask.
other  the bitmask to clone. 

inline 
Determines whether this and the given bitmask are identical.
other  the bitmask to compare against this. 
true
if and only if this and the given bitmask are identical.

inline 
Sets this to the exclusive disjunction (XOR) of this and the given bitmask.
Every bit that is set in other will be flipped in this bitmask.
other  the bitmask to XOR with this. 

inline 
Sets this to the union of this and the given bitmask.
Every bit that is set in other will be set in this bitmask.
other  the bitmask to union with this. 

inline 
Sets all bits of this bitmask to false
.

inline 
Sets all bits of this bitmask to false
.
The integer argument is merely for compatibility with NBitmask::reset(size_t), and will be ignored.

inline 
Sets the given bit of this bitmask to the given value.
index  indicates which bit to set; this must be between 0 and (8 * sizeof(T)  1) inclusive. 
value  the value that will be assigned to the (index)th bit. 

inline 
Sets all bits in the given sorted list to the given value.
This is a convenience routine for setting many bits at once. The indices of the bits to set should be sorted and stored in some container, such as a std::set or a Cstyle array. This routine takes iterators over this container, and sets the bits at the corresponding indices to the given value.
For example, the following code would set bits 3, 5 and 6 to true:
Likewise, the following code would set bits 1, 4 and 7 to false:
All other bits of this bitmask are unaffected by this routine.
indexBegin  the beginning of the iterator range containing the sorted indices of the bits to set. 
indexEnd  the end of the iterator range containing the sorted indices of the bits to set. 
value  the value that will be assigned to each of the corresponding bits. 

inline 
Leaves the first numBits bits of this bitmask intact, but sets all subsequent bits to false
.
In other words, this routine "truncates" this bitmask to the given number of bits.
This routine does not change the length of this bitmask (as passed to the contructor or to reset()).
numBits  the number of bits that will not be cleared. 