Package elki.index

Interface RangeIndex<O>

Type Parameters:

O - Database Object type

All Superinterfaces:

Index

All Known Subinterfaces:

DistancePriorityIndex<O>

All Known Implementing Classes:

CoverTree, DeLiCluTreeIndex, FlatRStarTreeIndex, GNAT, InMemoryIDistanceIndex, InMemoryInvertedIndex, InMemoryLSHIndex.Instance, LAESA, LatLngAsECEFIndex, LngLatAsECEFIndex, MemoryKDTree, MinimalisticMemoryKDTree, MkAppTreeIndex, MkCoPTreeIndex, MkMaxTreeIndex, MkTabTreeIndex, MTreeIndex, PartialVAFile, PrecomputedDistanceMatrix, ProjectedIndex, RdKNNTree, RStarTreeIndex, SimplifiedCoverTree, SmallMemoryKDTree, VAFile, VPTree

public interface RangeIndex<O>
extends Index

Index with support for range queries (radius queries).

Since:

0.4.0

Author:

Erich Schubert

Method Summary

Modifier and Type	Method	Description
default RangeSearcher<DBIDRef>	rangeByDBID(DistanceQuery<O> distanceQuery, double maxrange, int flags)	Get a range query object for the given distance query and k.
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

Method Detail

rangeByObject

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

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

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

Parameters:

distanceQuery - Distance query

maxrange - Maximum range

flags - Hints for the optimizer

Returns:

KNN Query object or null

rangeByDBID

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

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

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

Parameters:

distanceQuery - Distance query

maxrange - Maximum range

flags - Hints for the optimizer

Returns:

KNN Query object or null