Package etomica.data.histogram

Class HistogramDiscrete

java.lang.Object

etomica.data.histogram.HistogramDiscrete

All Implemented Interfaces:

Histogram

public class HistogramDiscrete
extends java.lang.Object
implements Histogram

Histogram class capable of keeping track of how many times each discrete value was passed in, similar to what one would expect from a histogram with very small bin width. Two incoming values are judged to be the same if they are within some tolerance, which is specified at construction. The returned histogram is then the (raw) probability with which each value was seen.

Field Summary

Fields

Modifier and Type	Field	Description
protected long[]	counts
protected double[]	histogram
protected double	tolerance
protected long	totalCount
protected double[]	xValues

Constructor Summary

Constructors

Constructor	Description
HistogramDiscrete(double tolerance)

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

totalCount

protected long totalCount

tolerance

protected double tolerance

xValues

protected double[] xValues

counts

protected long[] counts

histogram

protected double[] histogram

Constructor Detail

HistogramDiscrete

public HistogramDiscrete(double tolerance)

Method Detail

addValue

public void addValue(double x)

Description copied from interface: Histogram

Adds the given value to the Histogram

Specified by:

addValue in interface Histogram

getCount

public long getCount()

Description copied from interface: Histogram

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

Specified by:

getCount in interface Histogram

getHistogram

public double[] getHistogram()

Description copied from interface: Histogram

Returns the histogram as an array of doubles

Specified by:

getHistogram in interface Histogram

getNBins

public int getNBins()

Description copied from interface: Histogram

Returns the number of bins in the histogram.

Specified by:

getNBins in interface Histogram

getXRange

public DoubleRange getXRange()

Description copied from interface: Histogram

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

Specified by:

getXRange in interface Histogram

reset

public void reset()

Description copied from interface: Histogram

resets all histogram values and counts to zero

Specified by:

reset in interface Histogram

setNBins

public void setNBins(int n)

Description copied from interface: Histogram

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

Specified by:

setNBins in interface Histogram

setXRange

public void setXRange(DoubleRange range)

Description copied from interface: Histogram

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.

Specified by:

setXRange in interface Histogram

xValues

public double[] xValues()

Description copied from interface: Histogram

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

Specified by:

xValues in interface Histogram