|
User Documentation |
|
Centre for Vision, Speech & Signal Processing |
Comments:
The class MeanCovariance1dC provides the utilities to compute mean and
covariance of an 1 dimensional data set. The object represent
the ideal abstract statistics. Functions for computation of their
estimators are also provided in the class.
Typedefs:
- typedef Mean1dC::NumberT NumberT;
-
The number of items of a data set.
- typedef Mean1dC::LocationT LocationT;
-
The measure of central tendency.
- typedef Mean1dC::LocationT VariationT;
-
The measure of the spread about an average value.
Variables:
Methods:
- MeanCovariance1dC()
-
Creates an object representing the empty data set with zero mean and
zero variance.
- MeanCovariance1dC(const LocationT point)
-
Creates an object representing the data set containing one item.
The variance is set to be zero.
- MeanCovariance1dC(const Mean1dC & m)
-
Creates an object representing the data set with the mean 'm' and
zero variance (the items in the data set has got the same value).
- MeanCovariance1dC(const NumberT n,const LocationT m,const VariationT var)
-
Creates an object representing the data set of 'n' elements with
the mean 'm' and the variance 'var'.
- MeanCovariance1dC(const MeanCovariance1dC & meanCov)
-
The copy constructor.
- const MeanCovariance1dC & operator=(const MeanCovariance1dC & meanCov)
-
The assigment.
Access to the object representation.
------------------------------------
- NumberT Number() const
-
Returns the number of items represented by the object.
- LocationT Mean() const
-
Returns the estimation of the mean of the data set. The value
is equal to the average of all values in the data set.
- VariationT Var() const
-
Returns the variance of the set of data.
- VariationT SampleVar() const
-
Returns the sample variance of the set of data.
- VariationT Cov() const
-
Returns the variance of the set of data. The function is equivalent
to the function Var(). It is provided because of compatibility
with object of representation of sets with higher dimension.
- VariationT StdDev() const
-
Returns the standard deviation of the population.
- VariationT SampleStdDev() const
-
Returns the sample standard deviation of the population.
- const Mean1dC & Mean1d() const
-
Access to the part of the object.
Modification of object.
-----------------------
- void SetZero()
-
Resets the object to represent the empty data set with zero mean
and zero variance.
- void Set(const NumberT n,const LocationT m,const VariationT v)
-
Resets the object to represent the data set with the mean 'm'
and the variance 'v'.
- const MeanCovariance1dC & operator+=(const LocationT p)
-
Adds one data with the value 'p' to the set.
- const MeanCovariance1dC & operator+=(const Mean1dC & m)
-
Adds the set of data represented by the mean 'm' and zero variance.
- const MeanCovariance1dC & operator+=(const MeanCovariance1dC & meanCov)
-
Adds the set of data represented by the mean and the variance 'meanCov'.
- const MeanCovariance1dC & SetSum(const MeanCovariance1dC & meanCov1,const MeanCovariance1dC & meanCov2)
-
Sets the object to be the representant of two merged sets of data
'meanCov1' and 'meanCov2'.
I/O operations
--------------
- void ReadFrom(istream & s)
-
Sets the object according the data read from the input stream 's'.
|
Programmer:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001
|