std::bitset::reference

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Utilities library

Type support (basic types, RTTI, type traits)

Dynamic memory management

Error handling

Program utilities

Variadic functions

Date and time

Function objects

initializer_list (C++11)

bitset

hash (C++11)

Relational operators

rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>=

Optional and any

optional (C++17)

any (C++17)

Pairs and tuples

pair

tuple (C++11)

apply (C++17)

piecewise_construct_t (C++11)

piecewise_construct (C++11)

integer_sequence (C++14)

Swap, forward and move

swap

exchange (C++14)

forward (C++11)

move (C++11)

move_if_noexcept (C++11)

Type operations

declval (C++11)

as_const (C++17)

 

std::bitset

Member types

bitset::reference

Member functions

bitset::bitset

bitset::operator==bitset::operator!=

Element access

bitset::operator[]

bitset::test

bitset::allbitset::anybitset::none (C++11)

bitset::count

Capacity

bitset::size

Modifiers

bitset::operator&=bitset::operator|=bitset::operator^=bitset::operator~

bitset::operator<<=bitset::operator>>=bitset::operator<<bitset::operator>>

bitset::set

bitset::reset

bitset::flip

Conversions

bitset::to_string

bitset::to_ulong

bitset::to_ullong (C++11)

Non-member functions

operator&operator|operator^

operator<<operator>>

Helper classes

std::hash (C++11)

 

class reference;

The std::bitset class includes std::bitset::reference as a publicly-accessible nested class. This class is used as a proxy object to allow users to interact with individual bits of a bitset, since standard C++ types (like references and pointers) are not built with enough precision to specify individual bits.

The primary use of std::bitset::reference is to provide an l-value that can be returned from operator[].

Any reads or writes to a bitset that happen via a std::bitset::reference potentially read or write to the entire underlying bitset.

Member functions

(constructor)	constructs the reference. Accessible only to std::bitset itself (private member function)
(destructor)	~reference (public member function)
operator=	assigns a bool to the referenced bit (public member function)
operator bool	returns the referenced bit (public member function)
operator ~	returns inverted referenced bit (public member function)
flip	flips the referenced bit (public member function)

std::bitset<N>::reference::~reference

~reference()

Destroys the reference.

std::bitset<N>::reference::operator=

reference& operator=( bool x ); reference& operator=( const reference& x );

Assigns a value to the referenced bit.

Parameters

x

-

value to assign

Return value

*this

Exceptions

(none)	(until C++11)
noexcept specification:   noexcept	(since C++11)

std::bitset<N>::reference::operator bool

operator bool() const;

Returns the value of the referenced bit.

Parameters

(none)

Return value

The referenced bit.

Exceptions

(none)	(until C++11)
noexcept specification:   noexcept	(since C++11)

std::bitset<N>::reference::operator~

bool operator~() const;

Returns the inverse of the referenced bit.

Parameters

(none)

Return value

The inverse of the referenced bit.

Exceptions

(none)	(until C++11)
noexcept specification:   noexcept	(since C++11)

std::bitset<N>::reference::flip

reference& flip();

Inverts the referenced bit.

Parameters

(none)

Return value

*this

Exceptions

(none)	(until C++11)
noexcept specification:   noexcept	(since C++11)

See also

operator[]	accesses specific bit (public member function)