cStdDev Class Reference
[Statistical data collection]

Statistics class to collect min, max, mean, and standard deviation. More...

#include <cstddev.h>

Inheritance diagram for cStdDev:
cStatistic cOwnedObject cNamedObject cObject cDensityEstBase cWeightedStdDev cHistogramBase cKSplit cPSquare cHistogram cVarHistogram cDoubleHistogram cLongHistogram

List of all members.

Public Member Functions

Constructors, destructor, assignment.

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

virtual cStdDevdup () const
virtual std::string info () const
virtual std::string detailedInfo () 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 void merge (const cStatistic *other)
virtual bool isWeighted () const
virtual long getCount () const
virtual double getSum () const
virtual double getSqrSum () const
virtual double getMin () const
virtual double getMax () const
virtual double getMean () const
virtual double getStddev () const
virtual double getVariance () const
virtual double getWeights () const
virtual double getWeightedSum () const
virtual double getSqrSumWeights () const
virtual double getWeightedSqrSum () const
virtual double random () const
virtual void clearResult ()
virtual void saveToFile (FILE *) const
virtual void loadFromFile (FILE *)

Detailed Description

Statistics class to collect min, max, mean, and standard deviation.


Member Function Documentation

virtual std::string cStdDev::detailedInfo (  )  const [virtual]

Produces a multi-line description of the object.

See cObject for more details.

Reimplemented from cObject.

Reimplemented in cDensityEstBase, cKSplit, and cPSquare.

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

Creates and returns an exact copy of this object.

See cObject for more details.

Reimplemented from cObject.

Reimplemented in cLongHistogram, cDoubleHistogram, cKSplit, cPSquare, cWeightedStdDev, and cVarHistogram.

virtual double cStdDev::getMean (  )  const [inline, virtual]

Returns the mean of the observations.

Returns 0.0 if nothing was collected yet.

Implements cStatistic.

Reimplemented in cWeightedStdDev.

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

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

See cObject for more details.

Reimplemented from cObject.

Reimplemented in cWeightedStdDev.

virtual void cStdDev::merge ( const cStatistic other  )  [virtual]

Updates this object with data coming from another statistics object -- as if this object had collected observations fed into the other object as well.

Throws an error if the other object is weighted statistics (see isWeighted()).

Implements cStatistic.

Reimplemented in cDensityEstBase, cKSplit, cPSquare, and cWeightedStdDev.

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

Assignment operator.

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

virtual void cStdDev::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 cStatistic.

Reimplemented in cDensityEstBase, cHistogramBase, cHistogram, cKSplit, cPSquare, cWeightedStdDev, and cVarHistogram.

virtual void cStdDev::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 cStatistic.

Reimplemented in cDensityEstBase, cHistogramBase, cHistogram, cKSplit, cPSquare, cWeightedStdDev, and cVarHistogram.


The documentation for this class was generated from the following file:
Generated on Fri Mar 7 17:19:42 2014 for OMNeT++ Simulation Library by  doxygen 1.6.3