lti::gaussianDistribution Class Reference

Normal distributed random number class. More...

#include <ltiGaussDist.h>

Inheritance diagram for lti::gaussianDistribution:

[legend]

Collaboration diagram for lti::gaussianDistribution:

[legend]

List of all members.

Classes
class	parameters
	parameters for gaussian distribution More...
Public Member Functions
	gaussianDistribution (const double mean=0.0, const double stdDeviation=1.0)
	gaussianDistribution (const parameters &theParams)
virtual	~gaussianDistribution ()
const parameters &	getParameters () const
virtual double	draw () const
double	draw (const double &average, const double &stdDeviation) const
bool	apply (const double &average, const double &stdDeviation, double &result) const
gaussianDistribution &	copy (const gaussianDistribution &other)
virtual functor *	clone () const
virtual const char *	getTypeName () const

---

Detailed Description

Normal distributed random number class.

---

Constructor & Destructor Documentation

lti::gaussianDistribution::gaussianDistribution	(	const double	mean = 0.0,
		const double	stdDeviation = 1.0
	)

default constructor.

Sets mean and standard deviation and mean.

Referenced by clone().

lti::gaussianDistribution::gaussianDistribution

(

const parameters &

theParams

)

constructor, sets the parameters

virtual lti::gaussianDistribution::~gaussianDistribution

(

)

[inline, virtual]

destructor

---

Member Function Documentation

bool lti::gaussianDistribution::apply	(	const double &	average,
		const double &	stdDeviation,
		double &	result
	)			const

return a gaussian distributed random number.

Parameters:

	average	mean value of the distribution
	stdDeviation	std. deviation of the distribution
	result	value from the distribution

Returns:

true if successful, false otherwise.

virtual functor* lti::gaussianDistribution::clone

(

)

const [inline, virtual]

returns a pointer to a clone of the functor.

Reimplemented from lti::continuousRandomDistribution.

References gaussianDistribution().

gaussianDistribution& lti::gaussianDistribution::copy

(

const gaussianDistribution &

other

)

copy data of "other" functor.

Reimplemented from lti::continuousRandomDistribution.

double lti::gaussianDistribution::draw	(	const double &	average,
		const double &	stdDeviation
	)			const

draw a number for the distribution with the given average and std.

deviation

virtual double lti::gaussianDistribution::draw

(

)

const [virtual]

draws a number from the distribution.

Reimplemented from lti::continuousRandomDistribution.

const parameters& lti::gaussianDistribution::getParameters

(

)

const

returns the current parameters.

Reimplemented from lti::functor.

virtual const char* lti::gaussianDistribution::getTypeName

(

void

)

const [inline, virtual]

returns the name of this type

Reimplemented from lti::continuousRandomDistribution.

---

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

• ltiGaussDist.h