de.lmu.ifi.dbs.elki.database.query.knn

Interface KNNResult<D extends Distance<D>>

Type Parameters:

D - Distance type

All Superinterfaces:

Collection<DistanceResultPair<D>>, Iterable<DistanceResultPair<D>>

All Known Implementing Classes:

KNNList, KNNUtil.KNNSubList

public interface KNNResult<D extends Distance<D>>
extends Collection<DistanceResultPair<D>>

Interface for kNN results - List<> like.

Method Summary

Methods

Modifier and Type	Method and Description
ArrayDBIDs	asDBIDs() View as ArrayDBIDs
List<D>	asDistanceList() View as list of distances
DistanceResultPair<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 java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, toArray, toArray

Method Detail

size

int size()

Size

Specified by:

size in interface Collection<DistanceResultPair<D extends Distance<D>>>

getK

int getK()

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

Returns:

K

get

DistanceResultPair<D> get(int index)

Direct object access.

Parameters:

index -

getKNNDistance

D getKNNDistance()

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

Returns:

Maximum distance

asDBIDs

ArrayDBIDs asDBIDs()

View as ArrayDBIDs

Returns:

Static DBIDs

asDistanceList

List<D> asDistanceList()

View as list of distances

Returns:

List of distances view