C++

Reference

<bitset>

bitset

function
<bitset>

std::bitset operators

member functions
bitset& operator&= (const bitset& rhs);bitset& operator|= (const bitset& rhs);bitset& operator^= (const bitset& rhs);bitset& operator<<= (size_t pos);bitset& operator>>= (size_t pos);bitset operator~() const;bitset operator<<(size_t pos) const;bitset operator>>(size_t pos) const;bool operator== (const bitset& rhs) const;bool operator!= (const bitset& rhs) const;
non-member functions
template<size_t N>  bitset<N> operator& (const bitset<N>& lhs, const bitset<N>& rhs);template<size_t N>  bitset<N> operator| (const bitset<N>& lhs, const bitset<N>& rhs);template<size_t N>  bitset<N> operator^ (const bitset<N>& lhs, const bitset<N>& rhs);
iostream inserters/extractors
template<class charT, class traits, size_t N>  basic_istream<charT, traits>&    operator>> (basic_istream<charT,traits>& is, bitset<N>& rhs);template<class charT, class traits, size_t N>  basic_ostream<charT, traits>&    operator<< (basic_ostream<charT,traits>& os, const bitset<N>& rhs);
member functions
bitset& operator&= (const bitset& rhs) noexcept;bitset& operator|= (const bitset& rhs) noexcept;bitset& operator^= (const bitset& rhs) noexcept;bitset& operator<<= (size_t pos) noexcept;bitset& operator>>= (size_t pos) noexcept;bitset operator~() const noexcept;bitset operator<<(size_t pos) const noexcept;bitset operator>>(size_t pos) const noexcept;bool operator== (const bitset& rhs) const noexcept;bool operator!= (const bitset& rhs) const noexcept;
non-member functions
template<size_t N>  bitset<N> operator& (const bitset<N>& lhs, const bitset<N>& rhs) noexcept;template<size_t N>  bitset<N> operator| (const bitset<N>& lhs, const bitset<N>& rhs) noexcept;template<size_t N>  bitset<N> operator^ (const bitset<N>& lhs, const bitset<N>& rhs) noexcept;
iostream inserters/extractors
template<class charT, class traits, size_t N>  basic_istream<charT, traits>&    operator>> (basic_istream<charT,traits>& is, bitset<N>& rhs);template<class charT, class traits, size_t N>  basic_ostream<charT, traits>&    operator<< (basic_ostream<charT,traits>& os, const bitset<N>& rhs);
Bitset operators
Performs the proper bitwise operation using the contents of the bitset.

Parameters

lhs
Left-hand side bitset object (for non-member functions).
rhs
Right-hand side bitset object.
Both the left-hand side and right-hand side bitset objects must have the same amount of bits (i.e., have the same class template parameter, N).
pos
Number of bit locations to be shifted.
is,os
basic_istream or basic_ostream object from which a bitset object is respectively extracted or inserted. The format in which bitsets are inserted/extracted is a sequence of (suitably widened) '0' and '1' characters.

Return value

If a reference: the left-hand side object (*this, is or os).
Otherwise: the result of the operation (either a bitset object, or true or false for the relational operators).

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
// bitset operators
#include <iostream>       // std::cout
#include <string>         // std::string
#include <bitset>         // std::bitset

int main ()
{
  std::bitset<4> foo (std::string("1001"));
  std::bitset<4> bar (std::string("0011"));

  std::cout << (foo^=bar) << '\n';       // 1010 (XOR,assign)
  std::cout << (foo&=bar) << '\n';       // 0010 (AND,assign)
  std::cout << (foo|=bar) << '\n';       // 0011 (OR,assign)

  std::cout << (foo<<=2) << '\n';        // 1100 (SHL,assign)
  std::cout << (foo>>=1) << '\n';        // 0110 (SHR,assign)

  std::cout << (~bar) << '\n';           // 1100 (NOT)
  std::cout << (bar<<1) << '\n';         // 0110 (SHL)
  std::cout << (bar>>1) << '\n';         // 0001 (SHR)

  std::cout << (foo==bar) << '\n';       // false (0110==0011)
  std::cout << (foo!=bar) << '\n';       // true  (0110!=0011)

  std::cout << (foo&bar) << '\n';        // 0010
  std::cout << (foo|bar) << '\n';        // 0111
  std::cout << (foo^bar) << '\n';        // 0101

  return 0;
}

Output:

1010
0010
0011
1100
0110
1100
0110
0001
0
1
0010
0111
0101


Data races

All bit position in the bitset objects involved in the operation are accessed, and -if in a compound assignment- also modified.

Exception safety

The stream inserter/extractors leave all objects in a valid state in case of exception (basic guarantee).
The other operations never throw exceptions (no-throw guarantee).

See also

bitset::operator[]
Access bit (public member function)
bitset::set
Set bits (public member function)
bitset::reset
Reset bits (public member function)
bitset::flip
Flip bits (public member function)