#include <cpsquare.h>

Description

Implements the P² algorithm, which calculates quantile values without storing the observations. See the seminal paper titled "The P^2 Algorithm for Dynamic Statistical Computing Calculation of Quantiles and Histograms Without Storing Observations" by Raj Jain and Imrich Chlamtac.

Inheritance diagram for cPSquare:

Public Member Functions
Constructors, destructor, assignment.
	cPSquare (const cPSquare &r)

	cPSquare (const char *name=nullptr, int bins=10)

virtual	~cPSquare ()

cPSquare &	operator= (const cPSquare &res)

Redefined cObject member functions.
virtual cPSquare *	dup () const override

virtual void	parsimPack (cCommBuffer *buffer) const override

virtual void	parsimUnpack (cCommBuffer *buffer) override

Redefined member functions from cStatistic
virtual bool	binsAlreadySetUp () const override

virtual void	setUpBins () override

virtual void	collect (double value) override

virtual void	collectWeighted (double value, double weight) override

virtual int	getNumBins () const override

virtual double	getBinEdge (int k) const override

virtual double	getBinValue (int k) const override

virtual int64_t	getNumUnderflows () const override

virtual int64_t	getNumOverflows () const override

virtual double	getUnderflowSumWeights () const override

virtual double	getOverflowSumWeights () const override

virtual int64_t	getNumNegInfs () const override

virtual int64_t	getNumPosInfs () const override

virtual double	getNegInfSumWeights () const override

virtual double	getPosInfSumWeights () const override

virtual double	draw () const override

virtual void	merge (const cStatistic *other) override

virtual void	clear () override

virtual void	saveToFile (FILE *) const override

virtual void	loadFromFile (FILE *) override

Public Member Functions inherited from cAbstractHistogram
	cAbstractHistogram (const cAbstractHistogram &other)

	cAbstractHistogram (const char *name=nullptr, bool weighted=false)

virtual	~cAbstractHistogram ()

cAbstractHistogram &	operator= (const cAbstractHistogram &res)

virtual double	getBinPDF (int k) const

virtual Bin	getBinInfo (int k) const

virtual double	getPDF (double x) const

virtual double	getCDF (double x) const

virtual _OPPDEPRECATED bool	isTransformed () const final

virtual _OPPDEPRECATED void	transform () final

virtual _OPPDEPRECATED int	getNumCells () const final

virtual _OPPDEPRECATED double	getBasepoint (int k) const final

virtual _OPPDEPRECATED double	getCellValue (int k) const final

virtual _OPPDEPRECATED double	getCellPDF (int k) const final

virtual _OPPDEPRECATED int64_t	getUnderflowCell () const final

virtual _OPPDEPRECATED int64_t	getOverflowCell () const final

virtual _OPPDEPRECATED Bin	getCellInfo (int k) const final

Public Member Functions inherited from cStdDev
	cStdDev (const cStdDev &r)

	cStdDev (const char *name=nullptr, bool weighted=false)

virtual	~cStdDev ()

cStdDev &	operator= (const cStdDev &res)

virtual std::string	str () const override

virtual bool	isWeighted () const override

virtual int64_t	getCount () const override

virtual double	getSum () const override

virtual double	getSqrSum () const override

virtual double	getMin () const override

virtual double	getMax () const override

virtual double	getMean () const override

virtual double	getStddev () const override

virtual double	getVariance () const override

virtual double	getSumWeights () const override

virtual double	getWeightedSum () const override

virtual double	getSqrSumWeights () const override

virtual double	getWeightedSqrSum () const override

Public Member Functions inherited from cStatistic
	cStatistic (const cStatistic &r)

	cStatistic (const char *name=nullptr)

virtual	~cStatistic ()

cStatistic &	operator= (const cStatistic &res)

virtual void	collect (SimTime value)

virtual void	collectWeighted (SimTime value, double weight)

virtual void	collectWeighted (double value, SimTime weight)

virtual void	collectWeighted (SimTime value, SimTime weight)

virtual void	record ()

virtual void	recordWithUnit (const char *unit)

virtual void	recordAs (const char name, const char unit=nullptr)

virtual _OPPDEPRECATED double	getWeights () const final

virtual _OPPDEPRECATED void	collect2 (double value, double weight) final

virtual _OPPDEPRECATED void	collect2 (SimTime value, double weight) final

