de.lmu.ifi.dbs.elki.algorithm

Class AbstractDistanceBasedAlgorithm<O,R extends Result>

java.lang.Object

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

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

Type Parameters:

O - the type of objects handled by this Algorithm

R - the type of result to retrieve from this Algorithm

All Implemented Interfaces:

Algorithm, DistanceBasedAlgorithm<O>

Direct Known Subclasses:

AbstractDBOutlier, AbstractHDBSCAN, AbstractOPTICS, AGNES, AnderbergHierarchicalClustering, AveragePrecisionAtK, CanopyPreClustering, COF, COP, CTLuGLSBackwardSearchAlgorithm, CTLuRandomWalkEC, DBSCAN, DeLiClu, DistanceQuantileSampler, DistanceStatisticsWithClasses, DWOF, EstimateIntrinsicDimensionality, EvaluateRankingQuality, EvaluateRetrievalPerformance, HilOut, IDOS, INFLO, IntrinsicDimensionalityOutlier, KDEOS, KMedoidsEM, KMedoidsPAM, KNNBenchmarkAlgorithm, KNNClassifier, KNNDistancesSampler, KNNJoin, KNNOutlier, KNNWeightOutlier, LDF, LDOF, LocalIsolationCoefficient, LOCI, LOF, LSDBC, MaterializeDistances, NaiveMeanShiftClustering, ODIN, OPTICSOF, ParallelKNNOutlier, ParallelKNNWeightOutlier, ParallelLOF, ParallelSimplifiedLOF, RangeQueryBenchmarkAlgorithm, RangeQuerySelectivity, RankingQualityHistogram, SilhouetteOutlierDetection, SimpleCOP, SimpleKernelDensityLOF, SimplifiedLOF, SLINK, ValidateApproximativeKNNIndex, VarianceOfVolume

public abstract class AbstractDistanceBasedAlgorithm<O,R extends Result>
extends AbstractAlgorithm<R>
implements DistanceBasedAlgorithm<O>

Abstract base class for distance-based algorithms.

Author:

Arthur Zimek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractDistanceBasedAlgorithm.Parameterizer<O> Parameterization helper class.

Field Summary

Fields

Modifier and Type	Field and Description
private DistanceFunction<? super O>	distanceFunction Holds the instance of the distance function specified by DistanceBasedAlgorithm.DISTANCE_FUNCTION_ID.

Fields inherited from interface de.lmu.ifi.dbs.elki.algorithm.DistanceBasedAlgorithm

DISTANCE_FUNCTION_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDistanceBasedAlgorithm(DistanceFunction<? super O> distanceFunction) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
DistanceFunction<? super O>	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

Methods inherited from interface de.lmu.ifi.dbs.elki.algorithm.Algorithm

getInputTypeRestriction, run

Field Detail

distanceFunction

private DistanceFunction<? super O> distanceFunction

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

Constructor Detail

AbstractDistanceBasedAlgorithm

protected AbstractDistanceBasedAlgorithm(DistanceFunction<? super O> distanceFunction)

Constructor.

Parameters:

distanceFunction - Distance function

Method Detail

getDistanceFunction

public DistanceFunction<? super O> getDistanceFunction()

Returns the distanceFunction.

Specified by:

getDistanceFunction in interface DistanceBasedAlgorithm<O>

Returns:

the distanceFunction