Histogram
Histogram

Represents a Histogram object.

Functions
Histogram
Histogram(
const Value &binsStart,
const Value &binsSize
)

Creates a Histogram object with no bins.

Parameters
Variables
m_binsStart
Value m_binsStart

The value of the start of the first Bin in the Histogram.

m_binsSize
Value m_binsSize

The size of each Bin in the Histogram.

m_bins
Bins m_bins

The Bins that are contained within this Histogram.

Functions
binsStart
Value binsStart() const

Gets the value of the start of the first Bin in the Histogram.

Returns

The start of the first Bin in the Histogram.

binsSize
Value binsSize() const

Gets the size of each Bin in the Histogram.

Returns

The size of each Bin in the Histogram.

bins
Bins bins() const

Gets the Bins contained within this Histogram.

Returns

A Bins object containing each bin within this Histogram.

addBin
void addBin(
const Bin &bin
)

Adds a single Bin to the Histogram.  The first Bin's start value should match the binsStart used in the constructor.  Every Bin added should have the same size which matches the binsSize used in the constructor.

Parameters
bin
const Bin&

The Bin to add to the Histogram.