virtual _OPPDEPRECATED void	collect2 (double value, SimTime weight) final

virtual _OPPDEPRECATED void	collect2 (SimTime value, SimTime weight) final

virtual _OPPDEPRECATED double	random () const final

virtual _OPPDEPRECATED void	clearResult () final

Public Member Functions inherited from cRandom
	cRandom (cRNG *rng)

	cRandom (const char name=nullptr, cRNG rng=nullptr)

virtual	~cRandom ()

virtual void	setRNG (cRNG *rng)

cRNG *	getRNG () const

Public Member Functions inherited from cOwnedObject
	cOwnedObject ()

	cOwnedObject (const char *name, bool namepooling=true)

	cOwnedObject (const cOwnedObject &obj)

virtual	~cOwnedObject ()

cOwnedObject &	operator= (const cOwnedObject &o)

virtual cObject *	getOwner () const override

virtual bool	isOwnedObject () const override

virtual bool	isSoftOwner () const

Public Member Functions inherited from cNamedObject
	cNamedObject ()

	cNamedObject (const char *name, bool namepooling=true)

	cNamedObject (const cNamedObject &obj)

virtual	~cNamedObject ()

cNamedObject &	operator= (const cNamedObject &o)

virtual void	setName (const char *s)

virtual const char *	getName () const override

virtual void	setNamePooling (bool b)

virtual bool	getNamePooling ()

Public Member Functions inherited from cObject
	cObject ()

	cObject (const cObject &other)

virtual	~cObject ()

virtual const char *	getClassName () const

bool	isName (const char *s) const

virtual const char *	getFullName () const

virtual std::string	getFullPath () const

const cObject *	getThisPtr () const

virtual _OPPDEPRECATED std::string	info () const

virtual _OPPDEPRECATED std::string	detailedInfo () const

virtual void	forEachChild (cVisitor *v)

cObject *	findObject (const char *name, bool deep=true)

void	copyNotSupported () const

Additional Inherited Members
Static Public Member Functions inherited from cOwnedObject
static long	getTotalObjectCount ()

static long	getLiveObjectCount ()

static void	resetObjectCounters ()

static cDefaultList *	getDefaultOwner ()

Protected Member Functions inherited from cObject
virtual void	take (cOwnedObject *obj)

virtual void	drop (cOwnedObject *obj)

void	dropAndDelete (cOwnedObject *obj)

Constructor & Destructor Documentation

◆ cPSquare() [1/2]

cPSquare ( const cPSquare & r )

Copy constructor.

◆ cPSquare() [2/2]

cPSquare	(	const char *	name = `nullptr`,
		int	bins = `10`
	)

explicit

Constructor.

◆ ~cPSquare()

virtual ~cPSquare ( )

virtual

Destructor.

Member Function Documentation

◆ operator=()

cPSquare& operator= ( const cPSquare & res )

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

◆ dup()

virtual cPSquare* dup ( ) const

inlineoverridevirtual

Creates and returns an exact copy of this object. See cObject for more details.

Reimplemented from cAbstractHistogram.

◆ parsimPack()

virtual void parsimPack ( cCommBuffer * buffer ) const

overridevirtual

Serializes the object into an MPI send buffer. Used by the simulation kernel for parallel execution. See cObject for more details.

Reimplemented from cStdDev.

◆ parsimUnpack()

virtual void parsimUnpack ( cCommBuffer * buffer )

overridevirtual

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

Reimplemented from cStdDev.

◆ binsAlreadySetUp()

virtual bool binsAlreadySetUp ( ) const

inlineoverridevirtual

Returns true if histogram is already available. This cPSquare implementation always returns true, since the algorithm does not contain a precollection stage.

Implements cAbstractHistogram.

◆ setUpBins()

virtual void setUpBins ( )

inlineoverridevirtual

Transforms the array of pre-collected values into histogram structure. This cPSquare implementation does nothing.

Implements cAbstractHistogram.

References cStatistic::collect(), and cStatistic::collectWeighted().

◆ collect()

virtual void collect ( double value )

overridevirtual

Collects one observation.

Reimplemented from cStdDev.

◆ collectWeighted()

virtual void collectWeighted	(	double	value,
		double	weight
	)

overridevirtual

Collects one observation with a given weight. Throws an error, as cPSquare does not support weighted statistics.

