Simbody  3.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SimTK::Random::Gaussian Class Reference

This is a subclass of Random that generates numbers according to a Gaussian distribution with a specified mean and standard deviation. More...

#include <Random.h>

+ Inheritance diagram for SimTK::Random::Gaussian:

Public Member Functions

 Gaussian ()
 Create a new random number generator that produces values according to a Gaussian distribution with mean 0 and standard deviation 1.
 Gaussian (Real mean, Real stddev)
 Create a new random number generator that produces values according to a Gaussian distribution with the specified mean and standard deviation.
Real getMean () const
 Get the mean of the Gaussian distribution.
void setMean (Real mean)
 Set the mean of the Gaussian distribution.
Real getStdDev () const
 Get the standard deviation of the Gaussian distribution.
void setStdDev (Real stddev)
 Set the standard deviation of the Gaussian distribution.
- Public Member Functions inherited from SimTK::Random
 ~Random ()
void setSeed (int seed)
 Reinitialize this random number generator with a new seed value.
Real getValue () const
 Get the next value in the pseudo-random sequence.
void fillArray (Real array[], int length) const
 Fill an array with values from the pseudo-random sequence.

Protected Member Functions

GaussianImpl & getImpl ()
 Get the internal object which implements the random number generator.
const GaussianImpl & getConstImpl () const
 Get a constant reference to the internal object which implements the random number generator.
- Protected Member Functions inherited from SimTK::Random
 Random ()
 This constructor should never be invoked directly.

Additional Inherited Members

- Protected Attributes inherited from SimTK::Random
RandomImpl * impl

Detailed Description

This is a subclass of Random that generates numbers according to a Gaussian distribution with a specified mean and standard deviation.

Constructor & Destructor Documentation

Create a new random number generator that produces values according to a Gaussian distribution with mean 0 and standard deviation 1.

Create a new random number generator that produces values according to a Gaussian distribution with the specified mean and standard deviation.

Member Function Documentation

Real SimTK::Random::Gaussian::getMean ( ) const

Get the mean of the Gaussian distribution.

void SimTK::Random::Gaussian::setMean ( Real  mean)

Set the mean of the Gaussian distribution.

Real SimTK::Random::Gaussian::getStdDev ( ) const

Get the standard deviation of the Gaussian distribution.

void SimTK::Random::Gaussian::setStdDev ( Real  stddev)

Set the standard deviation of the Gaussian distribution.

GaussianImpl& SimTK::Random::Gaussian::getImpl ( )
protected

Get the internal object which implements the random number generator.

Reimplemented from SimTK::Random.

const GaussianImpl& SimTK::Random::Gaussian::getConstImpl ( ) const
protected

Get a constant reference to the internal object which implements the random number generator.

Reimplemented from SimTK::Random.


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