de.lmu.ifi.dbs.elki.distance.distanceresultlist

Class GenericDistanceDBIDList.Iter

java.lang.Object

de.lmu.ifi.dbs.elki.distance.distanceresultlist.GenericDistanceDBIDList.Iter

All Implemented Interfaces:

DBIDIter, DBIDRef, DistanceDBIDResultIter<D>, Iter

Enclosing class:

GenericDistanceDBIDList<D extends Distance<D>>

protected class GenericDistanceDBIDList.Iter
extends Object
implements DistanceDBIDResultIter<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.Iter()

Method Summary

Methods

Modifier and Type	Method and Description
void	advance() Moves the iterator forward to the next entry.
D	getDistance() Get the distance
DistanceDBIDPair<D>	getDistancePair() Get an object pair.
int	internalGetIndex() Get the internal index.
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.Iter

protected GenericDistanceDBIDList.Iter()

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

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: DistanceDBIDResultIter

Get the distance

Specified by:

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

Returns:

distance

getDistancePair

public DistanceDBIDPair<D> getDistancePair()

Description copied from interface: DistanceDBIDResultIter

Get an object pair.

Specified by:

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

Returns:

object pair

toString

public String toString()

Overrides:

toString in class Object