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

Class RandomSampleKNNPreprocessor<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,KNNResult<D>>

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

Type Parameters:

O - Object type

D - Distance type

All Implemented Interfaces:

Index, KNNIndex<O>, Result

public class RandomSampleKNNPreprocessor<O,D extends Distance<D>>
extends AbstractMaterializeKNNPreprocessor<O,D,KNNResult<D>>

Class that computed the kNN only on a random sample.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
private static Logging	logger Logger
private Long	seed Random seed
private double	share Relative share of objects to get

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
RandomSampleKNNPreprocessor(Relation<O> relation, DistanceFunction<? super O,D> distanceFunction, int k, double share, Long seed) 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.
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, insertAll

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

delete, deleteAll, getPageFileStatistics, insert

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

delete, deleteAll, getPageFileStatistics, insert

Field Detail

logger

private static final Logging logger

Logger

share

private final double share

Relative share of objects to get

seed

private final Long seed

Random seed

Constructor Detail

RandomSampleKNNPreprocessor

public RandomSampleKNNPreprocessor(Relation<O> relation,
                           DistanceFunction<? super O,D> distanceFunction,
                           int k,
                           double share,
                           Long seed)

Constructor.

Parameters:

relation - Relation to index

distanceFunction - distance function

k - k

share - Relative share

seed - Random seed (may be null)

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>,KNNResult<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,KNNResult<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