std::bitset<N>::to_ulong

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

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

 

Utilities library

Language support Type support (basic types, RTTI) Library feature-test macros (C++20) Dynamic memory management Program utilities Coroutine support (C++20) Variadic functions is_constant_evaluated (C++20) is_within_lifetime (C++26) initializer_list (C++11) source_location (C++20) Three-way comparison (C++20) three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)    is_eqis_neqis_ltis_lteqis_gtis_gteq (C++20)(C++20)(C++20)(C++20)(C++20)(C++20)

General utilities Date and time Function objects Formatting library (C++20) bitset hash (C++11) Relational operators (deprecated in C++20) rel_ops::operator!=rel_ops::operator> rel_ops::operator<=rel_ops::operator>= Integer comparison functions cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)    cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Swap and type operations swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) Common vocabulary types pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23) Elementary string conversions to_chars (C++17) from_chars (C++17) chars_format (C++17)

 

std::bitset

Member types

bitset::reference

Member functions

bitset::bitset

bitset::operator==bitset::operator!= (until C++20)

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)

 

unsigned long to_ulong() const		(until C++23)
constexpr unsigned long to_ulong() const		(since C++23)

Converts the contents of the bitset to an unsigned long integer.

The first bit of the bitset corresponds to the least significant digit of the number and the last bit corresponds to the most significant digit.

Parameters

(none)

Return value

the converted integer

Exceptions

throws std::overflow_error if the value can not be represented in unsigned long.

Example

Run this code

#include <iostream>
#include <stdexcept>
#include <bitset>
 
int main()
{
    for (unsigned long i = 0; i < 10; ++i) {
        std::bitset<5> b(i);
        std::bitset<5> b_inverted = ~b;
        std::cout << i << '\t' << b << '\t' << b_inverted << '\t'
                  << b_inverted.to_ulong() << '\n'; 
    }
 
    std::cout << std::bitset<32>().to_string('-') << '\n';
 
    try {
        std::bitset<128> x(42);
        std::cout << x.to_ulong() << '\n';
        x.flip();
        std::cout << x.to_ulong() << '\n'; // throws
    } catch (const std::overflow_error& ex) {
        std::cout << "ex: " << ex.what() << '\n';     
    }
}

Possible output:

0	00000	11111	31
1	00001	11110	30
2	00010	11101	29
3	00011	11100	28
4	00100	11011	27
5	00101	11010	26
6	00110	11001	25
7	00111	11000	24
8	01000	10111	23
9	01001	10110	22
--------------------------------
42
ex: bitset to_ulong overflow error

See also

to_string	returns a string representation of the data (public member function)
to_ullong (C++11)	returns an unsigned long long integer representation of the data (public member function)