Package elki.index.tree.metrical.mtreevariants.mktrees.mkapp

Class MkAppTreeIndex<O>

java.lang.Object

elki.index.tree.IndexTree<N,E>

elki.index.tree.metrical.MetricalIndexTree<O,N,E>

elki.index.tree.metrical.mtreevariants.AbstractMTree<O,N,E,S>

elki.index.tree.metrical.mtreevariants.mktrees.AbstractMkTree<O,MkAppTreeNode<O>,MkAppEntry,MkAppTreeSettings<O>>

elki.index.tree.metrical.mtreevariants.mktrees.mkapp.MkAppTree<O>

elki.index.tree.metrical.mtreevariants.mktrees.mkapp.MkAppTreeIndex<O>

Type Parameters:

O - Object type

All Implemented Interfaces:

Index, KNNIndex<O>, RangeIndex<O>, RKNNIndex<O>

public class MkAppTreeIndex<O>
extends MkAppTree<O>
implements RangeIndex<O>, KNNIndex<O>, RKNNIndex<O>

MkAppTree used as database index.

Since:

0.4.0

Author:

Erich Schubert

Nested Class Summary

Nested classes/interfaces inherited from class elki.index.tree.metrical.mtreevariants.AbstractMTree

AbstractMTree.Statistics

Field Summary

Fields

Modifier and Type	Field	Description
private Relation<O>	relation	The relation indexed

Fields inherited from class elki.index.tree.metrical.mtreevariants.mktrees.AbstractMkTree

knnq

Fields inherited from class elki.index.tree.metrical.mtreevariants.AbstractMTree

settings, statistics

Fields inherited from class elki.index.tree.IndexTree

dirCapacity, dirMinimum, initialized, leafCapacity, leafMinimum

Constructor Summary

Constructors

Constructor	Description
MkAppTreeIndex(Relation<O> relation, PageFile<MkAppTreeNode<O>> pageFile, MkAppTreeSettings<O> settings)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected MkAppEntry	createNewLeafEntry(DBID id, O object, double parentDistance)	Creates a new leaf entry representing the specified data object in the specified subtree.
void	initialize()	Initialize the tree if the page file already existed.
KNNSearcher<DBIDRef>	kNNByDBID(DistanceQuery<O> distanceQuery, int maxk, int flags)	Get a KNN query object for the given distance query and k.
KNNSearcher<O>	kNNByObject(DistanceQuery<O> distanceQuery, int maxk, int flags)	Get a KNN query object for the given distance query and k.
RangeSearcher<DBIDRef>	rangeByDBID(DistanceQuery<O> distanceQuery, double maxradius, int flags)	Get a range query object for the given distance query and k.
RangeSearcher<O>	rangeByObject(DistanceQuery<O> distanceQuery, double maxradius, int flags)	Get a range query object for the given distance query and k.
RKNNSearcher<DBIDRef>	rkNNByDBID(DistanceQuery<O> distanceQuery, int maxk, int flags)	Get a RKNN query object for the given distance query and k.
RKNNSearcher<O>	rkNNByObject(DistanceQuery<O> distanceQuery, int maxk, int flags)	Get a RKNN query object for the given distance query and k.

Methods inherited from class elki.index.tree.metrical.mtreevariants.mktrees.mkapp.MkAppTree

createNewDirectoryEntry, createNewDirectoryNode, createNewLeafNode, createRootEntry, getK_max, getLogger, initializeCapacities, insert, insertAll, preInsert, reverseKNNQuery

Methods inherited from class elki.index.tree.metrical.mtreevariants.mktrees.AbstractMkTree

batchNN, distance

Methods inherited from class elki.index.tree.metrical.mtreevariants.AbstractMTree

createEmptyRoot, distance, doExtraIntegrityChecks, getDistance, getHeight, getLeaves, getSortedEntries, logStatistics, toString

Methods inherited from class elki.index.tree.IndexTree

createHeader, deleteNode, getFile, getNode, getNode, getPageID, getPageSize, getRootEntry, getRootID, getRootPath, initialize, initializeFromFile, isRoot, postDelete, writeNode

Methods inherited from class java.lang.Object

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

Methods inherited from interface elki.index.Index

logStatistics

Field Detail

relation

private Relation<O> relation

The relation indexed

Constructor Detail

MkAppTreeIndex

public MkAppTreeIndex(Relation<O> relation,
                      PageFile<MkAppTreeNode<O>> pageFile,
                      MkAppTreeSettings<O> settings)

Constructor.

Parameters:

relation - Relation to index

pageFile - Page file

settings - Tree settings

Method Detail

createNewLeafEntry

protected MkAppEntry createNewLeafEntry(DBID id,
                                        O object,
                                        double parentDistance)

Creates a new leaf entry representing the specified data object in the specified subtree.

Parameters:

object - the data object to be represented by the new entry

parentDistance - the distance from the object to the routing object of the parent node

initialize

public void initialize()

Description copied from class: IndexTree

Initialize the tree if the page file already existed.

Specified by:

initialize in interface Index

Overrides:

initialize in class IndexTree<MkAppTreeNode<O>,MkAppEntry>

kNNByObject

public 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

kNNByDBID

public KNNSearcher<DBIDRef> kNNByDBID(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:

kNNByDBID 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

public RangeSearcher<O> rangeByObject(DistanceQuery<O> distanceQuery,
                                      double maxradius,
                                      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

maxradius - Maximum range

flags - Hints for the optimizer

Returns:

KNN Query object or null

rangeByDBID

public RangeSearcher<DBIDRef> rangeByDBID(DistanceQuery<O> distanceQuery,
                                          double maxradius,
                                          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:

rangeByDBID in interface RangeIndex<O>

Parameters:

distanceQuery - Distance query

maxradius - Maximum range

flags - Hints for the optimizer

Returns:

KNN Query object or null

rkNNByObject

public RKNNSearcher<O> rkNNByObject(DistanceQuery<O> distanceQuery,
                                    int maxk,
                                    int flags)

Description copied from interface: RKNNIndex

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

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

Specified by:

rkNNByObject in interface RKNNIndex<O>

Parameters:

distanceQuery - Distance query

maxk - Maximum k for RkNN query

flags - Hints for the optimizer

Returns:

RKNN Query object or null

rkNNByDBID

public RKNNSearcher<DBIDRef> rkNNByDBID(DistanceQuery<O> distanceQuery,
                                        int maxk,
                                        int flags)

Description copied from interface: RKNNIndex

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

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

Specified by:

rkNNByDBID in interface RKNNIndex<O>

Parameters:

distanceQuery - Distance query

maxk - Maximum k for RkNN query

flags - Hints for the optimizer

Returns:

RKNN Query object or null