de.lmu.ifi.dbs.elki.index.preprocessed.knn

Class CachedDoubleDistanceKNNPreprocessor<O>

java.lang.Object

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

de.lmu.ifi.dbs.elki.index.preprocessed.AbstractPreprocessorIndex<O,T>

de.lmu.ifi.dbs.elki.index.preprocessed.knn.AbstractMaterializeKNNPreprocessor<O,DoubleDistance,DoubleDistanceKNNList>

de.lmu.ifi.dbs.elki.index.preprocessed.knn.CachedDoubleDistanceKNNPreprocessor<O>

Type Parameters:

O - Object type

All Implemented Interfaces:

Index, KNNIndex<O>, Result

public class CachedDoubleDistanceKNNPreprocessor<O>
extends AbstractMaterializeKNNPreprocessor<O,DoubleDistance,DoubleDistanceKNNList>

Preprocessor that loads an existing cached kNN result.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CachedDoubleDistanceKNNPreprocessor.Factory<O> The parameterizable factory.

Field Summary

Fields

Modifier and Type	Field and Description
private File	filename File to load.
private static Logging	LOG Class logger.

Fields inherited from class de.lmu.ifi.dbs.elki.index.preprocessed.knn.AbstractMaterializeKNNPreprocessor

distanceFunction, distanceQuery, k

Fields inherited from class de.lmu.ifi.dbs.elki.index.preprocessed.AbstractPreprocessorIndex

storage

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

relation

Constructor Summary

Constructors

Constructor and Description
CachedDoubleDistanceKNNPreprocessor(Relation<O> relation, DistanceFunction<? super O,DoubleDistance> distanceFunction, int k, File file) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected Logging	getLogger() Get the classes static logger.
String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
String	getShortName() A short name for the result, useful for file names.
void	logStatistics() Send statistics to the logger, if enabled.
protected void	preprocess() Perform the preprocessing step.

Methods inherited from class de.lmu.ifi.dbs.elki.index.preprocessed.knn.AbstractMaterializeKNNPreprocessor

createStorage, get, getDistanceFactory, getDistanceQuery, getK, getKNNQuery, initialize

Methods inherited from class java.lang.Object

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

Field Detail

filename

private File filename

File to load.

LOG

private static final Logging LOG

Class logger.

Constructor Detail

CachedDoubleDistanceKNNPreprocessor

public CachedDoubleDistanceKNNPreprocessor(Relation<O> relation,
                                   DistanceFunction<? super O,DoubleDistance> distanceFunction,
                                   int k,
                                   File file)

Constructor.

Parameters:

relation - Relation to index

distanceFunction - Distance function

k - K

file - File to load

Method Detail

preprocess

protected void preprocess()

Description copied from class: AbstractMaterializeKNNPreprocessor

Perform the preprocessing step.

Specified by:

preprocess in class AbstractMaterializeKNNPreprocessor<O,DoubleDistance,DoubleDistanceKNNList>

getLogger

protected Logging getLogger()

Description copied from class: AbstractPreprocessorIndex

Get the classes static logger.

Specified by:

getLogger in class AbstractPreprocessorIndex<O,DoubleDistanceKNNList>

Returns:

Logger

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

Specified by:

getLongName in class AbstractIndex<O>

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

Specified by:

getShortName in class AbstractIndex<O>

Returns:

result name

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.