RWTBitVec<Size>

Module:  Essential Tools Module   Group:  Traditional Collection Classes

Does not inherit

• Local Index
• Synopsis
• Description
• Persistence
• Example
• Public Constructors
• Assignment Operators
• Bitwise Operators
• Logical Operators
• Public Member Functions

Members

clearBit() data() firstFalse() firstTrue() operator!=()

operator&() operator&=() operator()() operator=() operator==()

operator[]() operator^() operator^=() operator|() operator|=()

RWTBitVec<Size>() setBit() testBit()

#include <rw/tbitvec.h>
RWTBitVec<22>   // A 22 bit long vector

RWTBitVec<Size> is a parameterized bit vector of fixed length size. Unlike class RWBitVec, its length cannot be changed at run time. The advantage of RWTBitVec is its smaller size, and one less level of indirection, resulting in a slight speed advantage.

Bits are numbered from 0 through size-1, inclusive.

The copy constructor and assignment operator use copy semantics.

None

In this example, two 8-bit vectors are exercised:

#include <rw/tbitvec.h>
#include <iostream>

const size_t VECSIZE = 8;

int main ()
{ 
    RWTBitVec<VECSIZE> a, b; // Allocate two vectors.

    a(2) = true; // Set bit 2 (the third bit) of a on.
    b(3) = true; // Set bit 3 (the fourth bit) of b on.

    RWTBitVec<VECSIZE> c = a ^ b; // Set c to the XOR of a and b.

    std::cout << "V1" << "\t" 
              << "V2" << "\t" 
              << "V1 XOR V2"
              << std::endl;

    for(size_t i = 0; i < VECSIZE; i++) {
        std::cout << a[i] << "\t" 
                  << b[i] << "\t" 
                  << c[i] << "\n";
    }
    return 0;
}

Program output:

V1  V2  V1 XOR V2
0  0  0
0  0  0
1  0  1
0  1  1
0  0  0
0  0  0
0  0  0
0  0  0

RWTBitVec<Size>();

Constructs an instance with all bits set to false.

RWTBitVec<Size>(bool val);

Constructs an instance with all bits set to val.

RWTBitVec<Size>&
operator=(const RWTBitVec<Size>& v);

Sets self to a copy of v.

RWTBitVec&
operator=(bool val);

Sets all bits in self to the value val.

RWTBitVec&
operator&=(const RWTBitVec& v);
RWTBitVec&
operator^=(const RWTBitVec& v);
RWTBitVec&
operator|=(const RWTBitVec& v);

Logical assignments. Sets each bit of self to the logical AND, XOR, or OR, respectively, of self and the corresponding bit in v.

RWBitRef
operator[](size_t i);

Returns a reference to the ith bit of self. This reference can be used as an lvalue. The index i must be between 0 and size-1, inclusive. Bounds checking will occur.

RWBitRef
operator()(size_t i);

Returns a reference to the i^th bit of self. This reference can be used as an lvalue. The index i must be between 0 and size-1, inclusive. No bounds checking is done.

RWTBitVec<N> operator&(const RWTBitVec<N>& v2) const;
RWTBitVec<N> operator^(const RWTBitVec<N>& v2) const;
RWTBitVec<N> operator|(const RWTBitVec<N>& v2) const;

Return the logical AND, XOR, and OR, respectively, of self and v2.

bool
operator==(bool b) const;

Returns true if every bit of self is set to the value b. Otherwise, returns false.

bool
operator!=(bool b) const;

Returns true if any bit of self is not set to the value b. Otherwise, returns false.

bool
operator==(const RWTBitVec& v) const;

Returns true if each bit of self is set to the same value as the corresponding bit in v. Otherwise, returns false.

bool
operator!=(const RWTBitVec& v) const;

Returns true if any bit of self is not set to the same value as the corresponding bit in v. Otherwise, returns false.

void
clearBit(size_t i);

Clears (i.e., sets to false) the bit with index i. The index i must be between 0 and size-1. No bounds checking is performed. The following two lines are equivalent, although clearBit(size_t) is slightly smaller and faster than using operator()(size_t):

a(i) = false;
a.clearBit(i);

const RWByte*
data() const;

Returns a const pointer to the raw data of self. Should be used with care.

size_t
firstFalse() const;

Returns the index of the first OFF (False) bit in self. Returns RW_NPOS if there is no OFF bit.

size_t
firstTrue() const;

Returns the index of the first ON (True) bit in self. Returns RW_NPOS if there is no ON bit.

void
setBit(size_t i);

Sets (i.e., sets to true) the bit with index i. The index i must be between 0 and size-1. No bounds checking is performed. The following two lines are equivalent, although setBit(size_t) is slightly smaller and faster than using operator()(size_t).

a(i) = true;
a.setBit(i);

bool
testBit(size_t i) const;

Tests the bit with index i. The index i must be between 0 and size-1. No bounds checking is performed. The following are equivalent, although testBit(size_t) is slightly smaller and faster than using operator()(size_t):

if( a(i) ) doSomething();
if( a.testBit(i) ) doSomething();

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.