de.lmu.ifi.dbs.elki.algorithm

Class AbstractPrimitiveDistanceBasedAlgorithm<O,D extends Distance<?>,R extends Result>

java.lang.Object

de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm<R>

de.lmu.ifi.dbs.elki.algorithm.AbstractPrimitiveDistanceBasedAlgorithm<O,D,R>

Type Parameters:

O - the type of objects handled by this Algorithm

D - the type of Distance used by this Algorithm

R - the type of result to retrieve from this Algorithm

All Implemented Interfaces:

Algorithm, InspectionUtilFrequentlyScanned, Parameterizable

Direct Known Subclasses:

AbstractKMeans, DependencyDerivator

public abstract class AbstractPrimitiveDistanceBasedAlgorithm<O,D extends Distance<?>,R extends Result>
extends AbstractAlgorithm<R>

Provides an abstract algorithm already setting the distance function. This class only allows distances that are defined on arbitrary objects, not only database objects!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractPrimitiveDistanceBasedAlgorithm.Parameterizer<O,D extends Distance<D>> Parameterization helper class.

Field Summary

Fields

Modifier and Type	Field and Description
private PrimitiveDistanceFunction<? super O,D>	distanceFunction Holds the instance of the distance function specified by AbstractDistanceBasedAlgorithm.DISTANCE_FUNCTION_ID.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPrimitiveDistanceBasedAlgorithm(PrimitiveDistanceFunction<? super O,D> distanceFunction) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
PrimitiveDistanceFunction<? super O,D>	getDistanceFunction() Returns the distanceFunction.

Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm

getInputTypeRestriction, getLogger, makeParameterDistanceFunction, run

Methods inherited from class java.lang.Object

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

Field Detail

distanceFunction

private PrimitiveDistanceFunction<? super O,D extends Distance<?>> distanceFunction

Holds the instance of the distance function specified by AbstractDistanceBasedAlgorithm.DISTANCE_FUNCTION_ID.

Constructor Detail

AbstractPrimitiveDistanceBasedAlgorithm

protected AbstractPrimitiveDistanceBasedAlgorithm(PrimitiveDistanceFunction<? super O,D> distanceFunction)

Constructor.

Parameters:

distanceFunction - Distance function

Method Detail

getDistanceFunction

public PrimitiveDistanceFunction<? super O,D> getDistanceFunction()

Returns the distanceFunction.

Returns:

the distanceFunction