de.lmu.ifi.dbs.elki.database.ids

Interface DoubleDBIDListIter

All Superinterfaces:

ArrayIter, DBIDArrayIter, DBIDIter, DBIDRef, Iter

All Known Subinterfaces:

DoubleDBIDListMIter, DoubleIntegerDBIDListIter, DoubleIntegerDBIDListMIter

All Known Implementing Classes:

DoubleIntegerDBIDList.Itr, DoubleIntegerDBIDPairKNNListHeap.Itr, DoubleIntegerDBIDPairList.Itr, IntegerDBIDKNNSubList.Itr, KNNSubList.Itr

public interface DoubleDBIDListIter
extends DBIDArrayIter

Iterator over double-DBID pairs results. There is no getter for the DBID, as this implements DBIDRef.

Author:

Erich Schubert

Method Summary

Methods

Modifier and Type	Method and Description
DoubleDBIDListIter	advance() Moves the iterator forward to the next entry.
DoubleDBIDListIter	advance(int count) Moves the iterator forward or backward by the given offset.
double	doubleValue() Get the double value
DoubleDBIDPair	getPair() Materialize an object pair.
DoubleDBIDListIter	retract() Moves the iterator backward to the previous entry.
DoubleDBIDListIter	seek(int off) Moves the iterator to the given position

Methods inherited from interface de.lmu.ifi.dbs.elki.database.ids.DBIDRef

equals, hashCode, internalGetIndex

Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.datastructures.iterator.ArrayIter

getOffset

Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.datastructures.iterator.Iter

valid

Method Detail

doubleValue

double doubleValue()

Get the double value

Returns:

double value

getPair

DoubleDBIDPair getPair()

Materialize an object pair. Note: currently, this will create a new object. In order to avoid the garbage collection overhead, it is preferable to use #doubleValue() and exploit that the iterator itself is a DBIDRef reference.

Returns:

object pair

advance

DoubleDBIDListIter 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 DBIDArrayIter

Specified by:

advance in interface DBIDIter

Specified by:

advance in interface Iter

Returns:

The iterator itself.

advance

DoubleDBIDListIter advance(int count)

Description copied from interface: ArrayIter

Moves the iterator forward or backward by the given offset.

Specified by:

advance in interface ArrayIter

Specified by:

advance in interface DBIDArrayIter

Parameters:

count - offset to move forward or backwards

Returns:

Iterator

retract

DoubleDBIDListIter retract()

Description copied from interface: ArrayIter

Moves the iterator backward to the previous entry.

Specified by:

retract in interface ArrayIter

Specified by:

retract in interface DBIDArrayIter

Returns:

Iterator

seek

DoubleDBIDListIter seek(int off)

Description copied from interface: ArrayIter

Moves the iterator to the given position

Specified by:

seek in interface ArrayIter

Specified by:

seek in interface DBIDArrayIter

Parameters:

off - Seek offset

Returns:

Iterator