ObjHistogram (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- elki.utilities.datastructures.histogram.AbstractStaticHistogram
- - elki.utilities.datastructures.histogram.ObjHistogram<T>

Type Parameters:

T - Data type

All Implemented Interfaces:

Histogram

Direct Known Subclasses:

AbstractObjDynamicHistogram
```
public class ObjHistogram<T>
extends AbstractStaticHistogram
```
Histogram class storing double values.
The histogram will start with "bin" bins, but it can grow dynamicall to the left and right.

Since:

0.5.5

Author:

Erich Schubert

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ObjHistogram.BucketFactory<T>
Function to make new buckets.

class ObjHistogram.Iter
Iterator class.

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) java.lang.Object[]`	`data`	Data store
`(package private) java.lang.Object[]`	`special`	Special value storage: infinity, NaN
`(package private) ObjHistogram.BucketFactory<T>`	`supplier`	Supplier for empty bins.

Fields inherited from class elki.utilities.datastructures.histogram.AbstractStaticHistogram
base, binsize, max, offset, size

Fields inherited from interface elki.utilities.datastructures.histogram.Histogram
CACHE_SHIFT

Constructor Summary

Constructors
Constructor Description

ObjHistogram(int bins, double min, double max, ObjHistogram.BucketFactory<T> supplier)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`T`	`get(double coord)`	Access the value of a bin with new data.
`protected T`	`getSpecial(int idx)`	Ensure that we have storage for special values (infinity, NaN)
`ObjHistogram.Iter`	`iter()`	Get an iterator over all histogram bins.

Methods inherited from class elki.utilities.datastructures.histogram.AbstractStaticHistogram
getBinNr, getBinsize, getCoverMaximum, getCoverMinimum, getNumBins, growSize

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - data
```
java.lang.Object[] data
```
    Data store
  - special
```
java.lang.Object[] special
```
    Special value storage: infinity, NaN
  - supplier
```
ObjHistogram.BucketFactory<T> supplier
```
    Supplier for empty bins.
- Constructor Detail
  - ObjHistogram
```
public ObjHistogram(int bins,
                    double min,
                    double max,
                    ObjHistogram.BucketFactory<T> supplier)
```
    Constructor.
    
    Parameters:
    
    bins - Number of bins
    
    min - Cover minimum
    
    max - Cover maximum
    
    supplier - Supplier to fill empty bins
- Method Detail
  - get
```
public T get(double coord)
```
    Access the value of a bin with new data.
    
    Parameters:
    
    coord - Coordinate
    
    Returns:
    
    bin contents
  - getSpecial
```
protected T getSpecial(int idx)
```
    Ensure that we have storage for special values (infinity, NaN)
    
    Parameters:
    
    idx - Index to return.
  - iter
```
public ObjHistogram.Iter iter()
```
    Description copied from class: AbstractStaticHistogram
    
    Get an iterator over all histogram bins.
    
    Specified by:
    
    iter in interface Histogram
    
    Specified by:
    
    iter in class AbstractStaticHistogram
    
    Returns:
    
    Iterator