Package etomica.data.histogram

Class HistogramExpanding

java.lang.Object

etomica.data.histogram.HistogramSimple

etomica.data.histogram.HistogramExpanding

All Implemented Interfaces:

Histogram

public class HistogramExpanding
extends HistogramSimple

Histogram implementation with dynamic x range and number of bins. If an x value is given that falls outside the histogram's x range, the x range expands to accomodate any values outside the current range maintaining the bin width at a fixed value. The number of bins and the X range can be set explicitly, but only if the change would not cause old data to be dropped. Unless one is given, there is no initial range. The first incoming piece of data sets the intial range.

See Also:

Serialized Form

Field Summary

Fields inherited from class etomica.data.histogram.HistogramSimple

counts, deltaX, histogram, nBins, sum, xMax, xMin, xValues

Constructor Summary

Constructors

Constructor	Description
HistogramExpanding()	Default constructor, making a histogram with deltaX = 1.0.
HistogramExpanding(double deltaX)	Constructs a new instance with the give deltaX bin width and no range.
HistogramExpanding(double deltaX, DoubleRange xRange)	Constructs a new instance with the given deltaX bin width and range of X values.
HistogramExpanding(int n, DoubleRange xRange)	Makes a new histogram instance, with n bins covering the given range of X values.

Method Summary

Modifier and Type	Method	Description
void	addValue(double x)	Adds the given value to the Histogram
double	getDeltaX()
void	reset()	resets all histogram values and counts to zero
void	setDeltaX(double dx)
void	setNBins(int n)	Sets the number of bins to n.
void	setXRange(DoubleRange xRange)	Sets the range of x values used in the histogram (min and max).

Methods inherited from class etomica.data.histogram.HistogramSimple

getBinCounts, getCount, getHistogram, getNBins, getXRange, xValues

Methods inherited from class java.lang.Object

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

Constructor Detail

HistogramExpanding

public HistogramExpanding()

Default constructor, making a histogram with deltaX = 1.0.

HistogramExpanding

public HistogramExpanding(double deltaX)

Constructs a new instance with the give deltaX bin width and no range.

HistogramExpanding

public HistogramExpanding(double deltaX,
                          DoubleRange xRange)

Constructs a new instance with the given deltaX bin width and range of X values.

HistogramExpanding

public HistogramExpanding(int n,
                          DoubleRange xRange)

Makes a new histogram instance, with n bins covering the given range of X values.

Method Detail

reset

public void reset()

Description copied from interface: Histogram

resets all histogram values and counts to zero

Specified by:

reset in interface Histogram

Overrides:

reset in class HistogramSimple

addValue

public void addValue(double x)

Description copied from interface: Histogram

Adds the given value to the Histogram

Specified by:

addValue in interface Histogram

Overrides:

addValue in class HistogramSimple

setXRange

public void setXRange(DoubleRange xRange)

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

Overrides:

setXRange in class HistogramSimple

setNBins

public void setNBins(int n)

Sets the number of bins to n. Adds or removes bins from the end of the X range. For more flexibility, call setXRange directly.

Specified by:

setNBins in interface Histogram

Overrides:

setNBins in class HistogramSimple

getDeltaX

public double getDeltaX()

setDeltaX

public void setDeltaX(double dx)