#include <chistogramstrategy.h>
Description
A generic, very configurable histogram strategy that is meant to provide a good quality histogram for practical distributions, and creates uniform bins. This strategy uses precollection to gather input information about the distribution before setting up the bins.
Several parameters and constraints can be specified for setting up the bins: range lower and/or upper endpoint, bin size, number of bins, mode (integers or reals), and whether bin size rounding is to be used. If bin size rounding is turned on, a bin size of the form {1|2|5}*10^n is chosen, i.e. a power of ten, or two or five times a power of ten. When both endpoints of the range are left unspecified, the histogram range is derived by taking the range of the precollected observations and extending it symmetrically by a range extension factor. If one of the endpoints is specified by the user, that value is used instead of the computed one. The number of observations to precollect as well as the range extension factor can be configured. If the histogram mode (integers vs. reals) is left unspecified, it will be determined by examining the precollected values. In integers mode, bin edges will be whole numbers. If the histogram range and mode are all specified by the user, the precollection phase is skipped.
If there are inconsistent or conflicting settings, e.g. an explicitly given histogram range is not multiple of the bin size in integers mode, the bin setup algorithm will do "best effort" to set up the histogram instead of stopping with an exception.
This histogram strategy can auto-extend the histogram range by adding new bins at either end. One can also set up an upper limit to the number of histogram bins to prevent it from growing indefinitely. Bin merging can also be enabled: it will cause every two (or N) adjacent bins to be merged to reduce the number of bins if their number grows too high.
Collected infinities are counted as underflows/overflows, and they do not affect the histogram layout in any way.
Public Member Functions | |
Constructors, copying. | |
| cAutoRangeHistogramStrategy (Mode mode=cHistogram::MODE_AUTO) | |
| cAutoRangeHistogramStrategy (int numBins, Mode mode=cHistogram::MODE_AUTO) | |
| cAutoRangeHistogramStrategy (const cAutoRangeHistogramStrategy &other) | |
| cAutoRangeHistogramStrategy & | operator= (const cAutoRangeHistogramStrategy &other) |
| virtual cAutoRangeHistogramStrategy * | dup () const override |
Configuring. | |
| void | setRangeHint (double lo, double hi) |
| Use NAN to leave either value unspecified. More... | |
| double | getUpperLimitHint () const |
| void | setUpperLimitHint (double hi) |
| double | getLowerLimitHint () const |
| void | setLowerLimitHint (double lo) |
| double | getRangeExtensionFactor () const |
| void | setRangeExtensionFactor (double rangeExtensionFactor) |
| Mode | getMode () const |
| void | setMode (Mode mode) |
| double | getBinSizeHint () const |
| void | setBinSizeHint (double binSize) |
| bool | getBinSizeRounding () const |
| void | setBinSizeRounding (bool binSizeRounding) |
| int | getNumBinsHint () const |
| void | setNumBinsHint (int numBins) |
| void | setAutoExtend (bool enable) |
| bool | getAutoExtend () const |
| void | setBinMerging (bool enable) |
| bool | getBinMerging () const |
| int | getMaxNumBins () const |
| void | setMaxNumBins (int numBins) |
Redefined cIHistogramStrategy methods. | |
| virtual void | collect (double value) override |
| virtual void | collectWeighted (double value, double weight) override |
| virtual void | clear () override |
 Public Member Functions inherited from cPrecollectionBasedHistogramStrategy | |
| cPrecollectionBasedHistogramStrategy () | |
| cPrecollectionBasedHistogramStrategy (const cPrecollectionBasedHistogramStrategy &other) | |
| cPrecollectionBasedHistogramStrategy & | operator= (const cPrecollectionBasedHistogramStrategy &other) |
| int | getNumToPrecollect () const |
| void | setNumToPrecollect (int numToPrecollect) |
| int | getNumToCollate () const |
| void | setNumToCollate (int numToCollate) |
| int | getRangeUnchangedThreshold () const |
| void | setRangeUnchangedThreshold (int threshold) |
| virtual void | setUpBins () override |
| Public Member Functions inherited from cIHistogramStrategy | |
| cIHistogramStrategy () | |
| cIHistogramStrategy (const cIHistogramStrategy &other) | |
| cIHistogramStrategy & | operator= (const cIHistogramStrategy &other) |
| void | setHistogram (cHistogram *hist) |
| cHistogram * | getHistogram () const |
| Public Member Functions inherited from cObject | |
| cObject () | |
| cObject (const cObject &other) | |
| virtual | ~cObject () |
| virtual const char * | getClassName () const |
| virtual const char * | getName () const |
| bool | isName (const char *s) const |
| virtual const char * | getFullName () const |
| virtual std::string | getFullPath () const |
| const cObject * | getThisPtr () const |
| virtual std::string | str () const |
| virtual _OPPDEPRECATED std::string | info () const |
| virtual _OPPDEPRECATED std::string | detailedInfo () const |
| virtual void | parsimPack (cCommBuffer *buffer) const |
| virtual void | parsimUnpack (cCommBuffer *buffer) |
| virtual cObject * | getOwner () const |
| virtual bool | isOwnedObject () const |
| virtual void | forEachChild (cVisitor *v) |
| cObject * | findObject (const char *name, bool deep=true) |
| void | copyNotSupported () const |
Additional Inherited Members | |
| Protected Member Functions inherited from cObject | |
| virtual void | take (cOwnedObject *obj) |
| virtual void | drop (cOwnedObject *obj) |
| void | dropAndDelete (cOwnedObject *obj) |
Member Function Documentation
◆ dup()
|
inlineoverridevirtual |
Should be redefined in subclasses to create an exact copy of this object. The default implementation just throws an error, to indicate that the method was not redefined.
Reimplemented from cObject.
◆ setRangeHint()
|
inline |
Use NAN to leave either value unspecified.
◆ collect()
|
overridevirtual |
Called from cHistogram's collect() method. Implementations are expected to call back cHistogram's collectIntoHistogram(), or if histogram bins are not yet set up, store it for later.
Implements cIHistogramStrategy.
◆ collectWeighted()
|
overridevirtual |
Called from cHistogram's collectWeighted() method. Implementations are expected to call back cHistogram's collectIntoHistogram(), or if histogram bins are not yet set up, store it for later.
Implements cIHistogramStrategy.
◆ clear()
|
overridevirtual |
Called from cHistogram's clear() method, to give the strategy object an opportunity to clear its state.
Reimplemented from cPrecollectionBasedHistogramStrategy.
The documentation for this class was generated from the following file:
