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

Class PartitionApproximationMaterializeKNNPreprocessor<O,D extends Distance<D>>

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,D,KNNList<D>>

de.lmu.ifi.dbs.elki.index.preprocessed.knn.PartitionApproximationMaterializeKNNPreprocessor<O,D>

Type Parameters:

O - the type of database objects the preprocessor can be applied to

D - the type of distance the used distance function will return

All Implemented Interfaces:

Index, KNNIndex<O>, Result

@Title(value="Partitioning Approximate kNN Preprocessor")
@Description(value="Caterializes the (approximate) k nearest neighbors of objects of a database by partitioning and only computing kNN within each partition.")
public class PartitionApproximationMaterializeKNNPreprocessor<O,D extends Distance<D>>
extends AbstractMaterializeKNNPreprocessor<O,D,KNNList<D>>

A preprocessor for annotation of the k nearest neighbors (and their distances) to each database object. Used for example by LOF.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PartitionApproximationMaterializeKNNPreprocessor.Factory<O,D extends Distance<D>> The parameterizable factory.

Field Summary

Fields

Modifier and Type	Field and Description
private static Logging	LOG Logger to use
private int	partitions Number of partitions to use.
private RandomFactory	rnd Random generator

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
PartitionApproximationMaterializeKNNPreprocessor(Relation<O> relation, DistanceFunction<? super O,D> distanceFunction, int k, int partitions, RandomFactory rnd) 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

LOG

private static final Logging LOG

Logger to use

partitions

private final int partitions

Number of partitions to use.

rnd

private final RandomFactory rnd

Random generator

Constructor Detail

PartitionApproximationMaterializeKNNPreprocessor

public PartitionApproximationMaterializeKNNPreprocessor(Relation<O> relation,
                                                DistanceFunction<? super O,D> distanceFunction,
                                                int k,
                                                int partitions,
                                                RandomFactory rnd)

Constructor

Parameters:

relation - Relation to process

distanceFunction - the distance function to use

k - query k

partitions - Number of partitions

rnd - Random number generator

Method Detail

preprocess

protected void preprocess()

Description copied from class: AbstractMaterializeKNNPreprocessor

Perform the preprocessing step.

Specified by:

preprocess in class AbstractMaterializeKNNPreprocessor<O,D extends Distance<D>,KNNList<D extends Distance<D>>>

getLogger

protected Logging getLogger()

Description copied from class: AbstractPreprocessorIndex

Get the classes static logger.

Specified by:

getLogger in class AbstractPreprocessorIndex<O,KNNList<D extends Distance<D>>>

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.