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

Interface DistanceDBIDResult<D extends Distance<D>>

Type Parameters:

D - Distance type

All Superinterfaces:

DBIDs

All Known Subinterfaces:

KNNResult<D>, ModifiableDistanceDBIDResult<D>

All Known Implementing Classes:

DoubleDistanceDBIDList, DoubleDistanceKNNList, GenericDistanceDBIDList, GenericKNNList, KNNUtil.KNNSubList

public interface DistanceDBIDResult<D extends Distance<D>>
extends DBIDs

Collection of objects and their distances. To iterate over the results, use the following code:

 for (DistanceDBIDResultIter<D> iter = result.iter(); iter.valid(); iter.advance()) {
   // You can get the distance via: iter.getDistance();
   // Or use iter just like any other DBIDRef
 }
 
 

If you are only interested in the IDs of the objects, the following is also sufficient:

 for (DBIDIter<D> iter = result.iter(); iter.valid(); iter.advance()) {
   // Use iter just like any other DBIDRef
 }
 
 

Method Summary

Methods

Modifier and Type	Method and Description
DistanceDBIDPair<D>	get(int off) Access a single pair.
DistanceDBIDResultIter<D>	iter() Get an iterator
int	size() Size of list.

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

contains, isEmpty

Method Detail

size

int size()

Size of list.

Specified by:

size in interface DBIDs

Returns:

Size

get

DistanceDBIDPair<D> get(int off)

Access a single pair.

Parameters:

off - Offset

Returns:

Pair

iter

DistanceDBIDResultIter<D> iter()

Get an iterator

Specified by:

iter in interface DBIDs

Returns:

New iterator