KSLCore/ksl.utilities.statistic/HistogramPlotDataIfc

HistogramPlotDataIfc

interface HistogramPlotDataIfc(source)

Minimal data contract required by HistogramPlot to render a histogram.

All four arrays must be the same length, indexed in ascending bin order: element i of lowerLimits, upperLimits, binCounts, and binFractions all refer to the same bin.

In-memory Histogram instances satisfy this naturally (bins are built in order).
Database implementations must sort source rows by bin_num before populating these arrays; DbHistogramPlotData does this automatically in its constructor.

HistogramIfc extends this interface, so any existing HistogramIfc instance is a valid HistogramPlotDataIfc without modification.

Inheritors

DbHistogramPlotData

Properties

abstract val binCounts: DoubleArray

Raw count of observations in each bin.

abstract val binFractions: DoubleArray

Proportion of observations in each bin (counts divided by total).

abstract val lowerLimits: DoubleArray

Lower boundary of each bin, in ascending order.

abstract val max: Double

Maximum observed value. Used by HistogramPlot to substitute a concrete upper bound when upperLimits.last() is infinite.

abstract val min: Double

Minimum observed value. Used by HistogramPlot to substitute a concrete lower bound when lowerLimits.first() is infinite.

abstract val upperLimits: DoubleArray

Upper boundary of each bin, in ascending order.