_GLIBCXX_STD::bitset< _Nb > Class Template Reference

The bitset class represents a fixed-size sequence of bits. More...

Inheritance diagram for _GLIBCXX_STD::bitset< _Nb >:


Public Member Functions
	bitset ()
	All bits set to zero.
	bitset (unsigned long __val)
	Initial bits bitwise-copied from a single word (others set to zero).
template<class _CharT, class _Traits, class _Alloc>	bitset (const basic_string< _CharT, _Traits, _Alloc > &__s, size_t __position=0)
	Use a subset of a string.
template<class _CharT, class _Traits, class _Alloc>	bitset (const basic_string< _CharT, _Traits, _Alloc > &__s, size_t __position, size_t __n)
	Use a subset of a string.
bitset< _Nb > &	set ()
	Sets every bit to true.
bitset< _Nb > &	set (size_t __position, bool __val=true)
	Sets a given bit to a particular value.
bitset< _Nb > &	reset ()
	Sets every bit to false.
bitset< _Nb > &	reset (size_t __position)
	Sets a given bit to false.
bitset< _Nb > &	flip ()
	Toggles every bit to its opposite value.
bitset< _Nb > &	flip (size_t __position)
	Toggles a given bit to its opposite value.
bitset< _Nb >	operator~ () const
	See the no-argument flip().
unsigned long	to_ulong () const
	Retuns a numerical interpretation of the bitset.
template<class _CharT, class _Traits, class _Alloc> basic_string< _CharT, _Traits, _Alloc >	to_string () const
	Retuns a character interpretation of the bitset.
template<class _CharT, class _Traits, class _Alloc> void	_M_copy_from_string (const basic_string< _CharT, _Traits, _Alloc > &__s, size_t, size_t)
template<class _CharT, class _Traits, class _Alloc> void	_M_copy_to_string (basic_string< _CharT, _Traits, _Alloc > &) const
size_t	count () const
	Returns the number of bits which are set.
size_t	size () const
	Returns the total number of bits.
bool	test (size_t __position) const
	Tests the value of a bit.
bool	any () const
	Tests whether any of the bits are on.
bool	none () const
	Tests whether any of the bits are on.
size_t	_Find_first () const
	Finds the index of the first "on" bit.
size_t	_Find_next (size_t __prev) const
	Finds the index of the next "on" bit after prev.

bitset< _Nb > &	operator &= (const bitset< _Nb > &__rhs)
	Operations on bitsets.
bitset< _Nb > &	operator\|= (const bitset< _Nb > &__rhs)
bitset< _Nb > &	operator^= (const bitset< _Nb > &__rhs)

bitset< _Nb > &	operator<<= (size_t __position)
	Operations on bitsets.
bitset< _Nb > &	operator>>= (size_t __position)

bitset< _Nb > &	_Unchecked_set (size_t __pos)
bitset< _Nb > &	_Unchecked_set (size_t __pos, int __val)
bitset< _Nb > &	_Unchecked_reset (size_t __pos)
bitset< _Nb > &	_Unchecked_flip (size_t __pos)
bool	_Unchecked_test (size_t __pos) const

reference	operator[] (size_t __position)
	Array-indexing support.
bool	operator[] (size_t __position) const

bool	operator== (const bitset< _Nb > &__rhs) const
	These comparisons for equality/inequality are, well, bitwise.
bool	operator!= (const bitset< _Nb > &__rhs) const

bitset< _Nb >	operator<< (size_t __position) const
	Self-explanatory.
bitset< _Nb >	operator>> (size_t __position) const
Private Types
typedef _Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)	_Base )
typedef unsigned long	_WordT
Private Member Functions
void	_M_do_sanitize ()
Friends
class	reference

Detailed Description

template<size_t _Nb>
class _GLIBCXX_STD::bitset< _Nb >

The bitset class represents a fixed-size sequence of bits.

(Note that bitset does not meet the formal requirements of a container. Mainly, it lacks iterators.)

The template argument, Nb, may be any non-negative number, specifying the number of bits (e.g., "0", "12", "1024*1024").

In the general unoptimized case, storage is allocated in word-sized blocks. Let B be the number of bits in a word, then (Nb+(B-1))/B words will be used for storage. B - Nb%B bits are unused. (They are the high-order bits in the highest word.) It is a class invariant that those unused bits are always zero.

