cPrecollectionBasedDensityEst Class Reference¶

Constants for histogram range_mode.

Copy constructor.

References cAbstractHistogram::cAbstractHistogram(), and cPrecollectionBasedDensityEst().

Referenced by cPrecollectionBasedDensityEst(), and operator=().

Constructor.

Destructor.

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

References cPrecollectionBasedDensityEst().

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

Reimplemented from cStdDev.

Reimplemented in cKSplit.

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

Reimplemented from cStdDev.

Reimplemented in cKSplit.

Collects one value. In the precollection phase, this method simply adds the value to the table of pre-collected values. When the number of pre-collected observations reaches a limit, the setUpBins() method is called. After transformation, it calls collectIntoHistogram() to update the stored statistics with this value.

Reimplemented from cStdDev.

References cStatistic::collect().

Collects one observation with a given weight. The weight must not be negative. (Zero-weight observations are allowed, but will not affect mean and stddev.)

Reimplemented from cStdDev.

References cStatistic::collectWeighted().

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 not a cPrecollectionBasedDensityEst.

Reimplemented from cStdDev.

Reimplemented in cKSplit.

Clears the results collected so far.

Reimplemented from cStdDev.

Reimplemented in cKSplit.

Writes the contents of the object into a text file.

Reimplemented from cStdDev.

Reimplemented in cKSplit.

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

Reimplemented from cStdDev.

Reimplemented in cKSplit.

Sets the histogram range explicitly to [lower, upper]. When this method is used, setNumPrecollectedValues() is not needed.

Selects a histogram range setup method where the range will be determined entirely from a set of pre-collected values.

When called, the histogram range will be determined from the first numPrecollect values, extending their range symmetrically by rangeExtensionFactor. For example, after a call to setRangeAuto(100, 1.3), the histogram will be set up after pre-collecting 100 values, the range being the range of the 100 pre-collected values extended 1.3 times symmetrically.

Selects a histogram range setup method where the upper bound of the range is fixed and the lower bound is determined from a set of pre-collected values.

The lower bound is calculated by extending the range (minimum of observations, upper) rangeExtensionFactor times.

Selects a histogram range setup method where the lower bound of the range is fixed and the upper bound is determined from a set of pre-collected values.

The upper bound is calculated by extending the range (lower, maximum of observations) rangeExtensionFactor times.

Sets the number of values to be pre-collected before transformation takes place. See setUpBins().

Returns the number of values to be pre-collected before transformation takes place. See setUpBins().

Returns the range extension factor, used with histogram range setup. See setRangeAuto() and setUpBins().

Called internally by setUpBins(), this method should determine and set up the histogram range, based on the pre-collected data and the range setup method selected by calls to the setRange(), setRangeAuto(), setRangeAutoLower(), setRangeAutoUpper() methods.

Called internally by collect(), this method collects a value after the histogram bins have been set up. Updating the underflow/overflow bins must be handled within this function. This is a pure virtual function; it must be redefined in subclasses.

Implemented in cKSplit.

Called internally by collect(), this method collects a value after the histogram bin have been set up. Updating the underflow/overflow bins must be handled within this function. This is a pure virtual function; it must be redefined in subclasses.

Implemented in cKSplit.

Returns true if the histogram bins have already been set up. See setUpBins().

Implements cAbstractHistogram.

Returns number of observations that were below the histogram range, independent of their weights.

Implements cAbstractHistogram.

Returns number of observations that were above the histogram range, independent of their weights.

Implements cAbstractHistogram.

Returns the total weight of the observations that were below the histogram range.

Implements cAbstractHistogram.

Returns the total weight of the observations that were above the histogram range.

Implements cAbstractHistogram.

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

Implements cAbstractHistogram.

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

Implements cAbstractHistogram.

Returns the total weight of the observations that were negative infinity.

Implements cAbstractHistogram.

Returns the total weight of the observations that were positive infinity.

Implements cAbstractHistogram.

Convenience method, delegates to collect(double).

Reimplemented from cStatistic.

Convenience method, delegates to collectWeighted(double, double).

Reimplemented from cStatistic.

Convenience method, delegates to collectWeighted(double, double).

Reimplemented from cStatistic.

Convenience method, delegates to collectWeighted(double, double).

Reimplemented from cStatistic.