cWeightedStdDev Class Reference
[Statistical data collection]

Statistics class to collect doubles and calculate weighted statistics of them. More...

#include <cstddev.h>

Inheritance diagram for cWeightedStdDev:

Public Member Functions
Constructors, destructor, assignment.

	cWeightedStdDev (const cWeightedStdDev &r)
	cWeightedStdDev (const char *name=NULL)
virtual	~cWeightedStdDev ()
cWeightedStdDev &	operator= (const cWeightedStdDev &res)
Redefined cObject member functions.

virtual cWeightedStdDev *	dup () const
virtual std::string	info () const
virtual void	parsimPack (cCommBuffer *buffer)
virtual void	parsimUnpack (cCommBuffer *buffer)
Redefined cStatistic functions.

virtual void	collect (double value)
virtual void	collect (SimTime value)
virtual bool	isWeighted () const
virtual void	collect2 (double value, double weight)
virtual void	collect2 (SimTime value, double weight)
virtual void	collect2 (double value, SimTime weight)
virtual void	collect2 (SimTime value, SimTime weight)
virtual void	merge (const cStatistic *other)
virtual void	clearResult ()
virtual double	getMean () const
virtual double	getVariance () const
virtual double	getWeights () const
virtual double	getWeightedSum () const
virtual double	getSqrSumWeights () const
virtual double	getWeightedSqrSum () const
virtual void	saveToFile (FILE *) const
virtual void	loadFromFile (FILE *)

Detailed Description

Statistics class to collect doubles and calculate weighted statistics of them.

It can be used for example to calculate time average.

virtual void cWeightedStdDev::collect2	(	double	value,
		double	weight
	)			`[virtual]`

Collects one value with a given weight.

Negative weights will cause a runtime error.

Reimplemented from cStatistic.

virtual cWeightedStdDev* cWeightedStdDev::dup ( ) const [inline, virtual]

Creates and returns an exact copy of this object.

See cObject for more details.

Reimplemented from cStdDev.

virtual std::string cWeightedStdDev::info ( ) const [virtual]

Produces a one-line description of the object's contents.

See cObject for more details.

Reimplemented from cStdDev.

cWeightedStdDev& cWeightedStdDev::operator= ( const cWeightedStdDev & res )

Assignment operator.

The name member is not copied; see cNamedObject's operator=() for more details.

virtual void cWeightedStdDev::parsimPack ( cCommBuffer * buffer ) [virtual]

Serializes the object into an MPI send buffer.

Used by the simulation kernel for parallel execution. See cObject for more details.

Reimplemented from cStdDev.

virtual void cWeightedStdDev::parsimUnpack ( cCommBuffer * buffer ) [virtual]

Deserializes the object from an MPI receive buffer Used by the simulation kernel for parallel execution.

See cObject for more details.

Reimplemented from cStdDev.

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