cern.jet.stat.tfloat.quantile.FloatQuantileFinder 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!
/*
Copyright (C) 1999 CERN - European Organization for Nuclear Research.
Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose 
is hereby granted without fee, provided that the above copyright notice appear in all copies and 
that both that copyright notice and this permission notice appear in supporting documentation. 
CERN makes no representations about the suitability of this software for any purpose. 
It is provided "as is" without expressed or implied warranty.
 */
package cern.jet.stat.tfloat.quantile;

import cern.colt.list.tfloat.FloatArrayList;

/**
 * The interface shared by all quantile finders, no matter if they are exact or
 * approximate. It is usually completely sufficient to operate on this interface
 * only. Also see {@link hep.aida.tfloat.bin.QuantileFloatBin1D}, demonstrating
 * how this package can be used.
 */
public interface FloatQuantileFinder extends java.io.Serializable {
    // public interface FloatQuantileFinder extends
    // com.objy.db.iapp.PersistentEvents, java.io.Serializable {
    /**
     * Adds a value to the receiver.
     * 
     * @param value
     *            the value to add.
     */
    public void add(float value);

    /**
     * Adds all values of the specified list to the receiver.
     * 
     * @param values
     *            the list of which all values shall be added.
     */
    public void addAllOf(cern.colt.list.tfloat.FloatArrayList values);

    /**
     * Adds the part of the specified list between indexes from
     * (inclusive) and to (inclusive) to the receiver.
     * 
     * @param values
     *            the list of which elements shall be added.
     * @param from
     *            the index of the first element to be added (inclusive).
     * @param to
     *            the index of the last element to be added (inclusive).
     */
    public void addAllOfFromTo(FloatArrayList values, int from, int to);

    /**
     * Removes all elements from the receiver. The receiver will be empty after
     * this call returns, and its memory requirements will be close to zero.
     */
    public void clear();

    /**
     * Returns a deep copy of the receiver.
     * 
     * @return a deep copy of the receiver.
     */
    public abstract Object clone();

    /**
     * Applies a procedure to each element of the receiver, if any. Iterates
     * over the receiver in no particular order.
     * 
     * @param procedure
     *            the procedure to be applied. Stops iteration if the procedure
     *            returns false, otherwise continues.
     * @return false if the procedure stopped before all elements where
     *         iterated over, true otherwise.
     */
    public boolean forEach(cern.colt.function.tfloat.FloatProcedure procedure);

    /**
     * Returns the number of elements currently needed to store all contained
     * elements. This number usually differs from the results of method
     * size(), according to the underlying datastructure.
     */
    public long memory();

    /**
     * Returns how many percent of the elements contained in the receiver are
     * <= element. Does linear interpolation if the element is not
     * contained but lies in between two contained elements.
     * 
     * Writing a wrapper is a good idea if you can think of better ways of doing
     * interpolation. Same if you want to keep min,max and other such measures.
     * 
     * @param element
     *            the element to search for.
     * @return the percentage p of elements <= element (
     *         0.0 <= p <=1.0).
     */
    public float phi(float element);

    /**
     * Computes the specified quantile elements over the values previously
     * added.
     * 
     * @param phis
     *            the quantiles for which elements are to be computed. Each phi
     *            must be in the interval [0.0,1.0]. phis must be
     *            sorted ascending.
     * @return the quantile elements.
     */
    public FloatArrayList quantileElements(FloatArrayList phis);

    /**
     * Returns the number of elements currently contained in the receiver
     * (identical to the number of values added so far).
     */
    public long size();

    /**
     * Returns the number of elements currently needed to store all contained
     * elements. This number usually differs from the results of method
     * size(), according to the underlying datastructure.
     */
    public abstract long totalMemory();
}