de.lmu.ifi.dbs.elki.algorithm
Class DistanceBasedAlgorithm<O extends DatabaseObject,D extends Distance<D>,R extends Result>

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm<O,R>
          de.lmu.ifi.dbs.elki.algorithm.DistanceBasedAlgorithm<O,D,R>

Type Parameters:

O - the type of DatabaseObjects 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<O,R>, Parameterizable

Direct Known Subclasses:

ABOD, AbstractDBOutlier, DBSCAN, DeLiClu, DependencyDerivator, DistanceStatisticsWithClasses, EvaluateRankingQuality, INFLO, KMeans, KNNDistanceOrder, KNNJoin, KNNOutlier, KNNWeightOutlier, LDOF, LOCI, LOF, MaterializeDistances, OPTICS, OPTICSOF, RankingQualityHistogram, ReferenceBasedOutlierDetection, SLINK

public abstract class DistanceBasedAlgorithm<O extends DatabaseObject,D extends Distance<D>,R extends Result>
extends AbstractAlgorithm<O,R>

Provides an abstract algorithm already setting the distance function.

Author:

Arthur Zimek

Field Summary

static OptionID	DISTANCE_FUNCTION_ID OptionID for DISTANCE_FUNCTION_PARAM
protected ObjectParameter<DistanceFunction<O,D>>	DISTANCE_FUNCTION_PARAM Parameter to specify the distance function to determine the distance between database objects, must extend DistanceFunction.
private DistanceFunction<O,D>	distanceFunction Holds the instance of the distance function specified by DISTANCE_FUNCTION_PARAM.

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug, logger

Constructor Summary

protected

DistanceBasedAlgorithm(Parameterization config) Constructor, adhering to Parameterizable

Method Summary

D	getDistanceFactory() Returns the distance we use.
DistanceFunction<O,D>	getDistanceFunction() Returns the distanceFunction.

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

isTime, isVerbose, run, runInTime, setTime, setVerbose

Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, progress, verbose, warning

Methods inherited from class java.lang.Object

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

Field Detail

DISTANCE_FUNCTION_ID

public static final OptionID DISTANCE_FUNCTION_ID

OptionID for DISTANCE_FUNCTION_PARAM

DISTANCE_FUNCTION_PARAM

protected final ObjectParameter<DistanceFunction<O extends DatabaseObject,D extends Distance<D>>> DISTANCE_FUNCTION_PARAM

Parameter to specify the distance function to determine the distance between database objects, must extend DistanceFunction.

Key: -algorithm.distancefunction

Default value: EuclideanDistanceFunction

distanceFunction

private DistanceFunction<O extends DatabaseObject,D extends Distance<D>> distanceFunction

Holds the instance of the distance function specified by DISTANCE_FUNCTION_PARAM.

Constructor Detail

DistanceBasedAlgorithm

protected DistanceBasedAlgorithm(Parameterization config)

Constructor, adhering to Parameterizable

Parameters:

config - Parameterization

Method Detail

getDistanceFunction

public DistanceFunction<O,D> getDistanceFunction()

Returns the distanceFunction.

Returns:

the distanceFunction

getDistanceFactory

public D getDistanceFactory()

Returns the distance we use.

Returns:

the distance