zeus::IDistribution Class Reference

#include <IDistribution.hpp>

Inheritance diagram for zeus::IDistribution:

Public Member Functions
virtual Float MQUALIFIER	getEntropy () const =0
virtual Float MQUALIFIER	getExpectedValue () const =0
virtual Float MQUALIFIER	getMean () const =0
virtual Float MQUALIFIER	getMedian () const =0
virtual Float MQUALIFIER	getVariance () const =0
virtual Float MQUALIFIER	getStdDeviation () const =0
virtual Float MQUALIFIER	getMode () const =0
virtual Float MQUALIFIER	getSkewness () const =0
virtual Float MQUALIFIER	getCumulativeProb (const Float &rfStart, const Float &rfEnd) const =0
virtual Float MQUALIFIER	getProb (const Float &rfX) const =0
virtual Float MQUALIFIER	getSampleProb (Int iSample) const =0

Detailed Description

This interface defines the access to a distribution object

Member Function Documentation

getCumulativeProb()

virtual Float MQUALIFIER zeus::IDistribution::getCumulativeProb ( const Float &  rfStart, const Float &  rfEnd  ) const

pure virtual

Cumulative method to get the probability between two positions (samples)

Parameters

rfStart	: start position
rfEnd	: End position

Returns

cumulative probability

Implemented in zeus::TNormalDistribution, zeus::TBinomialDistribution, zeus::TPoissonDistribution, and zeus::TDistribution.

getEntropy()

virtual Float MQUALIFIER zeus::IDistribution::getEntropy ( ) const

pure virtual

Hiding methods.

returns the entropy of the distribution

Implemented in zeus::TNormalDistribution, zeus::TBinomialDistribution, zeus::TPoissonDistribution, and zeus::TDistribution.

getExpectedValue()

virtual Float MQUALIFIER zeus::IDistribution::getExpectedValue ( ) const

pure virtual

returns the expected value of the distribution

Implemented in zeus::TNormalDistribution, zeus::TBinomialDistribution, zeus::TPoissonDistribution, and zeus::TDistribution.

getMean()

virtual Float MQUALIFIER zeus::IDistribution::getMean ( ) const

pure virtual

calculates the mean value, which is also called sample mean. This is the most used method to calculate the avarage of a distribution.

Returns

mean value

Implemented in zeus::TNormalDistribution, zeus::TBinomialDistribution, zeus::TPoissonDistribution, and zeus::TDistribution.

getMedian()

virtual Float MQUALIFIER zeus::IDistribution::getMedian ( ) const

pure virtual

returns the median of the probability distribution. The median value meets following constraints P(X <= m1) >= 0.5 and P(X >= m2) >= 0.5. If m1 is not equal to m2 (even set of values) then (m1 + m2)/2 is returned To calculate the median based on sample values, use the static method taking a list of float values.

Returns

Median value of the distribution

Implemented in zeus::TNormalDistribution, zeus::TBinomialDistribution, zeus::TPoissonDistribution, and zeus::TDistribution.

getMode()

virtual Float MQUALIFIER zeus::IDistribution::getMode ( ) const

pure virtual

Returns the mode of the distribution curve

Implemented in zeus::TNormalDistribution, zeus::TBinomialDistribution, zeus::TPoissonDistribution, and zeus::TDistribution.

getProb()

virtual Float MQUALIFIER zeus::IDistribution::getProb ( const Float &  rfX ) const

pure virtual

Returns the probability at position x. For discrete distribution this returns the value 0 (not defined).

Parameters

rfX	: position in X

Returns

probability

Implemented in zeus::TNormalDistribution, zeus::TBinomialDistribution, zeus::TPoissonDistribution, and zeus::TDistribution.

getSampleProb()

virtual Float MQUALIFIER zeus::IDistribution::getSampleProb ( Int  iSample ) const

pure virtual

Returns the probability for a sample

Parameters

iSample

: index of the sample

Returns

probability

Implemented in zeus::TNormalDistribution, zeus::TBinomialDistribution, zeus::TPoissonDistribution, and zeus::TDistribution.

getSkewness()

virtual Float MQUALIFIER zeus::IDistribution::getSkewness ( ) const

pure virtual

Returns the skewness of the distribution curve

Implemented in zeus::TNormalDistribution, zeus::TBinomialDistribution, zeus::TPoissonDistribution, and zeus::TDistribution.

getStdDeviation()

virtual Float MQUALIFIER zeus::IDistribution::getStdDeviation ( ) const

pure virtual

Returns the standard deviation of the distribution

Implemented in zeus::TNormalDistribution, zeus::TBinomialDistribution, zeus::TPoissonDistribution, and zeus::TDistribution.

getVariance()

virtual Float MQUALIFIER zeus::IDistribution::getVariance ( ) const

pure virtual

returns the variance of the distribution

Implemented in zeus::TNormalDistribution, zeus::TBinomialDistribution, zeus::TPoissonDistribution, and zeus::TDistribution.

---

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

• IDistribution.hpp