om::math::UniformDistribution< T > Class Template Reference

A class that represents a uniform probability distribution of the templated type. More...

#include <omUniformDistribution.h>

Public Member Functions
	UniformDistribution ()
	Create a uniform distribution on the interval [0,1]. More...
	UniformDistribution (const Random< T > &newRandom)
	Create a uniform distribution on the interval [0,1] with the specified random variable. More...
	UniformDistribution (T min, T max)
	Create a uniform distribution on the interval [ min, max ]. More...
	UniformDistribution (T min, T max, const Random< T > &newRandom)
	Create a uniform distribution on the interval [ min, max ] using the specified random variable. More...
T	sample ()
	Generate a sample from the uniform distribution. More...
T	getMinimum () const
	Get the minimum value that the uniform distribution can generate. More...
void	setMinimum (T min)
	Set the minimum value that the uniform distribution can generate. More...
T	getMaximum () const
	Get the maximum value that the uniform distribution can generate. More...
void	setMaximum (T max)
	Set the maximum value that the uniform distribution can generate. More...
Random< T > &	getRandom ()
	Get the random variable used to generate samples for this distribution. More...
const Random< T > &	getRandom () const
	Get the random variable used to generate samples for this distribution. More...
void	setRandom (const Random< T > &newRandom)
	Set the random variable used to generate samples for this distribution. More...

Detailed Description

template<typename T>
class om::math::UniformDistribution< T >

A class that represents a uniform probability distribution of the templated type.

Constructor & Destructor Documentation

template<typename T >

om::math::UniformDistribution< T >::UniformDistribution ( )

inline

Create a uniform distribution on the interval [0,1].

template<typename T >

om::math::UniformDistribution< T >::UniformDistribution ( const Random< T > &  newRandom )

inline

Create a uniform distribution on the interval [0,1] with the specified random variable.

The created uniform distribution will produce samples using the specified random variable.

template<typename T >

om::math::UniformDistribution< T >::UniformDistribution ( T  min, T  max  )

inline

Create a uniform distribution on the interval [ min, max ].

template<typename T >

om::math::UniformDistribution< T >::UniformDistribution ( T  min, T  max, const Random< T > &  newRandom  )

inline

Create a uniform distribution on the interval [ min, max ] using the specified random variable.

The created uniform distribution will produce samples using the specified random variable.

Member Function Documentation

template<typename T >

T om::math::UniformDistribution< T >::sample ( )

inline

Generate a sample from the uniform distribution.

template<typename T >

T om::math::UniformDistribution< T >::getMinimum ( ) const

inline

Get the minimum value that the uniform distribution can generate.

template<typename T >

void om::math::UniformDistribution< T >::setMinimum ( T  min )

inline

Set the minimum value that the uniform distribution can generate.

template<typename T >

T om::math::UniformDistribution< T >::getMaximum ( ) const

inline

Get the maximum value that the uniform distribution can generate.

template<typename T >

void om::math::UniformDistribution< T >::setMaximum ( T  max )

inline

Set the maximum value that the uniform distribution can generate.

template<typename T >

Random<T>& om::math::UniformDistribution< T >::getRandom ( )

inline

Get the random variable used to generate samples for this distribution.

template<typename T >

const Random<T>& om::math::UniformDistribution< T >::getRandom ( ) const

inline

Get the random variable used to generate samples for this distribution.

template<typename T >

void om::math::UniformDistribution< T >::setRandom ( const Random< T > &  newRandom )

inline

Set the random variable used to generate samples for this distribution.

---

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

• omUniformDistribution.h