de.lmu.ifi.dbs.elki.utilities.datastructures.histogram

Interface Histogram

All Known Subinterfaces:

DoubleHistogram, FloatHistogram, IntHistogram, LongHistogram, ObjHistogram<T>, ShortHistogram

All Known Implementing Classes:

AbstractObjDynamicHistogram, AbstractObjStaticHistogram, AbstractStaticHistogram, DoubleArrayStaticHistogram, DoubleDynamicHistogram, DoubleStaticHistogram, FloatDynamicHistogram, FloatStaticHistogram, IntArrayStaticHistogram, IntDynamicHistogram, IntStaticHistogram, LongArrayStaticHistogram, LongDynamicHistogram, LongStaticHistogram, MeanVarianceStaticHistogram, ShortDynamicHistogram, ShortStaticHistogram

public interface Histogram

Abstract API for histograms. Without specific type information, to allow this to be shared for primitive types, too!

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Histogram.Iter Array iterator.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CACHE_SHIFT This parameter controls the cache size used for dynamic histograms before setting the initial thresholds.

Method Summary

Methods

Modifier and Type	Method and Description
double	getBinsize() Get the size (width) of a bin.
double	getCoverMaximum() Get maximum (covered by bins, not data!)
double	getCoverMinimum() Get minimum (covered by bins, not data!)
int	getNumBins() Get the number of bins actually in use.
Histogram.Iter	iter() Get an iterator over all histogram bins.

Field Detail

CACHE_SHIFT

static final int CACHE_SHIFT

This parameter controls the cache size used for dynamic histograms before setting the initial thresholds.

See Also:

Constant Field Values

Method Detail

getNumBins

int getNumBins()

Get the number of bins actually in use.

Returns:

number of bins

getBinsize

double getBinsize()

Get the size (width) of a bin.

Returns:

bin size

getCoverMinimum

double getCoverMinimum()

Get minimum (covered by bins, not data!)

Returns:

minimum

getCoverMaximum

double getCoverMaximum()

Get maximum (covered by bins, not data!)

Returns:

maximum

iter

Histogram.Iter iter()

Get an iterator over all histogram bins.

Returns:

Iterator