If you think of bitset as "a simple array of bits," be aware that your mental picture is reversed: a bitset behaves the same way as bits in integers do, with the bit at index 0 in the "least significant / right-hand" position, and the bit at index Nb-1 in the "most significant / left-hand" position. Thus, unlike other containers, a bitset's index "counts from right to left," to put it very loosely.

This behavior is preserved when translating to and from strings. For example, the first line of the following program probably prints "b('a') is 0001100001" on a modern ASCII system.

     #include <bitset>
     #include <iostream>
     #include <sstream>

     using namespace std;

     int main()
     {
         long         a = 'a';
         bitset<10>   b(a);

         cout << "b('a') is " << b << endl;

         ostringstream s;
         s << b;
         string  str = s.str();
         cout << "index 3 in the string is " << str[3] << " but\n"
              << "index 3 in the bitset is " << b[3] << endl;
     }

Also see http://gcc.gnu.org/onlinedocs/libstdc++/ext/sgiexts.html#ch23 for a description of extensions.

Definition at line 603 of file bitset.

Member Typedef Documentation

template<size_t _Nb>

typedef _Base_bitset<_GLIBCXX_BITSET_WORDS(_Nb) _GLIBCXX_STD::bitset< _Nb >::_Base) [private]

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 606 of file bitset.

template<size_t _Nb>

typedef unsigned long _GLIBCXX_STD::bitset< _Nb >::_WordT [private]

Reimplemented from _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>.
Definition at line 607 of file bitset.

Constructor & Destructor Documentation

template<size_t _Nb>

_GLIBCXX_STD::bitset< _Nb >::bitset ( ) [inline]

All bits set to zero.

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 691 of file bitset.

template<size_t _Nb>

_GLIBCXX_STD::bitset< _Nb >::bitset ( unsigned long __val ) [inline]

Initial bits bitwise-copied from a single word (others set to zero).

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 694 of file bitset.
References _GLIBCXX_STD::bitset< _Nb >::_M_do_sanitize().

template<size_t _Nb>

template<class _CharT, class _Traits, class _Alloc>

_GLIBCXX_STD::bitset< _Nb >::bitset ( const basic_string< _CharT, _Traits, _Alloc > & __s,

size_t __position = 0

) [inline, explicit]

Use a subset of a string.

Parameters:

s A string of '0' and '1' characters.

position Index of the first character in s to use; defaults to zero.

Exceptions:

std::out_of_range If pos is bigger the size of s.

std::invalid_argument If a character appears in the string which is neither '0' nor '1'.

Definition at line 707 of file bitset.
References __N, and _GLIBCXX_STD::bitset< _Nb >::_M_copy_from_string().

template<size_t _Nb>

template<class _CharT, class _Traits, class _Alloc>

_GLIBCXX_STD::bitset< _Nb >::bitset ( const basic_string< _CharT, _Traits, _Alloc > & __s,

size_t __position,

size_t __n

) [inline]

Use a subset of a string.

Parameters:

s A string of '0' and '1' characters.

position Index of the first character in s to use.

n The number of characters to copy.

Exceptions:

std::out_of_range If pos is bigger the size of s.

std::invalid_argument If a character appears in the string which is neither '0' nor '1'.

Definition at line 727 of file bitset.
References __N, and _GLIBCXX_STD::bitset< _Nb >::_M_copy_from_string().

Member Function Documentation

template<size_t _Nb>

template<class _CharT, class _Traits, class _Alloc>

void _GLIBCXX_STD::bitset< _Nb >::_M_copy_from_string ( const basic_string< _CharT, _Traits, _Alloc > & __s,

size_t ,

size_t

)

Definition at line 1074 of file bitset.
References __N, std::min(), _GLIBCXX_STD::bitset< _Nb >::reset(), and _GLIBCXX_STD::bitset< _Nb >::set().
Referenced by _GLIBCXX_STD::bitset< _Nb >::bitset(), and _GLIBCXX_STD::operator>>().

template<size_t _Nb>

template<class _CharT, class _Traits, class _Alloc>

void _GLIBCXX_STD::bitset< _Nb >::_M_copy_to_string ( basic_string< _CharT, _Traits, _Alloc > & ) const

Definition at line 1097 of file bitset.
References _GLIBCXX_STD::bitset< _Nb >::_Unchecked_test().
Referenced by _GLIBCXX_STD::bitset< _Nb >::to_string().

template<size_t _Nb>

void _GLIBCXX_STD::bitset< _Nb >::_M_do_sanitize ( ) [inline, private]

