RandomGenerator Class Reference

Detailed Description

Defines Drake's canonical implementation of the UniformRandomBitGenerator C++ concept (as well as a few conventional extras beyond the concept, e.g., seeds).

This uses the 32-bit Mersenne Twister mt19937 by Matsumoto and Nishimura, 1998. For more information, see https://en.cppreference.com/w/cpp/numeric/random/mersenne_twister_engine

#include <drake/common/random.h>

Public Types
using	result_type = std::mt19937::result_type

Public Member Functions
	RandomGenerator ()=default
	Creates a generator using the default_seed.
	RandomGenerator (result_type seed)
	Creates a generator using given seed.
result_type	operator() ()
	Generates a pseudo-random value.
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
	RandomGenerator (const RandomGenerator &)=default
RandomGenerator &	operator= (const RandomGenerator &)=default
	RandomGenerator (RandomGenerator &&)=default
RandomGenerator &	operator= (RandomGenerator &&)=default

Static Public Member Functions
static constexpr result_type	min ()
static constexpr result_type	max ()

Static Public Attributes
static constexpr result_type	default_seed = std::mt19937::default_seed

Member Typedef Documentation

result_type

using result_type = std::mt19937::result_type

Constructor & Destructor Documentation

RandomGenerator() [1/4]

RandomGenerator ( const RandomGenerator & )

default

RandomGenerator() [2/4]

RandomGenerator ( RandomGenerator && )

default

RandomGenerator() [3/4]

RandomGenerator ( )

default

Creates a generator using the default_seed.

Actual creation of the generator is deferred until first use so this constructor is fast and does not allocate any heap memory.

RandomGenerator() [4/4]

RandomGenerator ( result_type seed )

explicit

Creates a generator using given seed.

Member Function Documentation

max()

constexpr result_type max ( )

staticconstexpr

min()

constexpr result_type min ( )

staticconstexpr

operator()()

result_type operator()

(

)

Generates a pseudo-random value.

operator=() [1/2]

RandomGenerator & operator= ( const RandomGenerator & )

default

operator=() [2/2]

RandomGenerator & operator= ( RandomGenerator && )

default

Member Data Documentation

default_seed

result_type default_seed = std::mt19937::default_seed

staticconstexpr

---

The documentation for this class was generated from the following file:

• drake/common/random.h