std::generate_canonical

Defined in header `<random>`
template< class RealType, size_t bits, class Generator > RealType generate_canonical( Generator& g );		(since C++11)

Generates a random floating point number in range $[0, 1)$ .

To generate enough entropy, generate_canonical() will call g() exactly $k$ times, where $k = max(1, b / log 2 R )$ and

b = std::min<std::size_t>(bits, std::numeric_limits<RealType>::digits)
R = g.max() - g.min() + 1.

Parameters

g

-

generator to use to acquire entropy

Return value

Floating point value in range $[0, 1)$ .

Exceptions

None except from those thrown by g

Notes

Some existing implementations have a bug where they may occasionally return 1.0 if RealType is float GCC #63176 LLVM #18767. This is LWG issue 2524

Example

produce random numbers with 10 bits of randomness: this may produce only k*R distinct values

Run this code

#include <random>
#include <iostream>

int main()
{
    std::random_device rd;
    std::mt19937 gen(rd());
    for(int n=0; n<10; ++n) {
        std::cout << std::generate_canonical<double, 10>(gen) << ' ';
    }
}

Output:

0.208143 0.824147 0.0278604 0.343183 0.0173263 0.864057 0.647037 0.539467 0.0583497 0.609219

Language
Headers
Freestanding and hosted implementations
Named requirements
Language support library
Concepts library (C++20)
Diagnostics library
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

Common mathematical functions
Special mathematical functions
Floating-point environment (C++11)
Complex numbers
Numeric arrays
Pseudo-random number generation
Compile-time rational arithmetic (C++11)
Numeric algorithms
gcd (C++17)
lcm (C++17)
Generic numeric operations
iota (C++11)
accumulate
inner_product
adjacent_difference
partial_sum
reduce (C++17)
transform_reduce (C++17)
inclusive_scan (C++17)
exclusive_scan (C++17)
transform_inclusive_scan (C++17)
transform_exclusive_scan (C++17)
Bit operations
bit_cast (C++20)
ispow2 (C++20)
ceil2 (C++20)
floor2 (C++20)
log2p1 (C++20)