Definition at line 610 of file bitset.
Referenced by _GLIBCXX_STD::bitset< _Nb >::bitset(), _GLIBCXX_STD::bitset< _Nb >::flip(), _GLIBCXX_STD::bitset< _Nb >::operator<<=(), _GLIBCXX_STD::bitset< _Nb >::operator>>=(), and _GLIBCXX_STD::bitset< _Nb >::set().

template<size_t _Nb>

bool _GLIBCXX_STD::bitset< _Nb >::any ( ) const [inline]

Tests whether any of the bits are on.

Returns:
True if at least one bit is set.

Definition at line 1028 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_is_any().

template<size_t _Nb>

size_t _GLIBCXX_STD::bitset< _Nb >::count ( ) const [inline]

Returns the number of bits which are set.

Definition at line 992 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_do_count().

template<size_t _Nb>

bitset<_Nb>& _GLIBCXX_STD::bitset< _Nb >::flip ( size_t __position ) [inline]

Toggles a given bit to its opposite value.

Parameters:

position The index of the bit.

Exceptions:

std::out_of_range If pos is bigger the size of the set.

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 913 of file bitset.
References __N, and _GLIBCXX_STD::bitset< _Nb >::_Unchecked_flip().

template<size_t _Nb>

bitset<_Nb>& _GLIBCXX_STD::bitset< _Nb >::flip ( ) [inline]

Toggles every bit to its opposite value.

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 900 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_do_flip(), and _GLIBCXX_STD::bitset< _Nb >::_M_do_sanitize().

template<size_t _Nb>

bool _GLIBCXX_STD::bitset< _Nb >::none ( ) const [inline]

Tests whether any of the bits are on.

Returns:
True if none of the bits are set.

Definition at line 1035 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_is_any().

template<size_t _Nb>

bitset<_Nb>& _GLIBCXX_STD::bitset< _Nb >::operator &= ( const bitset< _Nb > & __rhs ) [inline]

Operations on bitsets.

Parameters:

rhs A same-sized bitset.

These should be self-explanatory.
Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 745 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_do_and().

template<size_t _Nb>

bool _GLIBCXX_STD::bitset< _Nb >::operator!= ( const bitset< _Nb > & __rhs ) const [inline]

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 1005 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_is_equal().

template<size_t _Nb>

bitset<_Nb> _GLIBCXX_STD::bitset< _Nb >::operator<< ( size_t __position ) const [inline]

Self-explanatory.

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 1040 of file bitset.

template<size_t _Nb>

bitset<_Nb>& _GLIBCXX_STD::bitset< _Nb >::operator<<= ( size_t __position ) [inline]

Operations on bitsets.

Parameters:

position The number of places to shift.

These should be self-explanatory.
Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 774 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_do_left_shift(), _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_do_reset(), and _GLIBCXX_STD::bitset< _Nb >::_M_do_sanitize().

template<size_t _Nb>

bool _GLIBCXX_STD::bitset< _Nb >::operator== ( const bitset< _Nb > & __rhs ) const [inline]

These comparisons for equality/inequality are, well, bitwise.

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 1001 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_is_equal().

template<size_t _Nb>

bitset<_Nb> _GLIBCXX_STD::bitset< _Nb >::operator>> ( size_t __position ) const [inline]

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 1044 of file bitset.

template<size_t _Nb>

bitset<_Nb>& _GLIBCXX_STD::bitset< _Nb >::operator>>= ( size_t __position ) [inline]

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 787 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_do_reset(), _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_do_right_shift(), and _GLIBCXX_STD::bitset< _Nb >::_M_do_sanitize().

template<size_t _Nb>

bool _GLIBCXX_STD::bitset< _Nb >::operator[] ( size_t __position ) const [inline]

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 945 of file bitset.
References _GLIBCXX_STD::bitset< _Nb >::_Unchecked_test().

template<size_t _Nb>

reference _GLIBCXX_STD::bitset< _Nb >::operator[] ( size_t __position ) [inline]

Array-indexing support.

Parameters:

position Index into the bitset.

Returns:
A bool for a 'const bitset'. For non-const bitsets, an instance of the reference proxy class.

Note:
These operators do no range checking and throw no exceptions, as required by DR 11 to the standard.

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 942 of file bitset.
References _GLIBCXX_STD::bitset< _Nb >::reference.

template<size_t _Nb>

bitset<_Nb>& _GLIBCXX_STD::bitset< _Nb >::operator^= ( const bitset< _Nb > & __rhs ) [inline]

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 759 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_do_xor().

