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

Class GenericKNNList.Itr

java.lang.Object

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

All Implemented Interfaces:

DBIDIter, DBIDRef, DistanceDBIDResultIter<D>, Iter

Enclosing class:

GenericKNNList<D extends Distance<D>>

private class GenericKNNList.Itr
extends Object
implements DistanceDBIDResultIter<D>

Iterator.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
private	GenericKNNList.Itr()

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

Cursor position.

Constructor Detail

GenericKNNList.Itr

private GenericKNNList.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

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