#include <cvarhist.h>
Inheritance diagram for cVarHistogram:
You may add cell (bin) boundaries manually, or .let the object create cells with equal number of observations in them (or as close to that as possible).
Transform types for cVarHistogram:
Layout of the variable bin width histogram:
underflow-cell ordinary cells . . . overflow-cell
...---------|-----------|- ... -|-----------------|---------...
| ^cellv[0] | cellv[num_cells-1]^|
n | | |
rangemin | rangemax
| bin_bounds[1] |
bin_bounds[0] bin_bounds[numcells]
Rangemin and rangemax is chosen after collecting the num_firstvals initial observations. It is not possible to add cell boundaries when histogram is already transformed.
Now we do support the following 2 uses of cVarHistogram:
Public Member Functions | |
Constructors, destructor, assignment. | |
cVarHistogram (const cVarHistogram &r) | |
cVarHistogram (const char *name=NULL, int numcells=11, int transformtype=HIST_TR_AUTO_EPC_DBL) | |
virtual | ~cVarHistogram () |
cVarHistogram & | operator= (const cVarHistogram &res) |
Redefined cObject member functions. | |
virtual cPolymorphic * | dup () const |
virtual void | netPack (cCommBuffer *buffer) |
virtual void | netUnpack (cCommBuffer *buffer) |
Redefined member functions from cStatistic and its subclasses. | |
virtual void | clearResult () |
virtual void | transform () |
virtual void | collectTransformed (double val) |
virtual double | random () const |
virtual double | pdf (double x) const |
virtual double | cdf (double x) const |
virtual double | basepoint (int k) const |
virtual double | cell (int k) const |
virtual void | saveToFile (FILE *) const |
virtual void | loadFromFile (FILE *) |
Setting up the histogram. | |
virtual void | addBinBound (double x) |
Protected Member Functions | |
void | createEquiProbableCells () |
|
Copy constructor.
|
|
Constructor. The third argument can be one of HIST_TR_NO_TRANSFORM, HIST_TR_AUTO_EPC_DBL, HIST_TR_AUTO_EPC_INT. With HIST_TR_NO_TRANSFORM, you can set up cells manually (see addBinBound()), in the other two cases it tries to create equiprobably cells. |
|
Destructor.
|
|
Adds a new bin (cell) boundary. This method can only be called if HIST_TR_NO_TRANSFORM was specified in the constructor call, and only when the object is still in the initial data collection phase (that is, transform() has been invoked yet). |
|
Returns the kth cell boundary.
Implements cDensityEstBase. |
|
Returns the value of the Cumulated Density Function at a given x.
Implements cDensityEstBase. |
|
Returns the number of observations that fell into the kth histogram cell.
Implements cDensityEstBase. |
|
Clears the results collected so far.
Reimplemented from cHistogramBase. |
|
Called internally by collect(), this method collects a value after the histogram has been transformed.
Implements cDensityEstBase. |
|
Used internally to create equiprobable cells from the precollected observations. This cannot be mixed with manually adding cell boundaries -- if there are already some, an error is raised. |
|
Creates and returns an exact copy of this object. See cObject for more details. Reimplemented from cStdDev. |
|
Reads the object data from a file, in the format written out by saveToFile().
Reimplemented from cHistogramBase. |
|
Serializes the object into a PVM or MPI send buffer. Used by the simulation kernel for parallel execution. See cObject for more details. Reimplemented from cHistogramBase. |
|
Deserializes the object from a PVM or MPI receive buffer Used by the simulation kernel for parallel execution. See cObject for more details. Reimplemented from cHistogramBase. |
|
Assignment operator. The name member doesn't get copied; see cObject's operator=() for more details. |
|
Returns the value of the Probability Density Function at a given x.
Implements cDensityEstBase. |
|
Generates a random number based on the collected data. Uses the random number generator set by setGenK(). Reimplemented from cStdDev. |
|
Writes the contents of the object into a text file.
Reimplemented from cHistogramBase. |
|
Transforms the table of precollected values into an internal histogram structure.
Reimplemented from cHistogramBase. |