Application: gvSIG desktop

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.raster.lib.buffer.api.statistics;

/**

 * Clase que define un intervalo de datos. Es util para cosas como el calculo de

 * histogramas

 * con tipo de datos en coma flotante en el cual hay que dividir los intervalos

 * en

 * clases. Las clases se tendr?n en cuenta como un intervalo el cual el menor es

 * cerrado y el

 * mayor abierto, es decir

 * 

 * <PRE>

 * En las clases:

 * 0-1000

 * 1000-2000

 * los intervalos son

 * [0, 1000 [  de 0-999.9p

 * [1000, 2000[ de 1000-1999.9p

 * </PRE>

 *

 * @author Nacho Brodin (nachobrodin@gmail.com)

 *

 */

public interface HistogramClass extends Comparable<HistogramClass> {

    /**

     * Comprueba si el valor pasado por par?metro est? dentro del intervalo

     * 

     * @param value

     *            Valor a comprobar

     * @return true si est? dentro del intervalo y false si no lo est?

     */

    public boolean isIn(double value);

    /**

     * Obtiene el valor m?ximo de la clase

     * 

     * @return double que representa al valor m?ximo de la clase

     */

    public double getMax();

    /**

     * Asigna el valor m?ximo de la clase

     * 

     * @param max

     *            double que representa al valor m?ximo de la clase

     */

    public void setMax(double max);

    /**

     * Obtiene el valor m?nimo de la clase

     * 

     * @return double que representa al valor m?nimo de la clase

     */

    public double getMin();

    /**

     * ASigna el valor m?nimo de la clase

     * 

     * @param min

     *            double que representa al valor m?nimo de la clase

     */

    public void setMin(double min);

    /**

     * Obtiene el valor de la clase

     * 

     * @return long con el valor

     */

    public long getValue();

    /**

     * Asigna el valor de la clase

     * 

     * @param value

     *            con el valor

     */

    public void setValue(long value);

    /**

     * Incrementa en n el valor especificado

     * 

     * @param n

     */

    public void increment(long n);

}