de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.deliclu

Class DeLiCluTreeIndex<O extends NumberVector>

java.lang.Object

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

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

de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.AbstractRStarTree<N,E,S>

de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.NonFlatRStarTree<DeLiCluNode,DeLiCluEntry,RTreeSettings>

de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.deliclu.DeLiCluTree

de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.deliclu.DeLiCluTreeIndex<O>

Type Parameters:

O - Object type

All Implemented Interfaces:

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

public class DeLiCluTreeIndex<O extends NumberVector>
extends DeLiCluTree
implements KNNIndex<O>, RangeIndex<O>, DynamicIndex

The common use of the DeLiClu tree: indexing number vectors.

Since:

0.4.0

Author:

Erich Schubert

Nested Class Summary

Nested classes/interfaces inherited from class de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.AbstractRStarTree

AbstractRStarTree.Statistics

Field Summary

Fields

Modifier and Type	Field and Description
private static Logging	LOG The appropriate logger for this index.
private Relation<O>	relation The relation we index.

Fields inherited from class de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.AbstractRStarTree

EXTRA_INTEGRITY_CHECKS, height, 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
DeLiCluTreeIndex(Relation<O> relation, PageFile<DeLiCluNode> pagefile, RTreeSettings settings) Constructor.

Method Summary

Modifier and Type	Method and Description
protected DeLiCluLeafEntry	createNewLeafEntry(DBID id) Creates a new leaf entry representing the specified data object.
boolean	delete(DBIDRef id) Deletes the specified object from this index.
void	deleteAll(DBIDs ids) Deletes the specified objects from this index.
KNNQuery<O>	getKNNQuery(DistanceQuery<O> distanceQuery, java.lang.Object... hints) Get a KNN query object for the given distance query and k.
protected Logging	getLogger() Get the (STATIC) logger for this class.
java.lang.String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
RangeQuery<O>	getRangeQuery(DistanceQuery<O> distanceQuery, java.lang.Object... hints) Get a range query object for the given distance query and k.
java.lang.String	getShortName() A short name for the result, useful for file names.
void	initialize() Initialize the tree if the page file already existed.
void	insert(DBIDRef id) Inserts the specified real vector object into this index.
void	insertAll(DBIDs ids) Inserts the specified objects into this index.
IndexTreePath<DeLiCluEntry>	setHandled(DBID id, O obj) Marks the specified object as handled and returns the path of node ids from the root to the objects's parent.

Methods inherited from class de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.deliclu.DeLiCluTree

createNewDirectoryEntry, createNewDirectoryNode, createNewLeafNode, createRootEntry, getExpanded, getExpanded, setExpanded

Methods inherited from class de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.NonFlatRStarTree

bulkLoad, computeHeight, createEmptyRoot, hasOverflow, hasUnderflow

Methods inherited from class de.lmu.ifi.dbs.elki.index.tree.spatial.rstarvariants.AbstractRStarTree

adjustTree, canBulkLoad, choosePath, containedTest, createBulkLeafNodes, createNewRoot, deletePath, doExtraIntegrityChecks, findPathToObject, getHeight, getLeaves, initializeCapacities, initializeFromFile, insertDirectoryEntry, insertLeaf, insertLeafEntry, logStatistics, reInsert, setHeight, toString

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

createHeader, deleteNode, getDirMinimum, getFile, getLeafMinimum, getNode, getNode, getPageID, getPageSize, getRoot, getRootEntry, getRootID, getRootPath, initialize, isRoot, postDelete, preInsert, 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 extends NumberVector> relation

The relation we index.

LOG

private static final Logging LOG

The appropriate logger for this index.

Constructor Detail

DeLiCluTreeIndex

public DeLiCluTreeIndex(Relation<O> relation,
                        PageFile<DeLiCluNode> pagefile,
                        RTreeSettings settings)

Constructor.

Parameters:

relation - Relation to index

pagefile - Page file

settings - Tree settings

Method Detail

createNewLeafEntry

protected DeLiCluLeafEntry createNewLeafEntry(DBID id)

Creates a new leaf entry representing the specified data object.

Parameters:

id - Object id

setHandled

public IndexTreePath<DeLiCluEntry> setHandled(DBID id,
                                              O obj)

Marks the specified object as handled and returns the path of node ids from the root to the objects's parent.

Parameters:

id - the objects id to be marked as handled

obj - the object to be marked as handled

Returns:

the path of node ids from the root to the objects's parent

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<DeLiCluNode,DeLiCluEntry>

insert

public final void insert(DBIDRef id)

Inserts the specified real vector object into this index.

Specified by:

insert in interface DynamicIndex

Parameters:

id - the object id that was inserted

insertAll

public final void insertAll(DBIDs ids)

Inserts the specified objects into this index. If a bulk load mode is implemented, the objects are inserted in one bulk.

Specified by:

insertAll in interface DynamicIndex

Parameters:

ids - the objects to be inserted

delete

public final boolean delete(DBIDRef id)

Deletes the specified object from this index.

Specified by:

delete in interface DynamicIndex

Parameters:

id - Object to remove

Returns:

true if this index did contain the object with the specified id, false otherwise

deleteAll

public void deleteAll(DBIDs ids)

Description copied from interface: DynamicIndex

Deletes the specified objects from this index.

Specified by:

deleteAll in interface DynamicIndex

Parameters:

ids - Objects to remove

getRangeQuery

public RangeQuery<O> getRangeQuery(DistanceQuery<O> distanceQuery,
                                   java.lang.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 extends NumberVector>

Parameters:

distanceQuery - Distance query

hints - Hints for the optimizer

Returns:

KNN Query object or null

getKNNQuery

public KNNQuery<O> getKNNQuery(DistanceQuery<O> distanceQuery,
                               java.lang.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 extends NumberVector>

Parameters:

distanceQuery - Distance query

hints - Hints for the optimizer

Returns:

KNN Query object or null

getLongName

public java.lang.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 java.lang.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

getLogger

protected Logging getLogger()

Description copied from class: IndexTree

Get the (STATIC) logger for this class.

Overrides:

getLogger in class DeLiCluTree

Returns:

the static logger