de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.mktrees.mkcop

Class MkCoPTreeIndex<O>

java.lang.Object

de.lmu.ifi.dbs.elki.index.tree.IndexTree<N,E>

de.lmu.ifi.dbs.elki.index.tree.metrical.MetricalIndexTree<O,N,E>

de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.AbstractMTree<O,N,E,S>

de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.mktrees.AbstractMkTree<O,MkCoPTreeNode<O>,MkCoPEntry,MkTreeSettings<O,MkCoPTreeNode<O>,MkCoPEntry>>

de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.mktrees.mkcop.MkCoPTree<O>

de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.mktrees.mkcop.MkCoPTreeIndex<O>

Type Parameters:

O - Object type

All Implemented Interfaces:

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

public class MkCoPTreeIndex<O>
extends MkCoPTree<O>
implements RangeIndex<O>, KNNIndex<O>, RKNNIndex<O>

MkCoPTree used as database index.

Since:

0.4.0

Author:

Erich Schubert

Nested Class Summary

Nested classes/interfaces inherited from class de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.AbstractMTree

AbstractMTree.Statistics

Field Summary

Fields

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

Fields inherited from class de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.mktrees.AbstractMkTree

knnq

Fields inherited from class de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.AbstractMTree

EXTRA_INTEGRITY_CHECKS, settings, statistics

Fields inherited from class de.lmu.ifi.dbs.elki.index.tree.IndexTree

dirCapacity, dirMinimum, initialized, leafCapacity, leafMinimum

Constructor Summary

Constructors

Constructor and Description
MkCoPTreeIndex(Relation<O> relation, PageFile<MkCoPTreeNode<O>> pageFile, MkTreeSettings<O,MkCoPTreeNode<O>,MkCoPEntry> settings) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected MkCoPEntry	createNewLeafEntry(DBID id, O object, double parentDistance) Creates a new leaf entry representing the specified data object in the specified subtree.
KNNQuery<O>	getKNNQuery(DistanceQuery<O> distanceQuery, Object... hints) Get a KNN query object for the given distance query and k.
String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
RangeQuery<O>	getRangeQuery(DistanceQuery<O> distanceQuery, Object... hints) Get a range query object for the given distance query and k.
RKNNQuery<O>	getRKNNQuery(DistanceQuery<O> distanceQuery, Object... hints) Get a KNN query object for the given distance query and k.
String	getShortName() A short name for the result, useful for file names.
void	initialize() Initialize the tree if the page file already existed.

Methods inherited from class de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.mktrees.mkcop.MkCoPTree

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

Methods inherited from class de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.mktrees.AbstractMkTree

batchNN, distance

Methods inherited from class de.lmu.ifi.dbs.elki.index.tree.metrical.mtreevariants.AbstractMTree

createEmptyRoot, distance, getDistanceFunction, getHeight, getLeaves, getSortedEntries, logStatistics, toString

Methods inherited from class de.lmu.ifi.dbs.elki.index.tree.IndexTree

createHeader, deleteNode, getFile, getNode, getNode, getPageID, getPageSize, getRoot, 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 de.lmu.ifi.dbs.elki.index.Index

logStatistics

Field Detail

relation

private Relation<O> relation

Relation indexed

Constructor Detail

MkCoPTreeIndex

public MkCoPTreeIndex(Relation<O> relation,
              PageFile<MkCoPTreeNode<O>> pageFile,
              MkTreeSettings<O,MkCoPTreeNode<O>,MkCoPEntry> settings)

Constructor.

Parameters:

relation - Relation to index.

pageFile - Page file

settings - Tree settings

Method Detail

createNewLeafEntry

protected MkCoPEntry 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<MkCoPTreeNode<O>,MkCoPEntry>

getKNNQuery

public KNNQuery<O> getKNNQuery(DistanceQuery<O> distanceQuery,
                      Object... hints)

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:

getKNNQuery in interface KNNIndex<O>

Parameters:

distanceQuery - Distance query

hints - Hints for the optimizer

Returns:

KNN Query object or null

getRangeQuery

public RangeQuery<O> getRangeQuery(DistanceQuery<O> distanceQuery,
                          Object... hints)

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:

getRangeQuery in interface RangeIndex<O>

Parameters:

distanceQuery - Distance query

hints - Hints for the optimizer

Returns:

KNN Query object or null

getRKNNQuery

public RKNNQuery<O> getRKNNQuery(DistanceQuery<O> distanceQuery,
                        Object... hints)

Description copied from interface: RKNNIndex

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:

getRKNNQuery in interface RKNNIndex<O>

Parameters:

distanceQuery - Distance query

hints - Hints for the optimizer

Returns:

KNN Query object or null

getLongName

public String getLongName()

Description copied from interface: Result

A "pretty" name for the result, for use in titles, captions and menus.

Specified by:

getLongName in interface Result

Returns:

result name

getShortName

public String getShortName()

Description copied from interface: Result

A short name for the result, useful for file names.

Specified by:

getShortName in interface Result

Returns:

result name