Package elki.index.preprocessed.snn

Class SharedNearestNeighborPreprocessor.Factory<O>

java.lang.Object

elki.index.preprocessed.snn.SharedNearestNeighborPreprocessor.Factory<O>

All Implemented Interfaces:

elki.index.IndexFactory<O>, SharedNearestNeighborIndex.Factory<O>

Enclosing class:

SharedNearestNeighborPreprocessor<O>

public static class SharedNearestNeighborPreprocessor.Factory<O>
extends java.lang.Object
implements SharedNearestNeighborIndex.Factory<O>

Factory class

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SharedNearestNeighborPreprocessor.Factory.Par<O>	Parameterization class.

Field Summary

Fields

Modifier and Type	Field	Description
static elki.utilities.optionhandling.OptionID	DISTANCE_FUNCTION_ID	Parameter to indicate the distance function to be used to ascertain the nearest neighbors.
protected elki.distance.Distance<O>	distanceFunction	Hold the distance function to be used.
static elki.utilities.optionhandling.OptionID	NUMBER_OF_NEIGHBORS_ID	Parameter to indicate the number of neighbors to be taken into account for the shared-nearest-neighbor similarity.
protected int	numberOfNeighbors	Holds the number of nearest neighbors to be used.

Constructor Summary

Constructors

Constructor	Description
Factory(int numberOfNeighbors, elki.distance.Distance<O> distance)	Constructor.

Method Summary

Modifier and Type	Method	Description
elki.data.type.TypeInformation	getInputTypeRestriction()
int	getNumberOfNeighbors()	Get the number of neighbors
SharedNearestNeighborPreprocessor<O>	instantiate(elki.database.relation.Relation<O> relation)	Instantiate the index for a given database.

Methods inherited from class java.lang.Object

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

Field Detail

NUMBER_OF_NEIGHBORS_ID

public static final elki.utilities.optionhandling.OptionID NUMBER_OF_NEIGHBORS_ID

Parameter to indicate the number of neighbors to be taken into account for the shared-nearest-neighbor similarity.

DISTANCE_FUNCTION_ID

public static final elki.utilities.optionhandling.OptionID DISTANCE_FUNCTION_ID

Parameter to indicate the distance function to be used to ascertain the nearest neighbors.

numberOfNeighbors

protected int numberOfNeighbors

Holds the number of nearest neighbors to be used.

distanceFunction

protected elki.distance.Distance<O> distanceFunction

Hold the distance function to be used.

Constructor Detail

Factory

public Factory(int numberOfNeighbors,
               elki.distance.Distance<O> distance)

Constructor.

Parameters:

numberOfNeighbors - Number of neighbors

distance - Distance function

Method Detail

instantiate

public SharedNearestNeighborPreprocessor<O> instantiate(elki.database.relation.Relation<O> relation)

Description copied from interface: SharedNearestNeighborIndex.Factory

Instantiate the index for a given database.

Specified by:

instantiate in interface elki.index.IndexFactory<O>

Specified by:

instantiate in interface SharedNearestNeighborIndex.Factory<O>

Parameters:

relation - Database type

Returns:

Index

getNumberOfNeighbors

public int getNumberOfNeighbors()

Get the number of neighbors

Specified by:

getNumberOfNeighbors in interface SharedNearestNeighborIndex.Factory<O>

Returns:

NN size

getInputTypeRestriction

public elki.data.type.TypeInformation getInputTypeRestriction()

Specified by:

getInputTypeRestriction in interface elki.index.IndexFactory<O>