Package elki.index.tree.spatial.rstarvariants.rstar

Class RStarTreeIndex<O extends elki.data.NumberVector>

java.lang.Object

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

elki.index.tree.spatial.rstarvariants.AbstractRStarTree<N,E,S>

elki.index.tree.spatial.rstarvariants.NonFlatRStarTree<RStarTreeNode,SpatialEntry,RTreeSettings>

elki.index.tree.spatial.rstarvariants.rstar.RStarTree

elki.index.tree.spatial.rstarvariants.rstar.RStarTreeIndex<O>

Type Parameters:

O - Object type

All Implemented Interfaces:

elki.index.DistancePriorityIndex<O>, elki.index.DynamicIndex, elki.index.Index, elki.index.KNNIndex<O>, elki.index.RangeIndex<O>

public class RStarTreeIndex<O extends elki.data.NumberVector>
extends RStarTree
implements elki.index.DistancePriorityIndex<O>, elki.index.DynamicIndex

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

Since:

0.4.0

Author:

Erich Schubert

Nested Class Summary

Nested classes/interfaces inherited from class elki.index.tree.spatial.rstarvariants.AbstractRStarTree

AbstractRStarTree.Statistics

Field Summary

Fields

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

Fields inherited from class elki.index.tree.spatial.rstarvariants.AbstractRStarTree

EXTRA_INTEGRITY_CHECKS, height, settings, statistics

Fields inherited from class elki.index.tree.IndexTree

dirCapacity, dirMinimum, initialized, leafCapacity, leafMinimum

Constructor Summary

Constructors

Constructor	Description
RStarTreeIndex(elki.database.relation.Relation<O> relation, elki.persistent.PageFile<RStarTreeNode> pagefile, RTreeSettings settings)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected SpatialPointLeafEntry	createNewLeafEntry(elki.database.ids.DBIDRef id)	Create a new leaf entry.
boolean	delete(elki.database.ids.DBIDRef id)	Deletes the specified object from this index.
void	deleteAll(elki.database.ids.DBIDs ids)
protected elki.logging.Logging	getLogger()
void	initialize()
void	insert(elki.database.ids.DBIDRef id)	Inserts the specified reel vector object into this index.
void	insertAll(elki.database.ids.DBIDs ids)	Inserts the specified objects into this index.
elki.database.query.knn.KNNSearcher<O>	kNNByObject(elki.database.query.distance.DistanceQuery<O> distanceQuery, int maxk, int flags)
elki.database.query.PrioritySearcher<O>	priorityByObject(elki.database.query.distance.DistanceQuery<O> distanceQuery, double maxradius, int flags)
elki.database.query.range.RangeSearcher<O>	rangeByObject(elki.database.query.distance.DistanceQuery<O> distanceQuery, double maxradius, int flags)

Methods inherited from class elki.index.tree.spatial.rstarvariants.rstar.RStarTree

createNewDirectoryEntry, createNewDirectoryNode, createNewLeafNode, createRootEntry

Methods inherited from class elki.index.tree.spatial.rstarvariants.NonFlatRStarTree

bulkLoad, computeHeight, createEmptyRoot, hasOverflow, hasUnderflow

Methods inherited from class elki.index.tree.spatial.rstarvariants.AbstractRStarTree

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

Methods inherited from class elki.index.tree.IndexTree

createHeader, deleteNode, getFile, getNode, getNode, getPageID, getPageSize, 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 elki.index.DistancePriorityIndex

priorityByDBID

Methods inherited from interface elki.index.Index

logStatistics

Methods inherited from interface elki.index.KNNIndex

kNNByDBID

Methods inherited from interface elki.index.RangeIndex

rangeByDBID

Field Detail

LOG

private static final elki.logging.Logging LOG

The appropriate logger for this index.

relation

private elki.database.relation.Relation<O extends elki.data.NumberVector> relation

Relation

Constructor Detail

RStarTreeIndex

public RStarTreeIndex(elki.database.relation.Relation<O> relation,
                      elki.persistent.PageFile<RStarTreeNode> pagefile,
                      RTreeSettings settings)

Constructor.

Parameters:

relation - Relation to index

pagefile - Page file

settings - Tree settings

Method Detail

createNewLeafEntry

protected SpatialPointLeafEntry createNewLeafEntry(elki.database.ids.DBIDRef id)

Create a new leaf entry.

Parameters:

id - Object id

Returns:

Spatial leaf entry

initialize

public void initialize()

Specified by:

initialize in interface elki.index.Index

Overrides:

initialize in class elki.index.tree.IndexTree<RStarTreeNode,SpatialEntry>

insert

public void insert(elki.database.ids.DBIDRef id)

Inserts the specified reel vector object into this index.

Specified by:

insert in interface elki.index.DynamicIndex

Parameters:

id - the object id that was inserted

insertAll

public void insertAll(elki.database.ids.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 elki.index.DynamicIndex

Parameters:

ids - the objects to be inserted

delete

public boolean delete(elki.database.ids.DBIDRef id)

Deletes the specified object from this index.

Specified by:

delete in interface elki.index.DynamicIndex

Returns:

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

deleteAll

public void deleteAll(elki.database.ids.DBIDs ids)

Specified by:

deleteAll in interface elki.index.DynamicIndex

kNNByObject

public elki.database.query.knn.KNNSearcher<O> kNNByObject(elki.database.query.distance.DistanceQuery<O> distanceQuery,
                                                          int maxk,
                                                          int flags)

Specified by:

kNNByObject in interface elki.index.DistancePriorityIndex<O extends elki.data.NumberVector>

Specified by:

kNNByObject in interface elki.index.KNNIndex<O extends elki.data.NumberVector>

rangeByObject

public elki.database.query.range.RangeSearcher<O> rangeByObject(elki.database.query.distance.DistanceQuery<O> distanceQuery,
                                                                double maxradius,
                                                                int flags)

Specified by:

rangeByObject in interface elki.index.DistancePriorityIndex<O extends elki.data.NumberVector>

Specified by:

rangeByObject in interface elki.index.RangeIndex<O extends elki.data.NumberVector>

priorityByObject

public elki.database.query.PrioritySearcher<O> priorityByObject(elki.database.query.distance.DistanceQuery<O> distanceQuery,
                                                                double maxradius,
                                                                int flags)

Specified by:

priorityByObject in interface elki.index.DistancePriorityIndex<O extends elki.data.NumberVector>

getLogger

protected elki.logging.Logging getLogger()

Overrides:

getLogger in class RStarTree