Edit

Share via

<random> functions

  • Article

generate_canonical

Returns a floating-point value from a random sequence.

template <class RealType, size_t Bits, class Generator>
RealType generate_canonical(Generator& Gen);

Parameters

RealType
The floating point integral type. For possible types, see <random>.

Bits
The number of bits of randomness to use.

Generator
A random number generator class.

Gen
A reference to an instance of a random number generator of type Generator.

Remarks

The template function calls operator() of Gen repeatedly and packs the returned values into a floating-point value x of type RealType until it has gathered the specified number of mantissa bits in x. The specified number is the smaller of Bits (which must be nonzero) and the full number of mantissa bits in RealType. The first call supplies the lowest-order bits. The function returns x.