Previous fileTop of DocumentContentsIndex pageNext file
Apache C++ Standard Library User's Guide

8.4 The bitset Abstraction

A bitset is really a cross between a set and a vector. Like the vector specialization vector<bool>, a bitset represents a sequence of binary (0/1 bit) values. However, set operations can be performed on bitsets using the logical bit-wise operators. The class bitset does not provide any iterators for accessing elements.

8.4.1 Include Files

The bitset header file must appear in all programs that use the bitset datatype:

8.4.2 Declaration and Initialization of bitset

A bitset is a template class abstraction. However, the template argument is not a type, but an integer value. The value represents the number of bits the set contains.

An alternative technique permits the size of the set to be specified as an argument to the constructor. The actual size will be the smaller of the value used as the template argument and the constructor argument. This technique is useful when a program contains two or more bit vectors of differing sizes. Consistently using the larger size for the template argument means that only one set of methods for the class is generated. The actual size, however, is determined by the constructor.

A third form of constructor takes as argument a string of 0 and 1 characters. A bitset is created that has holds as many elements as there are characters in the string, and is initialized with the values from the string.

8.4.3 Accessing and Testing Elements

An individual bit in the bitset can be accessed using the subscript operation. Whether the bit is one or not can be determined using the member function test(). Whether any bit in the bitset is on is tested using the member function any(), which yields a boolean value. The inverse of any() is returned by the member function none():

The function set() can be used to set a specific bit. The function bset_one.set(I) is equivalent to bset_one[I] = true. Invoking the function without any arguments sets all bit positions to true. The function reset() is similar, and sets the indicated position to false, or all positions to false if invoked with no argument. The function flip() flips either the indicated position, or all positions if no argument is provided. The function flip() is also provided as a member function for the individual bit references.

The member function size() returns the number of bits in the bitset, while the member function count() yields the number of bits that are set.

8.4.4 set Operations

The set operations on bitsets are implemented using the bit-wise operators, analogous to the way the same operators act on integer arguments.

The negation operator operator~() applied to a bitset returns a new bitset containing the inverse of the elements in the argument set.

The intersection of two bitsets is formed using the and operator operator&(). The assignment form of the operator can also be used. In the assignment form, the target becomes the disjunction of the two sets:

The union of two sets is formed in a similar manner using the or operator, operator|(). The exclusive-or is formed using the bit-wise exclusive or operator, operator^().

The left and right shift operators, operator<<() and operator>>(), can be used to shift a bitset left or right as they are used on integer arguments. If a bit is shifted left by an integer value n, then the new bit position I is the value of the former I-n. Zeros are shifted into the new positions.

8.4.5 Conversions

The member function to_ulong() converts a bitset into an unsigned long. A std::out_of_range exception is thrown if this function is called on a bitset containing more elements than can fit into an unsigned long.

The member function to_string() converts a bitset into an object of type string. The string has as one character for each bit in the bitset. Each zero bit corresponds to the character 0, while each one bit is represented by the character 1.

Previous fileTop of DocumentContentsIndex pageNext file