uniform_real_distribution< drake::symbolic::Expression > Class Reference

Detailed Description

Provides std::uniform_real_distribution, U(a, b), for symbolic expressions.

When operator() is called, it returns a symbolic expression a + (b - a) * v where v is a symbolic random variable associated with the standard uniform distribution.

See also

std::normal_distribution<drake::symbolic::Expression> for the internal representation of this implementation.

#include <drake/common/symbolic/expression/expression.h>

Public Types
using	RealType = drake::symbolic::Expression
using	result_type = RealType

Public Member Functions
	uniform_real_distribution (RealType a, RealType b=1.0)
	Constructs a new distribution object with a minimum value a and a maximum value b.
	uniform_real_distribution ()
	Constructs a new distribution object with a = 0.0 and b = 1.0.
void	reset ()
	Resets the internal state of the distribution object.
result_type	operator() ()
	Generates a symbolic expression representing a random value that is distributed according to the associated probability function.
template<class Generator>
result_type	operator() (Generator &)
	Generates a symbolic expression representing a random value that is distributed according to the associated probability function.
RealType	a () const
	Returns the minimum value a.
RealType	b () const
	Returns the maximum value b.
result_type	min () const
	Returns the minimum potentially generated value.
result_type	max () const
	Returns the maximum potentially generated value.
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
	uniform_real_distribution (const uniform_real_distribution &)=default
uniform_real_distribution &	operator= (const uniform_real_distribution &)=default
	uniform_real_distribution (uniform_real_distribution &&)=default
uniform_real_distribution &	operator= (uniform_real_distribution &&)=default

Friends
bool	operator== (const uniform_real_distribution< drake::symbolic::Expression > &lhs, const uniform_real_distribution< drake::symbolic::Expression > &rhs)

Member Typedef Documentation

RealType

using RealType = drake::symbolic::Expression

result_type

using result_type = RealType

Constructor & Destructor Documentation

uniform_real_distribution() [1/4]

uniform_real_distribution ( RealType a, RealType b = 1.0 )

explicit

Constructs a new distribution object with a minimum value a and a maximum value b.

Exceptions

std::exception

if a and b are constant expressions but a > b.

uniform_real_distribution() [2/4]

uniform_real_distribution

(

)

Constructs a new distribution object with a = 0.0 and b = 1.0.

uniform_real_distribution() [3/4]

uniform_real_distribution ( const uniform_real_distribution< drake::symbolic::Expression > & )

default

uniform_real_distribution() [4/4]

uniform_real_distribution ( uniform_real_distribution< drake::symbolic::Expression > && )

default

Member Function Documentation

a()

RealType a ( ) const

nodiscard

Returns the minimum value a.

b()

RealType b ( ) const

nodiscard

Returns the maximum value b.

max()

result_type max ( ) const

nodiscard

Returns the maximum potentially generated value.

min()

result_type min ( ) const

nodiscard

Returns the minimum potentially generated value.

operator()() [1/2]

result_type operator()

(

)

Generates a symbolic expression representing a random value that is distributed according to the associated probability function.

operator()() [2/2]

template<class Generator>

result_type operator()

(

Generator &

)

Generates a symbolic expression representing a random value that is distributed according to the associated probability function.

Note

We provide this method, which takes a random generator, for compatibility with the std::uniform_real_distribution::operator().

operator=() [1/2]

uniform_real_distribution & operator= ( const uniform_real_distribution< drake::symbolic::Expression > & )

default

operator=() [2/2]

uniform_real_distribution & operator= ( uniform_real_distribution< drake::symbolic::Expression > && )

default

reset()

void reset

(

)

Resets the internal state of the distribution object.

Friends And Related Symbol Documentation

operator==

bool operator== ( const uniform_real_distribution< drake::symbolic::Expression > & lhs, const uniform_real_distribution< drake::symbolic::Expression > & rhs )

friend

---

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

• drake/common/symbolic/expression/expression.h