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

Class GenericDistanceDBIDList.Itr

java.lang.Object

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

All Implemented Interfaces:

DBIDArrayIter, DBIDIter, DBIDRef, DistanceDBIDListIter<D>, ArrayIter, Iter

Enclosing class:

GenericDistanceDBIDList<D extends Distance<D>>

protected class GenericDistanceDBIDList.Itr
extends Object
implements DistanceDBIDListIter<D>

Iterator class.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	pos Iterator position.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericDistanceDBIDList.Itr()

Method Summary

Methods

Modifier and Type	Method and Description
void	advance() Moves the iterator forward to the next entry.
void	advance(int count) Moves the iterator forward or backward by the given offset.
D	getDistance() Get the distance
DistanceDBIDPair<D>	getDistancePair() Get an object pair.
int	getOffset() Get current iterator offset.
int	internalGetIndex() Get the internal index.
void	retract() Moves the iterator backward to the previous entry.
void	seek(int off) Moves the iterator to the given position
String	toString()
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, wait, wait, wait

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

equals, hashCode

Field Detail

pos

int pos

Iterator position.

Constructor Detail

GenericDistanceDBIDList.Itr

protected GenericDistanceDBIDList.Itr()

Method Detail

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

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 void advance()

Description copied from interface: Iter

Moves the iterator forward to the next entry.

Specified by:

advance in interface Iter

getDistance

public D getDistance()

Description copied from interface: DistanceDBIDListIter

Get the distance

Specified by:

getDistance in interface DistanceDBIDListIter<D extends Distance<D>>

Returns:

distance

getDistancePair

public DistanceDBIDPair<D> getDistancePair()

Description copied from interface: DistanceDBIDListIter

Get an object pair.

Specified by:

getDistancePair in interface DistanceDBIDListIter<D extends Distance<D>>

Returns:

object pair

toString

public String toString()

Overrides:

toString in class Object

getOffset

public int getOffset()

Description copied from interface: ArrayIter

Get current iterator offset.

Specified by:

getOffset in interface ArrayIter

Returns:

Iterator position

advance

public void 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

retract

public void retract()

Description copied from interface: ArrayIter

Moves the iterator backward to the previous entry.

Specified by:

retract in interface ArrayIter

seek

public void 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