zeus::TNormalDistribution Class Reference

#include <NormalDistribution.h>

Inheritance diagram for zeus::TNormalDistribution:

List of all members.

Public Member Functions
	TNormalDistribution (const Float &rfMean, const Float &rfStdDeviation)
virtual	~TNormalDistribution ()
TDistribution	sample (Int iSamples) const
TDistribution	sample (Int iSamples, Float fStart, Float fEnd) const
virtual Float MQUALIFIER	getEntropy () const
virtual Float MQUALIFIER	getExpectedValue () const
virtual Float MQUALIFIER	getMean () const
virtual Float MQUALIFIER	getMedian () const
virtual Float MQUALIFIER	getVariance () const
virtual Float MQUALIFIER	getStdDeviation () const
virtual Float MQUALIFIER	getMode () const
virtual Float MQUALIFIER	getSkewness () const
virtual Float MQUALIFIER	getCumulativeProb (const Float &rfStart, const Float &rfEnd) const
virtual Float MQUALIFIER	getProb (const Float &rfX) const
virtual Float MQUALIFIER	getSampleProb (Int iSample) const
Static Public Member Functions
static void	sampleDistribution (const Float &rfMean, const Float &rfStdDeviation, Int iSamples, const Float &rfStart, const Float &rfEnd, TArrayList< TMappedValue > &rlstData)
static TDistribution	sampleDistribution (const Float &rfMean, const Float &rfStdDeviation, Int iSamples, const Float &rfStart, const Float &rfEnd)
static Float	getProbability (const Float &rfMean, const Float &rfStdDeviation, const Float &rfX)

---

Detailed Description

This distribution class represents a normal distribution. In order to calculate, this is non discretizised

---

Constructor & Destructor Documentation

zeus::TNormalDistribution::TNormalDistribution	(	const Float &	rfMean,
		const Float &	rfStdDeviation
	)		[inline]

Creates the normal distribution

Parameters:

rfStdDeviation	:
rfMean	:

virtual zeus::TNormalDistribution::~TNormalDistribution

(

)

[inline, virtual]

Destroys the distribution

---

Member Function Documentation

Float MQUALIFIER TNormalDistribution::getCumulativeProb	(	const Float &	rfStart,
		const Float &	rfEnd
	)		const [virtual]

See also:

IDistribution::getCumulativeProb

Implements zeus::IDistribution.

Float MQUALIFIER zeus::TNormalDistribution::getEntropy

(

)

const [inline, virtual]

See also:

IDistribution::getEntropy

Implements zeus::IDistribution.

Float MQUALIFIER zeus::TNormalDistribution::getExpectedValue

(

)

const [inline, virtual]

See also:

IDistribution::getExpectedValue

Implements zeus::IDistribution.

Float MQUALIFIER zeus::TNormalDistribution::getMean

(

)

const [inline, virtual]

See also:

IDistribution::getMean

Implements zeus::IDistribution.

Float MQUALIFIER zeus::TNormalDistribution::getMedian

(

)

const [inline, virtual]

See also:

IDistribution::getMedian

Implements zeus::IDistribution.

Float MQUALIFIER zeus::TNormalDistribution::getMode

(

)

const [inline, virtual]

See also:

IDistribution::getMode

Implements zeus::IDistribution.

Float MQUALIFIER zeus::TNormalDistribution::getProb

(

const Float &

rfX )

const [inline, virtual]

See also:

IDistribution::getProb

Implements zeus::IDistribution.

Float zeus::TNormalDistribution::getProbability	(	const Float &	rfMean,
		const Float &	rfStdDeviation,
		const Float &	rfX
	)		[inline, static]

returns the gaussian value of a normal distribution given the mean and standard deviation depending on X

Float MQUALIFIER zeus::TNormalDistribution::getSampleProb

(

Int

iSample )

const [inline, virtual]

See also:

IDistribution::getSampleProb

Implements zeus::IDistribution.

Float MQUALIFIER zeus::TNormalDistribution::getSkewness

(

)

const [inline, virtual]

See also:

IDistribution::getSkewness

Implements zeus::IDistribution.

Float MQUALIFIER zeus::TNormalDistribution::getStdDeviation

(

)

const [inline, virtual]

See also:

IDistribution::getVariance

Implements zeus::IDistribution.

Float MQUALIFIER zeus::TNormalDistribution::getVariance

(

)

const [inline, virtual]

See also:

IDistribution::getVariance

Implements zeus::IDistribution.

TDistribution zeus::TNormalDistribution::sample

(

Int

iSamples )

const [inline]

this method returns the sampled data of the normal distribution. The sampling starts a mean minus 3 times deviation and stops at mean plus 3 times deviation.

Parameters:

iSamples

: Number of samples

Returns:

discrete distribution

TDistribution zeus::TNormalDistribution::sample	(	Int	iSamples,
		Float	fStart,
		Float	fEnd
	)		const [inline]

this method returns the sampled data of the normal distribution. The sampling starts fStart and stops on fEnd.

Parameters:

iSamples	: Number of samples
fStart	: Starting point of the sampling
fEnd	: Endpoint of the sampling

Returns:

discrete distribution

TDistribution TNormalDistribution::sampleDistribution	(	const Float &	rfMean,
		const Float &	rfStdDeviation,
		Int	iSamples,
		const Float &	rfStart,
		const Float &	rfEnd
	)		[static]

This static method returns a normal distribution (gaussian curve) out of the given mean and standard deviation.

Parameters:

rfMean	: Mean value
rfStdDeviation	: Standard deviation
iSamples	: Number of samples
rfStart	: Start point of the sampling
rfEnd	: End point of the sampling

Returns:

distribution object

void TNormalDistribution::sampleDistribution	(	const Float &	rfMean,
		const Float &	rfStdDeviation,
		Int	iSamples,
		const Float &	rfStart,
		const Float &	rfEnd,
		TArrayList< TMappedValue > &	rlstData
	)		[static]

This static method returns a normal distribution (gaussian curve) out of the given mean and standard deviation.

Note:

The returned distribution does not sum up to 1 since it is discretized by the use of gaussian values.

Parameters:

rfMean	: Mean value
rfStdDeviation	: Standard deviation
iSamples	: Number of samples
rfStart	: Start point of the sampling
rfEnd	: End point of the sampling
rlstData	: returns the distribution list

---

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

• NormalDistribution.h
• NormalDistribution.cpp