de.lmu.ifi.dbs.elki.index

Interface Index

All Superinterfaces:

Result

All Known Subinterfaces:

FilteredLocalPCAIndex<NV>, KNNIndex<O>, LocalProjectionIndex<V,P>, PreferenceVectorIndex<NV>, RangeIndex<O>, RKNNIndex<O>, SharedNearestNeighborIndex<O>, SubspaceProjectionIndex<NV,P>

All Known Implementing Classes:

AbstractFilteredPCAIndex, AbstractIndex, AbstractMaterializeKNNPreprocessor, AbstractPreferenceVectorIndex, AbstractPreprocessorIndex, AbstractSubspaceProjectionIndex, DeLiCluTreeIndex, DiSHPreferenceVectorIndex, FourCSubspaceIndex, HiSCPreferenceVectorIndex, KNNQueryFilteredPCAIndex, MaterializeKNNAndRKNNPreprocessor, MaterializeKNNPreprocessor, MetricalIndexApproximationMaterializeKNNPreprocessor, MkAppTreeIndex, MkCoPTreeIndex, MkMaxTreeIndex, MkTabTreeIndex, MTreeIndex, PartitionApproximationMaterializeKNNPreprocessor, PreDeConSubspaceIndex, RangeQueryFilteredPCAIndex, RStarTreeIndex, SharedNearestNeighborPreprocessor, SpatialApproximationMaterializeKNNPreprocessor

public interface Index
extends Result

Interface defining the minimum requirements for all index classes.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	delete(DBID id) Deletes the specified object from this index.
void	deleteAll(DBIDs ids) Deletes the specified objects from this index.
PageFileStatistics	getPageFileStatistics() Get the underlying page file (or a proxy), for access counts.
void	insert(DBID id) Inserts the specified object into this index.
void	insertAll(DBIDs ids) Inserts the specified objects into this index.

Methods inherited from interface de.lmu.ifi.dbs.elki.result.Result

getLongName, getShortName

Method Detail

getPageFileStatistics

PageFileStatistics getPageFileStatistics()

Get the underlying page file (or a proxy), for access counts.

Returns:

page file

insert

void insert(DBID id)

Inserts the specified object into this index.

Parameters:

id - the object to be inserted

insertAll

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.

Parameters:

ids - the objects to be inserted

delete

boolean delete(DBID id)

Deletes the specified object from this index.

Parameters:

id - Object to remove

Returns:

true if this index did contain the object, false otherwise

deleteAll

void deleteAll(DBIDs ids)

Deletes the specified objects from this index.

Parameters:

ids - Objects to remove