cHistogram Class Reference¶

Histogram mode. In INTEGERS mode, bin edges are whole numbers; in REALS mode they can be real numbers.

This constructor installs a cDefaultHistogramStrategy on the histogram. To create a histogram without a strategy object, use the constructor that takes a 'strategy' parameter and pass nullptr for it.

Referenced by cHistogram(), dup(), and operator=().

This convenience constructor installs a cDefaultHistogramStrategy with the desired number of bins on the histogram.

Constructor that allows one to install a histogram strategy on the histogram. It is also legal to pass nullptr as strategy.

Copy constructor.

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

Destructor.

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

References cHistogram().

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

Reimplemented from cAbstractHistogram.

References cHistogram().

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

Reimplemented from cStdDev.

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

Reimplemented from cStdDev.

Collects one observation. Delegates to the strategy object if there is one installed.

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, nor the bin values.) This methods delegates to the strategy object if there is one installed.

Reimplemented from cStdDev.

References cStatistic::collectWeighted().

Clears the results collected so far.

Reimplemented from cStdDev.

Writes the contents of the object into a text file.

Reimplemented from cStdDev.

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

Reimplemented from cStdDev.

Merge another statistics object into this one.

Reimplemented from cStdDev.

Installs a new histogram strategy, replacing the current one, taking ownership of 'setupStrategy'. Can only be called while the histogram is empty.

Returns a pointer to the currently used histogram strategy.

Returns true if histogram bins are already available. (Bins are not yet available in the precollection phase.) See setUpBins().

Implements cAbstractHistogram.

Sets up histogram bins using the installed strategy (see cIHistogramStrategy). The histogram strategy class may use precollection to gather information for laying out the bins.

Implements cAbstractHistogram.

Configures a histogram with bins defined by 'edges'. Can only be called once, and only when there are no bins defined. 'edges' must contain at least two values, and it must be strictly increasing.

Sets the histogram up to have bins covering the range from 'lo' to 'hi', each bin being 'step' wide. Can only be called on a histogram without bins. 'lo' will always be added as an edge, all bins will be 'step' wide, and the last bin edge will be at or above 'hi'.

Extends the histogram to the left with some bins, as delimited by 'edges'. This can only be used if there is at least one bin already, and there are no underflows. 'edges' must not be empty, it must be strictly increasing, and its last value must be less than the first already existing bin edge.

Extends the histogram to the right with some bins, as delimited by 'edges'. This can only be used if there is at least one bin already, and there are no overflows. 'edges' must not be empty, it must be strictly increasing, and its first value must be greater than the last already existing bin edge.

Makes sure that 'value' will fall in the range covered by the bins, by potentially extending the histogram with some bins of width 'step'. Creation of new bins stops when either the total number of bins reaches 'maxNumBins', or 'value' is covered by the histogram. If 'value' is already in the range of the existing bins, the function does nothing. This method may only be called when there are no over- or underflows. 'step' must be positive.

Reduces the number of bins by merging each 'groupSize' consecutive bins into one. The number of bins must be a multiple of 'groupSize'. If that is not the case, extendBinsTo() or similar methods may be used to create extra empty bins before calling this function.

Returns the bin edges of the histogram. There is always one more edge than bin, except when the histogram has not been set up yet, in which case both are zero.

Reimplemented from cAbstractHistogram.

Returns the bin values of the histogram. There is always one less bin than edge, except when the histogram has not been set up yet, in which case both are zero.

Reimplemented from cAbstractHistogram.

Returns the number of bins in the histogram.

Implements cAbstractHistogram.

Returns the k'th bin edge of the histogram. The k'th bin is delimited by the edge k and k+1.

Implements cAbstractHistogram.

Returns the total weight of the observations in the k'th bin of the histogram. (In the unweighted case, every observation is regarded as having the weight 1.0.)

Implements cAbstractHistogram.

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

Implements cAbstractHistogram.

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

Implements cAbstractHistogram.

Returns the number of observations that were under the histogram range. This value is only collected for unweighted statistics, i.e. it is an error to call this method on a weighted histogram.

Implements cAbstractHistogram.

Returns the number of observations that were under the histogram range. This value is only collected for unweighted statistics, i.e. it is an error to call this method on a weighted histogram.

Implements cAbstractHistogram.

Returns number of observations that were negative infinity, independent of their weights. This value is only collected for unweighted statistics, i.e. it is an error to call this method on a weighted histogram.

Implements cAbstractHistogram.

Returns number of observations that were positive infinity, independent of their weights. This value is only collected for unweighted statistics, i.e. it is an error to call this method on a weighted histogram.

Implements cAbstractHistogram.

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

Implements cAbstractHistogram.

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

Implements cAbstractHistogram.

Sets the histogram mode: MODE_AUTO, MODE_INTEGERS or MODE_DOUBLES. Cannot be called when the bins have been set up already. This method internally installs (or uses an already installed) cAutoRangeHistogramStrategy on the histogram, and configures it accordingly.

Sets the histogram range explicitly to [lower, upper). Use NAN to leave either or both values unspecified. This method internally installs (or uses an already installed) cAutoRangeHistogramStrategy on the histogram, and configures it accordingly.

Sets the number of observations to collect before setting up histogram bins. This method internally installs (or uses an already installed) cAutoRangeHistogramStrategy on the histogram, and configures it accordingly.

Sets the factor by which the range of the precollected observations is multiplied for determining the range of the histogram bins. This method internally installs (or uses an already installed) cAutoRangeHistogramStrategy on the histogram, and configures it accordingly.

When set to true, observations that fall outside of the histogram range will cause the histogram to be extended with new bins, instead of being collected as outliers. This method internally installs (or uses an already installed) cAutoRangeHistogramStrategy on the histogram, and configures it accordingly.

Sets the preferred number of bins. Cannot be called when the bins have been set up already. This method internally installs (or uses an already installed) cAutoRangeHistogramStrategy on the histogram, and configures it accordingly.

Sets the preferred bin size. Cannot be called when the bins have been set up already. This method internally installs (or uses an already installed) cAutoRangeHistogramStrategy on the histogram, and configures it accordingly.