Package elki.utilities.datastructures.histogram

Class ObjHistogram.Iter

java.lang.Object

elki.utilities.datastructures.histogram.AbstractStaticHistogram.Iter

elki.utilities.datastructures.histogram.ObjHistogram.Iter

All Implemented Interfaces:

Histogram.Iter, ArrayIter, Iter

Enclosing class:

ObjHistogram<T>

public class ObjHistogram.Iter
extends AbstractStaticHistogram.Iter
implements Histogram.Iter

Iterator class.

Author:

Erich Schubert

Field Summary

Fields inherited from class elki.utilities.datastructures.histogram.AbstractStaticHistogram.Iter

bin

Constructor Summary

Constructors

Constructor	Description
Iter()

Method Summary

Modifier and Type	Method	Description
ObjHistogram.Iter	advance()	Moves the iterator forward to the next entry.
ObjHistogram.Iter	advance(int count)	Moves the iterator forward or backward by the given offset.
T	getValue()	Get the value of the bin.
ObjHistogram.Iter	retract()	Moves the iterator backward to the previous entry.
ObjHistogram.Iter	seek(int off)	Moves the iterator to the given position

Methods inherited from class elki.utilities.datastructures.histogram.AbstractStaticHistogram.Iter

getCenter, getLeft, getOffset, getRight, valid

Methods inherited from class java.lang.Object

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

Methods inherited from interface elki.utilities.datastructures.iterator.ArrayIter

getOffset

Methods inherited from interface elki.utilities.datastructures.histogram.Histogram.Iter

getCenter, getLeft, getRight

Methods inherited from interface elki.utilities.datastructures.iterator.Iter

valid

Constructor Detail

Iter

public Iter()

Method Detail

getValue

public T getValue()

Get the value of the bin.

Returns:

Bin value

advance

public ObjHistogram.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

Overrides:

advance in class AbstractStaticHistogram.Iter

Returns:

The iterator itself.

advance

public ObjHistogram.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

Overrides:

advance in class AbstractStaticHistogram.Iter

Parameters:

count - offset to move forward or backwards

Returns:

Iterator

retract

public ObjHistogram.Iter retract()

Description copied from interface: ArrayIter

Moves the iterator backward to the previous entry.

Specified by:

retract in interface ArrayIter

Overrides:

retract in class AbstractStaticHistogram.Iter

Returns:

Iterator

seek

public ObjHistogram.Iter seek(int off)

Description copied from interface: ArrayIter

Moves the iterator to the given position

Specified by:

seek in interface ArrayIter

Overrides:

seek in class AbstractStaticHistogram.Iter

Parameters:

off - Seek offset

Returns:

Iterator