de.lmu.ifi.dbs.elki.index

Class AbstractRefiningIndex<O>

java.lang.Object

de.lmu.ifi.dbs.elki.index.AbstractIndex<O>

de.lmu.ifi.dbs.elki.index.AbstractRefiningIndex<O>

Type Parameters:

O - Object type

All Implemented Interfaces:

Index, Result

Direct Known Subclasses:

InMemoryIDistanceIndex, InMemoryLSHIndex.Instance, PartialVAFile, VAFile

public abstract class AbstractRefiningIndex<O>
extends AbstractIndex<O>

Abstract base class for Filter-refinement indexes. The number of refinements will be counted as individual page accesses.

Since:

0.5.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractRefiningIndex.AbstractKNNQuery KNN query for this index.
class	AbstractRefiningIndex.AbstractRangeQuery Range query for this index.

Field Summary

Fields

Modifier and Type	Field and Description
private Counter	refinements Refinement counter.

Fields inherited from class de.lmu.ifi.dbs.elki.index.AbstractIndex

relation

Constructor Summary

Constructors

Constructor and Description
AbstractRefiningIndex(Relation<O> relation) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	countRefinements(int i) Increment the refinement counter, if in use.
abstract Logging	getLogger() Get the class logger.
void	logStatistics() Send statistics to the logger, if enabled.
protected O	refine(DBID id) Refine a given object (and count the refinement!).

Methods inherited from class de.lmu.ifi.dbs.elki.index.AbstractIndex

getLongName, getShortName

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.index.Index

initialize

Field Detail

refinements

private Counter refinements

Refinement counter.

Constructor Detail

AbstractRefiningIndex

public AbstractRefiningIndex(Relation<O> relation)

Constructor.

Parameters:

relation - Relation indexed

Method Detail

getLogger

public abstract Logging getLogger()

Get the class logger.

Returns:

Logger

countRefinements

protected void countRefinements(int i)

Increment the refinement counter, if in use.

Parameters:

i - Increment.

logStatistics

public void logStatistics()

Description copied from interface: Index

Send statistics to the logger, if enabled. Note: you must have set the logging level appropriately before initializing the index! Otherwise, the index might not have collected the desired statistics.

refine

protected O refine(DBID id)

Refine a given object (and count the refinement!).

Parameters:

id - Object id

Returns:

refined object