Standard library header <bitset>

 

C++

Compiler support

Freestanding and hosted

Language

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Technical specifications

Symbols index

External libraries

 

Standard Library headers

Note: a slash '/' in a revision mark means that the header was deprecated and/or removed.

Language Support
<cstddef> <cstdlib> <version> (C++20) <limits> <climits>	<cfloat> <cstdint> (C++11) <new> <typeinfo>	<source_location> (C++20) <exception> <initializer_list> (C++11)   <compare> (C++20)	<coroutine> (C++20) <csignal> <csetjmp> <cstdarg>
Concepts
<concepts> (C++20)
Diagnostics
<stdexcept>	<cassert>	<cerrno>	<system_error> (C++11)
General utilities
<utility> <memory> <memory_resource> (C++17) <scoped_allocator> (C++11)   <expected> (C++23)	<bitset> <tuple> (C++11) <optional> (C++17) <any> (C++17)	<variant> (C++17) <type_traits> (C++11) <ratio> (C++11) <chrono> (C++11)	<typeindex> (C++11) <functional> <stacktrace> (C++23) <ctime>
Strings
<string> <string_view> (C++17) <cstring>	<charconv> (C++17) <format> (C++20)	<cctype> <cwctype>	<cwchar> <cuchar> (C++11)
Localization
<locale> <clocale>	<codecvt> (C++11/17)
Containers
<span> (C++20) <array> (C++11) <vector>	<deque> <forward_list> (C++11) <list>	<map> <set> <queue>	<unordered_map> (C++11) <unordered_set> (C++11) <stack>
Iterators
<iterator>
Ranges
<ranges> (C++20)
Algorithms
<algorithm>	<execution> (C++17)
Numerics
<complex> <random> (C++11)	<valarray> <numeric>	<bit> (C++20) <numbers> (C++20)	<cfenv> (C++11) <cmath>
Input/Output
<iosfwd> <ios> <iomanip> <streambuf>	<istream> <ostream> <iostream>	<syncstream> (C++20) <spanstream> (C++23) <sstream> <fstream>	<cstdio> <cinttypes> (C++11) <strstream> (C++98/)
Regular expressions
<regex> (C++11)
Filesystem support
<filesystem> (C++17)
Thread support
<thread> (C++11) <atomic> (C++11) <mutex> (C++11)	<shared_mutex> (C++14) <condition_variable> (C++11)   <future> (C++11)	<stop_token> (C++20) <semaphore> (C++20)	<latch> (C++20) <barrier> (C++20)
C compatibility
<cstdbool> (C++11/17/20) <ccomplex> (C++11/17/20)	<ctgmath> (C++11/17/20) <cstdalign> (C++11/17/20)	<ciso646> (until C++20) <stdatomic.h>

 

This header is part of the general utility library.

Includes
<string>	std::basic_string class template
<iosfwd>	Forward declarations of all classes in the input/output library
Classes
bitset	implements constant length bit array (class template)
std::hash<std::bitset> (C++11)	hash support for std::bitset (class template specialization)
Forward declarations
Defined in header <functional>
hash (C++11)	hash function object (class template)
Functions
operator&operator|operator^	performs binary logic operations on bitsets (function template)
operator<<operator>>	performs stream input and output of bitsets (function template)

Synopsis

#include <string>
#include <iosfwd>   // for istream, ostream
 
namespace std {
  template<size_t N> class bitset;
 
  // bitset operators
  template<size_t N>
    constexpr bitset<N> operator&(const bitset<N>&, const bitset<N>&) noexcept;
  template<size_t N>
    constexpr bitset<N> operator|(const bitset<N>&, const bitset<N>&) noexcept;
  template<size_t N>
    constexpr 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);
}

Class template std::bitset

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