CNStatistics -- Abstract Statistics Base Class

SYNOPSIS

#include <CNCL/Statistics.h>

TYPE

CN_STATISTICS

BASE CLASSES

CNObject

DERIVED CLASSES

CNMoments, CNLRE, CNDLRE, CNBatches

RELATED CLASSES

None

DESCRIPTION

CNStatistics is the base class of all statistics classes. It defines the common interface.

Constructors:

CNStatistics(const char* aName = NIL, const char* aDescription = NIL);

CNStatistics(CNParam *param);

Initializes CNStatistics. Optionally, you can specify aName and aDescription of the statistical evaluator.

The evaluation phases and types supported by CNStatistics are:

enum Phase { INITIALIZE=0, ITERATE=1, END=2 };

Different phases of a statistical evaluation with their settings.

enum Type { DF=0, CDF=1, PF=2 };

DF as distribution function, CDF as complementary distribution function and PF as probability function.

In addition to the member functions required by CNCL, CNStatistics provides:

virtual void put( double ) = 0;

Input of a value for statistical evaluation.

virtual double mean() const = 0;

Returns the mean value of the input sequence.

virtual double variance() const = 0;

Returns the variance of the input sequence.

virtual long trials() const = 0;

Returns the number of evaluated values.

virtual double min() const = 0;

Returns the minimum of all evaluated values.

virtual double max() const = 0;

Returns the maximum of all evaluated values.

virtual bool end() const = 0;

Returns TRUE if end of evaluation is reached else FALSE.
NOTE: In case of a CNMoments evaluation, the return value is always FALSE.

virtual void reset() = 0;

Resets the evaluation.

virtual Phase status() const = 0;

Returns the state of evaluation;

Go to the first, previous, next, last section, table of contents.