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

Class KNNSubList.Itr

java.lang.Object

de.lmu.ifi.dbs.elki.database.ids.generic.KNNSubList.Itr

All Implemented Interfaces:

DBIDArrayIter, DBIDIter, DBIDRef, DoubleDBIDListIter, ArrayIter, Iter

Enclosing class:

KNNSubList

private class KNNSubList.Itr
extends Object
implements DoubleDBIDListIter

Iterator for the sublist.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
private int	pos Current position.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	KNNSubList.Itr()

Method Summary

Methods

Modifier and Type	Method and Description
KNNSubList.Itr	advance() Moves the iterator forward to the next entry.
KNNSubList.Itr	advance(int count) Moves the iterator forward or backward by the given offset.
double	doubleValue() Get the double value
int	getOffset() Get current iterator offset.
DoubleDBIDPair	getPair() Materialize an object pair.
int	internalGetIndex() Get the internal index.
KNNSubList.Itr	retract() Moves the iterator backward to the previous entry.
KNNSubList.Itr	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

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

equals, hashCode

Field Detail

pos

private int pos

Current position.

Constructor Detail

KNNSubList.Itr

private KNNSubList.Itr()

Method Detail

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 KNNSubList.Itr advance()

Description copied from interface: Iter

Moves the iterator forward to the next entry.

Specified by:

advance in interface DBIDArrayIter

Specified by:

advance in interface DBIDIter

Specified by:

advance in interface DoubleDBIDListIter

Specified by:

advance in interface ArrayIter

Specified by:

advance in interface Iter

Returns:

The iterator itself.

doubleValue

public double doubleValue()

Description copied from interface: DoubleDBIDListIter

Get the double value

Specified by:

doubleValue in interface DoubleDBIDListIter

Returns:

double value

getPair

public DoubleDBIDPair getPair()

Description copied from interface: DoubleDBIDListIter

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.

Specified by:

getPair in interface DoubleDBIDListIter

Returns:

object pair

internalGetIndex

public int internalGetIndex()

Description copied from interface: DBIDRef

Get the internal index. NOT FOR PUBLIC USE - ELKI Optimization engine only

Specified by:

internalGetIndex in interface DBIDRef

Returns:

Internal index

getOffset

public int getOffset()

Description copied from interface: ArrayIter

Get current iterator offset.

Specified by:

getOffset in interface ArrayIter

Returns:

Iterator position

advance

public KNNSubList.Itr advance(int count)

Description copied from interface: ArrayIter

Moves the iterator forward or backward by the given offset.

Specified by:

advance in interface DBIDArrayIter

Specified by:

advance in interface DoubleDBIDListIter

Specified by:

advance in interface ArrayIter

Parameters:

count - offset to move forward or backwards

Returns:

Iterator

retract

public KNNSubList.Itr retract()

Description copied from interface: ArrayIter

Moves the iterator backward to the previous entry.

Specified by:

retract in interface DBIDArrayIter

Specified by:

retract in interface DoubleDBIDListIter

Specified by:

retract in interface ArrayIter

Returns:

Iterator

seek

public KNNSubList.Itr seek(int off)

Description copied from interface: ArrayIter

Moves the iterator to the given position

Specified by:

seek in interface DBIDArrayIter

Specified by:

seek in interface DoubleDBIDListIter

Specified by:

seek in interface ArrayIter

Parameters:

off - Seek offset

Returns:

Iterator