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

Class AbstractDistanceKNNQuery<O>

java.lang.Object

de.lmu.ifi.dbs.elki.database.query.knn.AbstractDistanceKNNQuery<O>

All Implemented Interfaces:

DatabaseQuery, KNNQuery<O>

Direct Known Subclasses:

AbstractRefiningIndex.AbstractKNNQuery, CoverTree.CoverTreeKNNQuery, InMemoryInvertedIndex.ArcCosineKNNQuery, InMemoryInvertedIndex.CosineKNNQuery, LinearScanDistanceKNNQuery, LinearScanPrimitiveDistanceKNNQuery, MetricalIndexKNNQuery, MinimalisticMemoryKDTree.KDTreeKNNQuery, SimplifiedCoverTree.CoverTreeKNNQuery, SmallMemoryKDTree.KDTreeKNNQuery

public abstract class AbstractDistanceKNNQuery<O>
extends Object
implements KNNQuery<O>

Instance for the query on a particular database.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
protected DistanceQuery<O>	distanceQuery Hold the distance function to be used.
protected Relation<? extends O>	relation The data to use for this query

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

Constructor Summary

Constructors

Constructor and Description
AbstractDistanceKNNQuery(DistanceQuery<O> distanceQuery) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
List<? extends KNNList>	getKNNForBulkDBIDs(ArrayDBIDs ids, int k) Bulk query method
KNNList	getKNNForDBID(DBIDRef id, int k) Get the k nearest neighbors for a particular id.
abstract KNNList	getKNNForObject(O obj, int k) Get the k nearest neighbors for a particular id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

relation

protected final Relation<? extends O> relation

The data to use for this query

distanceQuery

protected final DistanceQuery<O> distanceQuery

Hold the distance function to be used.

Constructor Detail

AbstractDistanceKNNQuery

public AbstractDistanceKNNQuery(DistanceQuery<O> distanceQuery)

Constructor.

Parameters:

distanceQuery - Distance query used

Method Detail

getKNNForBulkDBIDs

public List<? extends KNNList> getKNNForBulkDBIDs(ArrayDBIDs ids,
                                         int k)

Description copied from interface: KNNQuery

Bulk query method

Specified by:

getKNNForBulkDBIDs in interface KNNQuery<O>

Parameters:

ids - query object IDs

k - Number of neighbors requested

Returns:

neighbors

getKNNForDBID

public KNNList getKNNForDBID(DBIDRef id,
                    int k)

Description copied from interface: KNNQuery

Get the k nearest neighbors for a particular id.

Specified by:

getKNNForDBID in interface KNNQuery<O>

Parameters:

id - query object ID

k - Number of neighbors requested

Returns:

neighbors

getKNNForObject

public abstract KNNList getKNNForObject(O obj,
                      int k)

Description copied from interface: KNNQuery

Get the k nearest neighbors for a particular id.

Specified by:

getKNNForObject in interface KNNQuery<O>

Parameters:

obj - Query object

k - Number of neighbors requested

Returns:

neighbors