Package etomica.data.histogram

Interface Histogram

All Known Implementing Classes:

HistogramCollapsing, HistogramDiscrete, HistogramExpanding, HistogramNotSoSimple, HistogramReweightedData, HistogramSimple

public interface Histogram

Interface for a class that can tabulate a one-dimensional histogram of data values.

Method Summary

Modifier and Type	Method	Description
void	addValue(double x)	Adds the given value to the Histogram
long	getCount()	Returns the number of times the Histogram's addValue method was called.
double[]	getHistogram()	Returns the histogram as an array of doubles
int	getNBins()	Returns the number of bins in the histogram.
DoubleRange	getXRange()	Returns the range of x values (min and max) used in the histogram.
void	reset()	resets all histogram values and counts to zero
void	setNBins(int n)	Sets the number of bins used by the Histogram.
void	setXRange(DoubleRange range)	Sets the range of x values used in the histogram (min and max).
double[]	xValues()	Returns the x values from the histogram as an array of doubles

Method Detail

addValue

void addValue(double x)

Adds the given value to the Histogram

getHistogram

double[] getHistogram()

Returns the histogram as an array of doubles

xValues

double[] xValues()

Returns the x values from the histogram as an array of doubles

getCount

long getCount()

Returns the number of times the Histogram's addValue method was called.

setNBins

void setNBins(int n)

Sets the number of bins used by the Histogram. The existing histogram may be dropped or redistributed to the new bins.

getNBins

int getNBins()

Returns the number of bins in the histogram.

setXRange

void setXRange(DoubleRange range)

Sets the range of x values used in the histogram (min and max). The existing histogram may be dropped or redistributed to the new bins.

getXRange

DoubleRange getXRange()

Returns the range of x values (min and max) used in the histogram.

reset

void reset()

resets all histogram values and counts to zero