Package elki.index

Interface DistancePriorityIndex<O>

Type Parameters:

O - Object type

All Superinterfaces:

Index, KNNIndex<O>, RangeIndex<O>

All Known Implementing Classes:

CoverTree, DeLiCluTreeIndex, FlatRStarTreeIndex, GNAT, MemoryKDTree, MinimalisticMemoryKDTree, PrecomputedDistanceMatrix, RdKNNTree, RStarTreeIndex, SimplifiedCoverTree, SmallMemoryKDTree, VPTree

public interface DistancePriorityIndex<O>
extends KNNIndex<O>, RangeIndex<O>

Interface for incremental priority-based search using distance functions.

Since:

0.8.0

Author:

Erich Schubert

Method Summary

Modifier and Type	Method	Description
default KNNSearcher<O>	kNNByObject(DistanceQuery<O> distanceQuery, int maxk, int flags)	Get a KNN query object for the given distance query and k.
default PrioritySearcher<DBIDRef>	priorityByDBID(DistanceQuery<O> distanceQuery, double maxrange, int flags)	Get a priority search object.
PrioritySearcher<O>	priorityByObject(DistanceQuery<O> distanceQuery, double maxrange, int flags)	Get a priority search object.
default RangeSearcher<O>	rangeByObject(DistanceQuery<O> distanceQuery, double maxrange, int flags)	Get a range query object for the given distance query and k.

Methods inherited from interface elki.index.Index

initialize, logStatistics

Methods inherited from interface elki.index.KNNIndex

kNNByDBID

Methods inherited from interface elki.index.RangeIndex

rangeByDBID

Method Detail

kNNByObject

default KNNSearcher<O> kNNByObject(DistanceQuery<O> distanceQuery,
                                   int maxk,
                                   int flags)

Description copied from interface: KNNIndex

Get a KNN query object for the given distance query and k.

This function MAY return null, when the given distance is not supported!

Specified by:

kNNByObject in interface KNNIndex<O>

Parameters:

distanceQuery - Distance query

maxk - Maximum value of k

flags - Hints for the optimizer

Returns:

KNN Query object or null

rangeByObject

default RangeSearcher<O> rangeByObject(DistanceQuery<O> distanceQuery,
                                       double maxrange,
                                       int flags)

Description copied from interface: RangeIndex

Get a range query object for the given distance query and k.

This function MAY return null, when the given distance is not supported!

Specified by:

rangeByObject in interface RangeIndex<O>

Parameters:

distanceQuery - Distance query

maxrange - Maximum range

flags - Hints for the optimizer

Returns:

KNN Query object or null

priorityByObject

PrioritySearcher<O> priorityByObject(DistanceQuery<O> distanceQuery,
                                     double maxrange,
                                     int flags)

Get a priority search object.

Parameters:

distanceQuery - Distance query

maxrange - Maximum search range (may be Double.POSITIVE_INFINITY

flags - Optimizer hints

Returns:

Priority searcher

priorityByDBID

default PrioritySearcher<DBIDRef> priorityByDBID(DistanceQuery<O> distanceQuery,
                                                 double maxrange,
                                                 int flags)

Get a priority search object.

Parameters:

distanceQuery - Distance query

maxrange - Maximum search range (may be Double.POSITIVE_INFINITY

flags - Optimizer hints

Returns:

Priority searcher