Standard library header <bitset>

< cpp‎ | header

This header is part of the general utility library.



std::basic_string class template [edit]
Forward declarations of all classes in the input/output library [edit]


implements constant length bit array
(class template) [edit]
hash support for std::bitset
(class template specialization) [edit]
Forward declarations
Defined in header <functional>
hash function object
(class template) [edit]


performs binary logic operations on bitsets
(function template) [edit]
performs stream input and output of bitsets
(function template) [edit]

[edit] Synopsis

#include <string>
#include <iosfwd>   // for istream, ostream
namespace std {
  template<size_t N> class bitset;
  // bitset operators
  template<size_t N>
    bitset<N> operator&(const bitset<N>&, const bitset<N>&) noexcept;
  template<size_t N>
    bitset<N> operator|(const bitset<N>&, const bitset<N>&) noexcept;
  template<size_t N>
    bitset<N> operator^(const bitset<N>&, const bitset<N>&) noexcept;
  template<class CharT, class Traits, size_t N>
    basic_istream<CharT, Traits>&
      operator>>(basic_istream<CharT, Traits>& is, bitset<N>& x);
  template<class CharT, class Traits, size_t N>
    basic_ostream<CharT, Traits>&
      operator<<(basic_ostream<CharT, Traits>& os, const bitset<N>& x);

[edit] Class template std::bitset

namespace std {
  template<size_t N> class bitset {
    // bit reference
    class reference {
      friend class bitset;
      reference() noexcept;
      reference(const reference&) = default;
      reference& operator=(bool x) noexcept;            // for b[i] = x;
      reference& operator=(const reference&) noexcept;  // for b[i] = b[j];
      bool operator~() const noexcept;                  // flips the bit
      operator bool() const noexcept;                   // for x = b[i];
      reference& flip() noexcept;                       // for b[i].flip();
    // constructors
    constexpr bitset() noexcept;
    constexpr bitset(unsigned long long val) noexcept;
    template<class CharT, class Traits, class Allocator>
      explicit bitset(
        const basic_string<CharT, Traits, Allocator>& str,
        typename basic_string<CharT, Traits, Allocator>::size_type pos = 0,
        typename basic_string<CharT, Traits, Allocator>::size_type n
          = basic_string<CharT, Traits, Allocator>::npos,
        CharT zero = CharT('0'),
        CharT one = CharT('1'));
    template<class CharT>
      explicit bitset(
        const charT* str,
        typename basic_string<CharT>::size_type n = basic_string<CharT>::npos,
        CharT zero = CharT('0'),
        CharT one = CharT('1'));
    // bitset operations
    bitset<N>& operator&=(const bitset<N>& rhs) noexcept;
    bitset<N>& operator|=(const bitset<N>& rhs) noexcept;
    bitset<N>& operator^=(const bitset<N>& rhs) noexcept;
    bitset<N>& operator<<=(size_t pos) noexcept;
    bitset<N>& operator>>=(size_t pos) noexcept;
    bitset<N>& set() noexcept;
    bitset<N>& set(size_t pos, bool val = true);
    bitset<N>& reset() noexcept;
    bitset<N>& reset(size_t pos);
    bitset<N>  operator~() const noexcept;
    bitset<N>& flip() noexcept;
    bitset<N>& flip(size_t pos);
    // element access
    constexpr bool operator[](size_t pos) const;        // for b[i];
    reference operator[](size_t pos);                   // for b[i];
    unsigned long to_ulong() const;
    unsigned long long to_ullong() const;
    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;
    size_t count() const noexcept;
    constexpr size_t size() const noexcept;
    bool operator==(const bitset<N>& rhs) const noexcept;
    bool test(size_t pos) const;
    bool all() const noexcept;
    bool any() const noexcept;
    bool none() const noexcept;
    bitset<N> operator<<(size_t pos) const noexcept;
    bitset<N> operator>>(size_t pos) const noexcept;
  // hash support
  template<class T> struct hash;
  template<size_t N> struct hash<bitset<N>>;