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

Interface KNNQuery<O,D extends Distance<D>>

Type Parameters:

O - Object type

D - Distance type

All Superinterfaces:

DatabaseQuery

All Known Implementing Classes:

AbstractDistanceKNNQuery, AbstractRefiningIndex.AbstractKNNQuery, DoubleDistanceRStarTreeKNNQuery, GenericRStarTreeKNNQuery, LinearScanKNNQuery, LinearScanPrimitiveDistanceKNNQuery, LinearScanRawDoubleDistanceKNNQuery, MetricalIndexKNNQuery, PreprocessorKNNQuery, VAFile.VAFileKNNQuery

public interface KNNQuery<O,D extends Distance<D>>
extends DatabaseQuery

The interface of an actual instance.

Field Summary

Fields inherited from interface de.lmu.ifi.dbs.elki.database.query.DatabaseQuery

HINT_BULK, HINT_EXACT, HINT_HEAVY_USE, HINT_NO_CACHE, HINT_OPTIMIZED_ONLY, HINT_SINGLE

Method Summary

Methods

Modifier and Type	Method and Description
List<KNNResult<D>>	getKNNForBulkDBIDs(ArrayDBIDs ids, int k) Bulk query method
void	getKNNForBulkHeaps(Map<DBID,KNNHeap<D>> heaps) Bulk query method configured by a map.
KNNResult<D>	getKNNForDBID(DBID id, int k) Get the k nearest neighbors for a particular id.
KNNResult<D>	getKNNForObject(O obj, int k) Get the k nearest neighbors for a particular id.

Method Detail

getKNNForDBID

KNNResult<D> getKNNForDBID(DBID id,
                         int k)

Get the k nearest neighbors for a particular id.

Parameters:

id - query object ID

k - Number of neighbors requested

Returns:

neighbors

getKNNForBulkDBIDs

List<KNNResult<D>> getKNNForBulkDBIDs(ArrayDBIDs ids,
                                    int k)

Bulk query method

Parameters:

ids - query object IDs

k - Number of neighbors requested

Returns:

neighbors

getKNNForBulkHeaps

void getKNNForBulkHeaps(Map<DBID,KNNHeap<D>> heaps)

Bulk query method configured by a map. Warning: this API is not optimal, and might be removed soon (in fact, it is used in a single place)

Parameters:

heaps - Map of heaps to fill.

getKNNForObject

KNNResult<D> getKNNForObject(O obj,
                           int k)

Get the k nearest neighbors for a particular id.

Parameters:

obj - Query object

k - Number of neighbors requested

Returns:

neighbors