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

Class AbstractStaticHistogram.Iter

java.lang.Object

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

All Implemented Interfaces:

Histogram.Iter, ArrayIter, Iter

Direct Known Subclasses:

AbstractObjStaticHistogram.Iter, DoubleStaticHistogram.Iter, FloatStaticHistogram.Iter, IntStaticHistogram.Iter, LongStaticHistogram.Iter, ShortStaticHistogram.Iter

Enclosing class:

AbstractStaticHistogram

public abstract class AbstractStaticHistogram.Iter
extends Object
implements Histogram.Iter

Iterator class to iterate over all bins.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	bin Current bin number

Constructor Summary

Constructors

Constructor and Description
Iter()

Method Summary

Modifier and Type	Method and Description
AbstractStaticHistogram.Iter	advance() Moves the iterator forward to the next entry.
AbstractStaticHistogram.Iter	advance(int count) Moves the iterator forward or backward by the given offset.
double	getCenter() Get the bin center.
double	getLeft() Get the bin minimum.
int	getOffset() Get current iterator offset.
double	getRight() Get the bin maximum.
AbstractStaticHistogram.Iter	retract() Moves the iterator backward to the previous entry.
AbstractStaticHistogram.Iter	seek(int off) Moves the iterator to the given position
boolean	valid() Returns true if the iterator currently points to a valid object.

Methods inherited from class java.lang.Object

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

Field Detail

bin

int bin

Current bin number

Constructor Detail

Iter

public Iter()

Method Detail

getCenter

public double getCenter()

Description copied from interface: Histogram.Iter

Get the bin center.

Specified by:

getCenter in interface Histogram.Iter

Returns:

bin center value

getLeft

public double getLeft()

Description copied from interface: Histogram.Iter

Get the bin minimum.

Specified by:

getLeft in interface Histogram.Iter

Returns:

bin left value

getRight

public double getRight()

Description copied from interface: Histogram.Iter

Get the bin maximum.

Specified by:

getRight in interface Histogram.Iter

Returns:

bin right value

valid

public boolean valid()

Description copied from interface: Iter

Returns true if the iterator currently points to a valid object.

Specified by:

valid in interface Iter

Returns:

a boolean value, whether the position is valid.

advance

public AbstractStaticHistogram.Iter advance()

Description copied from interface: Iter

Moves the iterator forward to the next entry.

Specified by:

advance in interface ArrayIter

Specified by:

advance in interface Iter

Returns:

The iterator itself.

getOffset

public int getOffset()

Description copied from interface: ArrayIter

Get current iterator offset.

Specified by:

getOffset in interface ArrayIter

Returns:

Iterator position

advance

public AbstractStaticHistogram.Iter advance(int count)

Description copied from interface: ArrayIter

Moves the iterator forward or backward by the given offset.

Specified by:

advance in interface ArrayIter

Parameters:

count - offset to move forward or backwards

Returns:

Iterator

retract

public AbstractStaticHistogram.Iter retract()

Description copied from interface: ArrayIter

Moves the iterator backward to the previous entry.

Specified by:

retract in interface ArrayIter

Returns:

Iterator

seek

public AbstractStaticHistogram.Iter seek(int off)

Description copied from interface: ArrayIter

Moves the iterator to the given position

Specified by:

seek in interface ArrayIter

Parameters:

off - Seek offset

Returns:

Iterator