Calculates some basic statistical parameters of a distribution: sum, mean, variance, and provides the normal approximation.
More...
|
| BasicStatistics () |
| Default constructor. More...
|
|
| BasicStatistics (BasicStatistics const &arg) |
| Copy constructor. More...
|
|
BasicStatistics & | operator= (BasicStatistics const &arg) |
| Assignment. More...
|
|
void | clear () |
| Set sum, mean, and variance to zero. More...
|
|
template<typename ProbabilityIterator > |
void | update (ProbabilityIterator probability_begin, ProbabilityIterator const probability_end) |
| This does the actual calculation. More...
|
|
template<typename ProbabilityIterator , typename CoordinateIterator > |
void | update (ProbabilityIterator const probability_begin, ProbabilityIterator const probability_end, CoordinateIterator const coordinate_begin) |
| This does the actual calculation. More...
|
|
RealType | mean () const |
| Returns the mean. More...
|
|
void | setMean (RealType const &mean) |
|
RealType | variance () const |
| Returns the variance. More...
|
|
void | setVariance (RealType const &variance) |
|
RealType | sum () const |
| Returns the sum. More...
|
|
void | setSum (RealType const &sum) |
|
RealType | normalDensity_sqrt2pi (RealType coordinate) const |
| Returns the density of the normal approximation at point, multiplied by sqrt( 2 * pi ). This saves a division operation compared to normalDensity() More...
|
|
RealType | normalDensity (RealType const coordinate) const |
| See normalDensity_sqrt2pi(). Returns the density of the normal distribution at point. More...
|
|
void | normalApproximation (probability_container &probability) |
| The argument probability is filled with values according to the normal approximation. Its size() is not changed. The approximation takes place at coordinate positions 0, 1, ..., size()-1. More...
|
|
void | normalApproximation (probability_container &probability, typename probability_container::size_type const size) |
|
void | normalApproximation (probability_container &probability, coordinate_container const &coordinate) |
| The argument probability is filled with values according to the normal approximation. The second argument coordinate contains the positions where the approximation takes place. probability.size() is set to coordinate.size(). More...
|
|
template<typename RealT = double>
class OpenMS::Math::BasicStatistics< RealT >
Calculates some basic statistical parameters of a distribution: sum, mean, variance, and provides the normal approximation.
The intended usage is as follows:
- create an instance
- set the basic statistical parameters by either
- calling one of the update() member functions, or
- using the set... methods
- do something with the basic statistical parameters, e.g.
- using the get... methods, or
- obtain samples from a normal approximation with these parameters
- whatever member function you might want to add to this class ;-)