23 General utilities library [utilities]

23.9 Bitsets [bitset]

23.9.2 Class template bitset [template.bitset]

23.9.2.2 bitset members [bitset.members]

bitset<N>& operator&=(const bitset<N>& rhs) noexcept;
1
#
Effects: Clears each bit in *this for which the corresponding bit in rhs is clear, and leaves all other bits unchanged.
2
#
Returns: *this.
bitset<N>& operator|=(const bitset<N>& rhs) noexcept;
3
#
Effects: Sets each bit in *this for which the corresponding bit in rhs is set, and leaves all other bits unchanged.
4
#
Returns: *this.
bitset<N>& operator^=(const bitset<N>& rhs) noexcept;
5
#
Effects: Toggles each bit in *this for which the corresponding bit in rhs is set, and leaves all other bits unchanged.
6
#
Returns: *this.
bitset<N>& operator<<=(size_t pos) noexcept;
7
#
Effects: Replaces each bit at position I in *this with a value determined as follows:
  • (7.1)
    If I < pos, the new value is zero;
  • (7.2)
    If I >= pos, the new value is the previous value of the bit at position I - pos.
8
#
Returns: *this.
bitset<N>& operator>>=(size_t pos) noexcept;
9
#
Effects: Replaces each bit at position I in *this with a value determined as follows:
  • (9.1)
    If pos >= N - I, the new value is zero;
  • (9.2)
    If pos < N - I, the new value is the previous value of the bit at position I + pos.
10
#
Returns: *this.
bitset<N>& set() noexcept;
11
#
Effects: Sets all bits in *this.
12
#
Returns: *this.
bitset<N>& set(size_t pos, bool val = true);
13
#
Throws: out_­of_­range if pos does not correspond to a valid bit position.
14
#
Effects: Stores a new value in the bit at position pos in *this.
If val is nonzero, the stored value is one, otherwise it is zero.
15
#
Returns: *this.
bitset<N>& reset() noexcept;
16
#
Effects: Resets all bits in *this.
17
#
Returns: *this.
bitset<N>& reset(size_t pos);
18
#
Throws: out_­of_­range if pos does not correspond to a valid bit position.
19
#
Effects: Resets the bit at position pos in *this.
20
#
Returns: *this.
bitset<N> operator~() const noexcept;
21
#
Effects: Constructs an object x of class bitset<N> and initializes it with *this.
22
#
Returns: x.flip().
bitset<N>& flip() noexcept;
23
#
Effects: Toggles all bits in *this.
24
#
Returns: *this.
bitset<N>& flip(size_t pos);
25
#
Throws: out_­of_­range if pos does not correspond to a valid bit position.
26
#
Effects: Toggles the bit at position pos in *this.
27
#
Returns: *this.
unsigned long to_ulong() const;
28
#
Throws: overflow_­error if the integral value x corresponding to the bits in *this cannot be represented as type unsigned long.
29
#
Returns: x.
unsigned long long to_ullong() const;
30
#
Throws: overflow_­error if the integral value x corresponding to the bits in *this cannot be represented as type unsigned long long.
31
#
Returns: x.
template <class charT = char, class traits = char_traits<charT>, class Allocator = allocator<charT>> basic_string<charT, traits, Allocator> to_string(charT zero = charT('0'), charT one = charT('1')) const;
32
#
Effects: Constructs a string object of the appropriate type and initializes it to a string of length N characters.
Each character is determined by the value of its corresponding bit position in *this.
Character position N - 1 corresponds to bit position zero.
Subsequent decreasing character positions correspond to increasing bit positions.
Bit value zero becomes the character zero, bit value one becomes the character one.
33
#
Returns: The created object.
size_t count() const noexcept;
34
#
Returns: A count of the number of bits set in *this.
constexpr size_t size() const noexcept;
35
#
Returns: N.
bool operator==(const bitset<N>& rhs) const noexcept;
36
#
Returns: true if the value of each bit in *this equals the value of the corresponding bit in rhs.
bool operator!=(const bitset<N>& rhs) const noexcept;
37
#
Returns: true if !(*this == rhs).
bool test(size_t pos) const;
38
#
Throws: out_­of_­range if pos does not correspond to a valid bit position.
39
#
Returns: true if the bit at position pos in *this has the value one.
bool all() const noexcept;
40
#
Returns: count() == size().
bool any() const noexcept;
41
#
Returns: count() != 0.
bool none() const noexcept;
42
#
Returns: count() == 0.
bitset<N> operator<<(size_t pos) const noexcept;
43
#
Returns: bitset<N>(*this) <<= pos.
bitset<N> operator>>(size_t pos) const noexcept;
44
#
Returns: bitset<N>(*this) >>= pos.
constexpr bool operator[](size_t pos) const;
45
#
Requires: pos shall be valid.
46
#
Returns: true if the bit at position pos in *this has the value one, otherwise false.
47
#
Throws: Nothing.
bitset<N>::reference operator[](size_t pos);
48
#
Requires: pos shall be valid.
49
#
Returns: An object of type bitset<N>​::​reference such that (*this)[pos] == this->test(pos), and such that (*this)[pos] = val is equivalent to this->set(pos, val).
50
#
Throws: Nothing.
51
#
Remarks: For the purpose of determining the presence of a data race ([intro.multithread]), any access or update through the resulting reference potentially accesses or modifies, respectively, the entire underlying bitset.