MeanWalker
|
This class implements a one-dimensional histogram. More...
#include <histogram.h>
Inherited by meanwalker::DelayedHistogram.
Public Member Functions | |
bool | init (double minValue, double maxValue, size_t numBins) |
Initialize the histogram. | |
void | clear () |
Clears the values stored in the histogram (but does not clear the boundaries nor the number of bins). | |
void | destroy () |
Destroys the histogram - you'll need to call Histogram::init again to be able to use it. | |
void | process (double x) |
Processes the value x into the histogram. | |
double | getMinValue () const |
Returns the minimum boundary value that was specified during initialization. | |
double | getMaxValue () const |
Returns the maximum boundary value that was specified during initialization. | |
size_t | getNumberOfBins () const |
Returns the number of bins being used. | |
size_t | getBinCount (size_t bin) const |
Returns the number of values that were counted in the specified bin. | |
double | getProbabilityDensity (size_t bin) const |
Returns the probability density based on the count in the specified bin. | |
double | getInsideProbabilityDensity (size_t bin) const |
Returns the probability density based on the count in the specified bin while pretending that no samples were generated outside the histogram boundaries. | |
double | getBinCenter (size_t bin) const |
Returns the center coordinate of the specified bin. | |
double | getBinWidth () const |
Returns the width of each bin. | |
size_t | getTotalCount () const |
Returns the total number of values processed. | |
size_t | getOutsideCount () const |
Returns the processed number of values that fell outside the histogram boundaries. | |
size_t | getInsideCount () const |
Returns the processed number of values that fell inside the histogram boundaries. | |
void | print () const |
Print the histogram, or rather the probability distribution associated with the histogram. |
This class implements a one-dimensional histogram.
void meanwalker::Histogram::clear | ( | ) |
Clears the values stored in the histogram (but does not clear the boundaries nor the number of bins).
void meanwalker::Histogram::destroy | ( | ) |
Destroys the histogram - you'll need to call Histogram::init again to be able to use it.
double meanwalker::Histogram::getBinCenter | ( | size_t | bin | ) | const [inline] |
Returns the center coordinate of the specified bin.
size_t meanwalker::Histogram::getBinCount | ( | size_t | bin | ) | const [inline] |
Returns the number of values that were counted in the specified bin.
double meanwalker::Histogram::getBinWidth | ( | ) | const [inline] |
Returns the width of each bin.
size_t meanwalker::Histogram::getInsideCount | ( | ) | const [inline] |
Returns the processed number of values that fell inside the histogram boundaries.
double meanwalker::Histogram::getInsideProbabilityDensity | ( | size_t | bin | ) | const [inline] |
Returns the probability density based on the count in the specified bin while pretending that no samples were generated outside the histogram boundaries.
double meanwalker::Histogram::getMaxValue | ( | ) | const [inline] |
Returns the maximum boundary value that was specified during initialization.
double meanwalker::Histogram::getMinValue | ( | ) | const [inline] |
Returns the minimum boundary value that was specified during initialization.
size_t meanwalker::Histogram::getNumberOfBins | ( | ) | const [inline] |
Returns the number of bins being used.
size_t meanwalker::Histogram::getOutsideCount | ( | ) | const [inline] |
Returns the processed number of values that fell outside the histogram boundaries.
double meanwalker::Histogram::getProbabilityDensity | ( | size_t | bin | ) | const [inline] |
Returns the probability density based on the count in the specified bin.
size_t meanwalker::Histogram::getTotalCount | ( | ) | const [inline] |
Returns the total number of values processed.
bool meanwalker::Histogram::init | ( | double | minValue, |
double | maxValue, | ||
size_t | numBins | ||
) |
Initialize the histogram.
Initialize the histogram. The area between minValue
and maxValue
will be subdivided into numBins
bins.
void meanwalker::Histogram::print | ( | ) | const |
Print the histogram, or rather the probability distribution associated with the histogram.
Referenced by meanwalker::HistogramBuilderTemplate< MetropolisWalker >::printHistograms().
void meanwalker::Histogram::process | ( | double | x | ) | [inline] |
Processes the value x
into the histogram.