Reimplemented from cStdDev.

◆ getNumBins()

virtual int getNumBins ( ) const

overridevirtual

Returns the number of bins used.

Implements cAbstractHistogram.

◆ getBinEdge()

virtual double getBinEdge ( int k ) const

overridevirtual

Returns the kth bin boundary. Note that because of the P2 algorithm, bin boundaries are shifting during data collection, thus getBinValue() and other methods based on getBinValue() and getBinEdge() return approximate values.

Implements cAbstractHistogram.

◆ getBinValue()

virtual double getBinValue ( int k ) const

overridevirtual

Returns the number of observations in the kth histogram bin.

Implements cAbstractHistogram.

◆ getNumUnderflows()

virtual int64_t getNumUnderflows ( ) const

inlineoverridevirtual

Returns number of observations that were below the histogram range, independent of their weights. In cPSquare, this is always the same as the number of negative infinities.

Implements cAbstractHistogram.

◆ getNumOverflows()

virtual int64_t getNumOverflows ( ) const

inlineoverridevirtual

Returns number of observations that were above the histogram range, independent of their weights. In cPSquare, this is always the same as the number of positive infinities.

Implements cAbstractHistogram.

◆ getUnderflowSumWeights()

virtual double getUnderflowSumWeights ( ) const

inlineoverridevirtual

Returns the total weight of the observations that were below the histogram range. In cPSquare, this is always the same as the number of negative infinities.

Implements cAbstractHistogram.

◆ getOverflowSumWeights()

virtual double getOverflowSumWeights ( ) const

inlineoverridevirtual

Returns the total weight of the observations that were above the histogram range. In cPSquare, this is always the same as the number of positive infinities.

Implements cAbstractHistogram.

◆ getNumNegInfs()

virtual int64_t getNumNegInfs ( ) const

inlineoverridevirtual

Returns number of observations that were negative infinity, independent of their weights.

Implements cAbstractHistogram.

◆ getNumPosInfs()

virtual int64_t getNumPosInfs ( ) const

inlineoverridevirtual

Returns number of observations that were positive infinity, independent of their weights.

Implements cAbstractHistogram.

◆ getNegInfSumWeights()

virtual double getNegInfSumWeights ( ) const

inlineoverridevirtual

Returns the total weight of the observations that were negative infinity. Since cPSquare does not support weighted statistics, this is always the same as the number of observations that were negative infinity.

Implements cAbstractHistogram.

◆ getPosInfSumWeights()

virtual double getPosInfSumWeights ( ) const

inlineoverridevirtual

Returns the total weight of the observations that were positive infinity. Since cPSquare does not support weighted statistics, this is always the same as the number of observations that were positive infinity.

Implements cAbstractHistogram.

◆ draw()

virtual double draw ( ) const

overridevirtual

Generates a random number based on the collected data.

Reimplemented from cAbstractHistogram.

◆ merge()

virtual void merge ( const cStatistic * other )

overridevirtual

Merging is not supported by this class. This method throws an error.

Reimplemented from cStdDev.

◆ clear()

virtual void clear ( )

overridevirtual

Clears the results collected so far.

Reimplemented from cStdDev.

◆ saveToFile()

virtual void saveToFile ( FILE * ) const

overridevirtual

Writes the contents of the object into a text file.

Reimplemented from cStdDev.

◆ loadFromFile()

virtual void loadFromFile ( FILE * )

overridevirtual

Reads the object data from a file, in the format written out by saveToFile().

Reimplemented from cStdDev.

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

cpsquare.h

Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ cPSquare() [1/2]

◆ cPSquare() [2/2]

◆ ~cPSquare()

Member Function Documentation

◆ operator=()

◆ dup()

◆ parsimPack()

◆ parsimUnpack()

◆ binsAlreadySetUp()

◆ setUpBins()

◆ collect()

◆ collectWeighted()

◆ getNumBins()

◆ getBinEdge()

◆ getBinValue()

◆ getNumUnderflows()

◆ getNumOverflows()

◆ getUnderflowSumWeights()

◆ getOverflowSumWeights()

◆ getNumNegInfs()

◆ getNumPosInfs()

◆ getNegInfSumWeights()

◆ getPosInfSumWeights()

◆ draw()

◆ merge()

◆ clear()

◆ saveToFile()

◆ loadFromFile()