hep.aida.bin
Class BinFunctions1D

java.lang.Object
  extended by hep.aida.bin.BinFunctions1D

public class BinFunctions1D
extends java.lang.Object

Function objects computing dynamic bin aggregations; to be passed to generic methods.

Author:
wolfgang.hoschek@cern.ch
See Also:
Formatter, Statistic

Field Summary
static BinFunctions1D functions
          Little trick to allow for "aliasing", that is, renaming this class.
static BinFunction1D geometricMean
          Function that returns bin.geometricMean().
static BinFunction1D max
          Function that returns bin.max().
static BinFunction1D mean
          Function that returns bin.mean().
static BinFunction1D median
          Function that returns bin.median().
static BinFunction1D min
          Function that returns bin.min().
static BinFunction1D rms
          Function that returns bin.rms().
static BinFunction1D size
          Function that returns bin.size().
static BinFunction1D stdDev
          Function that returns bin.standardDeviation().
static BinFunction1D sum
          Function that returns bin.sum().
static BinFunction1D sumLog
          Function that returns bin.sumOfLogarithms().
 
Constructor Summary
protected BinFunctions1D()
          Makes this class non instantiable, but still let's others inherit from it.
 
Method Summary
static BinFunction1D quantile(double percentage)
          Function that returns bin.quantile(percentage).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

functions

public static final BinFunctions1D functions
Little trick to allow for "aliasing", that is, renaming this class. Using the aliasing you can instead write

BinFunctions F = BinFunctions.functions;
someAlgo(F.max);


max

public static final BinFunction1D max
Function that returns bin.max().


mean

public static final BinFunction1D mean
Function that returns bin.mean().


median

public static final BinFunction1D median
Function that returns bin.median().


min

public static final BinFunction1D min
Function that returns bin.min().


rms

public static final BinFunction1D rms
Function that returns bin.rms().


size

public static final BinFunction1D size
Function that returns bin.size().


stdDev

public static final BinFunction1D stdDev
Function that returns bin.standardDeviation().


sum

public static final BinFunction1D sum
Function that returns bin.sum().


sumLog

public static final BinFunction1D sumLog
Function that returns bin.sumOfLogarithms().


geometricMean

public static final BinFunction1D geometricMean
Function that returns bin.geometricMean().

Constructor Detail

BinFunctions1D

protected BinFunctions1D()
Makes this class non instantiable, but still let's others inherit from it.

Method Detail

quantile

public static BinFunction1D quantile(double percentage)
Function that returns bin.quantile(percentage).

Parameters:
the - percentage of the quantile (0 <= percentage <= 1).