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

Interface KNNList<D extends Distance<D>>

Type Parameters:

D - Distance type

All Superinterfaces:

DBIDs, DistanceDBIDList<D>

All Known Subinterfaces:

DoubleDistanceKNNList

All Known Implementing Classes:

DistanceDBIDPairKNNList, DoubleDistanceDBIDPairKNNList, DoubleDistanceDBIDPairKNNListHeap, DoubleDistanceIntegerDBIDKNNList, DoubleDistanceIntegerDBIDPairKNNListHeap, DoubleDistanceIntegerDBIDSortedKNNList, DoubleDistanceKNNSubList, KNNSubList

public interface KNNList<D extends Distance<D>>
extends DistanceDBIDList<D>

Interface for kNN results. 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 index) Direct object access.
int	getK() Get the K parameter (note: this may be less than the size of the list!)
D	getKNNDistance() Get the distance to the k nearest neighbor, or maxdist otherwise.
int	size() Size

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

iter

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

contains, isEmpty

Method Detail

size

int size()

Size

Specified by:

size in interface DBIDs

Specified by:

size in interface DistanceDBIDList<D extends Distance<D>>

Returns:

Size

getK

int getK()

Get the K parameter (note: this may be less than the size of the list!)

Returns:

K

get

DistanceDBIDPair<D> get(int index)

Direct object access.

Specified by:

get in interface DistanceDBIDList<D extends Distance<D>>

Parameters:

index -

Returns:

Pair

getKNNDistance

D getKNNDistance()

Get the distance to the k nearest neighbor, or maxdist otherwise.

Returns:

Maximum distance