de.lmu.ifi.dbs.jfeaturelib.utils

Class Histogram

java.lang.Object

de.lmu.ifi.dbs.jfeaturelib.utils.Histogram

public class Histogram
extends Object

A histogram class for counting occurences of values. Each bin of the histogram stores a counter for the domain [min of bin, max of bin[. So if you create a Histogram with new Histogram(2,2) from 0 to 2 with two bins, you will get an error if you want to call add(2) as the domains are [0;1[, [1;2[.

Author:

graf

Constructor Summary

Constructors

Constructor and Description
Histogram(int bins, double maxValue) create a histogram with the specified amount of bins with the min value set to zero
Histogram(int bins, double minValue, double maxValue) Create a histogram with the specified amount of bins with the min value set to zero

Method Summary

Methods

Modifier and Type	Method and Description
void	add(double value) Raise the counter for the specified value by 1.
void	add(double value, double increase) Raise the counter vor the value by the amount denoted by increase.
double	getBinWidth()
double[]	getHistogramm() returns a reference(!)
double	getMaxValue()
double	getMinValue()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Histogram

public Histogram(int bins,
         double maxValue)

create a histogram with the specified amount of bins with the min value set to zero

Parameters:

bins - amount of bins (>0)

maxValue - max value (>minValue)

Histogram

public Histogram(int bins,
         double minValue,
         double maxValue)

Create a histogram with the specified amount of bins with the min value set to zero

Parameters:

bins - amount of bins (>0)

minValue - minimum value

maxValue - max value (>minValue)

Throws:

IllegalArgumentException - if bins <= 0 or max <=min

Method Detail

add

public void add(double value)

Raise the counter for the specified value by 1.

Parameters:

value -

add

public void add(double value,
       double increase)

Raise the counter vor the value by the amount denoted by increase.

Parameters:

value -

increase -

toString

public String toString()

Overrides:

toString in class Object

getHistogramm

public double[] getHistogramm()

returns a reference(!) to the histogram array

Returns:

histogram array

getBinWidth

public double getBinWidth()

getMaxValue

public double getMaxValue()

getMinValue

public double getMinValue()