Parallel Colt 0.7.2

hep.aida.tdouble.ref
Class DoubleVariableAxis

java.lang.Object
  extended by hep.aida.tdouble.ref.DoubleVariableAxis
All Implemented Interfaces:
DoubleIAxis, Serializable

public class DoubleVariableAxis
extends Object
implements DoubleIAxis

Variable-width axis; A reference implementation of hep.aida.IAxis.

Version:
1.0, 23/03/2000
Author:
Wolfgang Hoschek, Tony Johnson, and others.
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface hep.aida.tdouble.DoubleIAxis
serialVersionUID
 
Constructor Summary
DoubleVariableAxis(double[] edges)
          Constructs and returns an axis with the given bin edges.
 
Method Summary
 double binCentre(int index)
          Centre of the bin specified.
 double binLowerEdge(int index)
          Lower edge of the specified bin.
 int bins()
          The number of bins (excluding underflow and overflow) on the axis.
 double binUpperEdge(int index)
          Upper edge of the specified bin.
 double binWidth(int index)
          Width of the bin specified.
 int coordToIndex(double coord)
          Converts a coordinate on the axis to a bin number.
 double lowerEdge()
          Lower axis edge.
 double upperEdge()
          Upper axis edge.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DoubleVariableAxis

public DoubleVariableAxis(double[] edges)
Constructs and returns an axis with the given bin edges. Example: edges = (0.2, 1.0, 5.0) yields an axis with 2 in-range bins [0.2,1.0), [1.0,5.0) and 2 extra bins [-inf,0.2), [5.0,inf].

Parameters:
edges - the bin boundaries the partition shall have; must be sorted ascending and must not contain multiple identical elements.
Throws:
IllegalArgumentException - if edges.length < 1.
Method Detail

binCentre

public double binCentre(int index)
Description copied from interface: DoubleIAxis
Centre of the bin specified.

Specified by:
binCentre in interface DoubleIAxis
Parameters:
index - Bin number (0...bins()-1) or OVERFLOW or UNDERFLOW.

binLowerEdge

public double binLowerEdge(int index)
Description copied from interface: DoubleIAxis
Lower edge of the specified bin.

Specified by:
binLowerEdge in interface DoubleIAxis
Parameters:
index - Bin number (0...bins()-1) or OVERFLOW or UNDERFLOW.
Returns:
the lower edge of the bin; for the underflow bin this is Double.NEGATIVE_INFINITY.

bins

public int bins()
Description copied from interface: DoubleIAxis
The number of bins (excluding underflow and overflow) on the axis.

Specified by:
bins in interface DoubleIAxis

binUpperEdge

public double binUpperEdge(int index)
Description copied from interface: DoubleIAxis
Upper edge of the specified bin.

Specified by:
binUpperEdge in interface DoubleIAxis
Parameters:
index - Bin number (0...bins()-1) or OVERFLOW or UNDERFLOW.
Returns:
the upper edge of the bin; for the overflow bin this is Double.POSITIVE_INFINITY.

binWidth

public double binWidth(int index)
Description copied from interface: DoubleIAxis
Width of the bin specified.

Specified by:
binWidth in interface DoubleIAxis
Parameters:
index - Bin number (0...bins()-1) or OVERFLOW or UNDERFLOW.

coordToIndex

public int coordToIndex(double coord)
Description copied from interface: DoubleIAxis
Converts a coordinate on the axis to a bin number. If the coordinate is < lowerEdge returns UNDERFLOW, and if the coordinate is >= upperEdge returns OVERFLOW.

Specified by:
coordToIndex in interface DoubleIAxis

lowerEdge

public double lowerEdge()
Description copied from interface: DoubleIAxis
Lower axis edge.

Specified by:
lowerEdge in interface DoubleIAxis

upperEdge

public double upperEdge()
Description copied from interface: DoubleIAxis
Upper axis edge.

Specified by:
upperEdge in interface DoubleIAxis

Parallel Colt 0.7.2

Jump to the Parallel Colt Homepage