de.citec.scie.pdf

Class Histogramm<H>

java.lang.Object

de.citec.scie.pdf.Histogramm<H>

Type Parameters:

H - the space the histogram is build over. This may be arbitrary objects. Note that the bins must be created by yourself. This class just counts. Also note that this uses a HashMap in the backend, so datapoints/bins that are equal according to their equals method will be mapped to the same bin.

public class Histogramm<H>
extends Object

A convenience implementation for histogramms.

Author:

Benjamin Paassen - bpaassen@techfak.uni-bielefeld.de

Constructor Summary

Constructors

Constructor and Description
Histogramm()

Method Summary

Modifier and Type	Method and Description
void	addAll(Histogramm<H> otherHisto) Adds all values from another histogramm.
Integer	addDataPoint(H datapoint) Add a new datapoint/bin (or override an old one).
double	getAverage() This only works if the given class type is a number.
Map<H,Integer>	getBackingMap() Returns the backing HashMap.
H	getMaxElement() Returns the element that was counted the most.
int	getNumber(H datapoint) Returns the current count for a given datapoint/bin.

Methods inherited from class java.lang.Object

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

Constructor Detail

Histogramm

public Histogramm()

Method Detail

addAll

public void addAll(Histogramm<H> otherHisto)

Adds all values from another histogramm.

Parameters:

otherHisto - another histogramm.

addDataPoint

public Integer addDataPoint(H datapoint)

Add a new datapoint/bin (or override an old one).

Parameters:

datapoint - a new datapoint.

Returns:

the old value stored for that datapoint or null if no data existed before.

getNumber

public int getNumber(H datapoint)

Returns the current count for a given datapoint/bin.

Parameters:

datapoint - a datapoint.

Returns:

the current count for that datapoint.

getAverage

public double getAverage()

This only works if the given class type is a number. It returns the average key in this histogramm according to the histogramm, meaning: avg := Sum_{(h,n) in Histogramm} h*n / Sum_{(h,n) in Histogramm} n Please note that this does a cast to double. Therefore numeric precision is not garuanteed for BigIntegers and similar classes.

Returns:

the average key in this histogramm according to the histogramm, meaning: avg := Sum_{(h,n) in Histogramm} h*n / Sum_{(h,n) in Histogramm} n

getBackingMap

public Map<H,Integer> getBackingMap()

Returns the backing HashMap. Usually you won't need this.

Returns:

the backing HashMap.

getMaxElement

public H getMaxElement()

Returns the element that was counted the most.

Returns:

the element that was counted the most.