hep.aida.tfloat.FloatIHistogram1D Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of parallelcolt Show documentation

Parallel Colt is a multithreaded version of Colt - a library for high performance scientific computing in Java. It contains efficient algorithms for data analysis, linear algebra, multi-dimensional arrays, Fourier transforms, statistics and histogramming.

The newest version!

package hep.aida.tfloat;

/**
 * A Java interface corresponding to the AIDA 1D Histogram.
 * 
 * Note All methods that accept a bin number as an argument will also
 * accept the constants OVERFLOW or UNDERFLOW as the argument, and as a result
 * give the contents of the resulting OVERFLOW or UNDERFLOW bin.
 * 
 * @see AIDA
 * @author Pavel Binko, Dino Ferrero Merlino, Wolfgang Hoschek, Tony Johnson,
 *         Andreas Pfeiffer, and others.
 * @version 1.0, 23/03/2000
 */
public interface FloatIHistogram1D extends FloatIHistogram {
    /**
     * Number of entries in the corresponding bin (ie the number of times fill
     * was called for this bin).
     * 
     * @param index
     *            the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
     */
    public int binEntries(int index);

    /**
     * The error on this bin.
     * 
     * @param index
     *            the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
     */
    public float binError(int index);

    /**
     * Total height of the corresponding bin (ie the sum of the weights in this
     * bin).
     * 
     * @param index
     *            the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
     */
    public float binHeight(int index);

    /**
     * Fill histogram with weight 1.
     */
    public void fill(float x);

    /**
     * Fill histogram with specified weight.
     */
    public void fill(float x, float weight);

    /**
     * Fill histogram with specified data and weight 1.
     */
    public void fill_2D(final float[] data, final int rows, final int columns, final int zero, final int rowStride,
            final int columnStride);

    /**
     * Fill histogram with specified data and weights.
     */
    public void fill_2D(final float[] data, final float[] weights, final int rows, final int columns, final int zero,
            final int rowStride, final int columnStride);

    /**
     * Returns the mean of the whole histogram as calculated on filling-time.
     */
    public float mean();

    /**
     * Indexes of the in-range bins containing the smallest and largest
     * binHeight(), respectively.
     * 
     * @return {minBin,maxBin}.
     */
    public int[] minMaxBins();

    /**
     * Returns the rms of the whole histogram as calculated on filling-time.
     */
    public float rms();

    /**
     * Returns the X Axis.
     */
    public FloatIAxis xAxis();
}