template<size_t _Nb>

bitset<_Nb>& _GLIBCXX_STD::bitset< _Nb >::operator|= ( const bitset< _Nb > & __rhs ) [inline]

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 752 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_do_or().

template<size_t _Nb>

bitset<_Nb> _GLIBCXX_STD::bitset< _Nb >::operator~ ( ) const [inline]

See the no-argument flip().

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 922 of file bitset.

template<size_t _Nb>

bitset<_Nb>& _GLIBCXX_STD::bitset< _Nb >::reset ( size_t __position ) [inline]

Sets a given bit to false.

Parameters:

position The index of the bit.

Exceptions:

std::out_of_range If pos is bigger the size of the set.

Same as writing set(pos,false).
Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 889 of file bitset.
References __N, and _GLIBCXX_STD::bitset< _Nb >::_Unchecked_reset().

template<size_t _Nb>

bitset<_Nb>& _GLIBCXX_STD::bitset< _Nb >::reset ( ) [inline]

Sets every bit to false.

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 875 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_do_reset().
Referenced by _GLIBCXX_STD::bitset< _Nb >::_M_copy_from_string().

template<size_t _Nb>

bitset<_Nb>& _GLIBCXX_STD::bitset< _Nb >::set ( size_t __position,

bool __val = true

) [inline]

Sets a given bit to a particular value.

Parameters:

position The index of the bit.

val Either true or false, defaults to true.

Exceptions:

std::out_of_range If pos is bigger the size of the set.

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 864 of file bitset.
References __N, and _GLIBCXX_STD::bitset< _Nb >::_Unchecked_set().

template<size_t _Nb>

bitset<_Nb>& _GLIBCXX_STD::bitset< _Nb >::set ( ) [inline]

Sets every bit to true.

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 850 of file bitset.
References _GLIBCXX_STD::bitset< _Nb >::_M_do_sanitize(), and _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_do_set().
Referenced by _GLIBCXX_STD::bitset< _Nb >::_M_copy_from_string().

template<size_t _Nb>

size_t _GLIBCXX_STD::bitset< _Nb >::size ( ) const [inline]

Returns the total number of bits.

Definition at line 996 of file bitset.

template<size_t _Nb>

bool _GLIBCXX_STD::bitset< _Nb >::test ( size_t __position ) const [inline]

Tests the value of a bit.

Parameters:

position The index of a bit.

Returns:
The value at pos.

Exceptions:

std::out_of_range If pos is bigger the size of the set.

Definition at line 1016 of file bitset.
References __N, and _GLIBCXX_STD::bitset< _Nb >::_Unchecked_test().

template<size_t _Nb>

template<class _CharT, class _Traits, class _Alloc>

basic_string<_CharT, _Traits, _Alloc> _GLIBCXX_STD::bitset< _Nb >::to_string ( ) const [inline]

Retuns a character interpretation of the bitset.

Returns:
The string equivalent of the bits.
Note the ordering of the bits: decreasing character positions correspond to increasing bit positions (see the main class notes for an example).
Also note that you must specify the string's template parameters explicitly. Given a bitset bs and a string :
s = bs.to_string<char,char_traits<char>,allocator<char> >();

Reimplemented in __gnu_debug_def::bitset< _Nb >.
Definition at line 973 of file bitset.
References _GLIBCXX_STD::bitset< _Nb >::_M_copy_to_string().

template<size_t _Nb>

unsigned long _GLIBCXX_STD::bitset< _Nb >::to_ulong ( ) const [inline]

Retuns a numerical interpretation of the bitset.

Returns:
The integral equivalent of the bits.

Exceptions:

std::overflow_error If there are too many bits to be represented in an unsigned long.

Definition at line 955 of file bitset.
References _GLIBCXX_STD::_Base_bitset< _GLIBCXX_BITSET_WORDS(_Nb)>::_M_do_to_ulong().

Friends And Related Function Documentation

template<size_t _Nb>

friend class reference [friend]

Definition at line 687 of file bitset.
Referenced by __gnu_debug_def::bitset< _Nb >::operator[](), and _GLIBCXX_STD::bitset< _Nb >::operator[]().

The documentation for this class was generated from the following file:

bitset

Generated on Tue Jan 30 17:32:09 2007 for GNU C++ STL by

1.3.6

_GLIBCXX_STD::bitset< _Nb > Class Template Reference

Public Member Functions

Private Types

Private Member Functions