Namespaces
Variants
Views
Actions

C++ named requirements: UniformRandomBitGenerator (since C++11)

From cppreference.com
< cpp‎ | named req
 
 
C++ named requirements
Basic
Type properties
Library-Wide
Container
Container Elements
(C++11)

Iterator
Stream I/O
Formatters
(C++20)
Random Numbers
(C++11)    
UniformRandomBitGenerator
(C++11)    
Concurrency
(C++11)
(C++11)
Ranges
Other
(C++11)


 

A uniform random bit generator is a function object returning unsigned integer values such that each value in the range of possible results has (ideally) equal probability.

Uniform random bit generators are not intended to be used as random number generators: they are used as the source of random bits (generated in bulk, for efficiency). Any uniform random bit generator may be plugged into any random number distribution in order to obtain a random number (formally, a random variate).

Contents

[edit] Requirements

The type G satisfies UniformRandomBitGenerator if

Given g, a value of type G, all following conditions are satisfied:

  • G::result_type is valid, and denotes an unsigned integer type.
  • The following expressions must be valid and have their specified effects:
(until C++20)
 Expression  Type Requirements
G::min() G::result_type 
  • Returns the smallest value that G's operator() may return. 
  • The return value is strictly less than G::max().
  • The function must be constexpr.
G::max() G::result_type
  • Returns the largest value that G's operator() may return.
  • The return value is strictly greater than G::min().
  • The function must be constexpr.
g() G::result_type
  • Returns a value in the closed interval [G::min()G::max()].
  • Has amortized constant complexity.

All following conditions are satisfied:

(since C++20)

[edit] Notes

All RandomNumberEngines satisfy this requirement.

[edit] Standard library

The following standard library facilities expect a UniformRandomBitGenerator type.

(until C++17)(C++11)
randomly re-orders elements in a range
(function template) [edit]
(C++17)
selects N random elements from a sequence
(function template) [edit]
evenly distributes real values of given precision across [01)
(function template) [edit]
produces integer values evenly distributed across a range
(class template) [edit]
produces real values evenly distributed across a range
(class template) [edit]
all other random number distributions

The following standard library facilities satisfy UniformRandomBitGenerator without additionally satisfying RandomNumberEngine:

non-deterministic random number generator using hardware entropy source
(class) [edit]

[edit] See also

specifies that a type qualifies as a uniform random bit generator
(concept) [edit]