de.lmu.ifi.dbs.elki.distance.distancefunction
Interface DistanceFunction<O extends DatabaseObject,D extends Distance<D>>

Type Parameters:

O - the type of DatabaseObject to compute the distances in between

D - the type of Distance used by this DistanceFunction

All Superinterfaces:

MeasurementFunction<O,D>, Parameterizable

All Known Subinterfaces:

KernelFunction<O,D>, SpatialDistanceFunction<V,D>

All Known Implementing Classes:

AbstractCorrelationDistanceFunction, AbstractDimensionsSelectingDoubleDistanceFunction, AbstractDistanceFunction, AbstractDoubleDistanceFunction, AbstractDoubleKernelFunction, AbstractEditDistanceFunction, AbstractFloatDistanceFunction, AbstractKernelFunction, AbstractLocallyWeightedDistanceFunction, AbstractPreferenceVectorBasedCorrelationDistanceFunction, AbstractPreprocessorBasedDistanceFunction, ArbitraryKernelFunctionWrapper, ArcCosineDistanceFunction, CosineDistanceFunction, DimensionSelectingDistanceFunction, DimensionsSelectingEuclideanDistanceFunction, DiSHDistanceFunction, DiskCacheBasedDoubleDistanceFunction, DiskCacheBasedFloatDistanceFunction, DTWDistanceFunction, EDRDistanceFunction, ERiCDistanceFunction, ERPDistanceFunction, EuclideanDistanceFunction, FileBasedDoubleDistanceFunction, FileBasedFloatDistanceFunction, FooKernelFunction, HiSCDistanceFunction, KernelBasedLocallyWeightedDistanceFunction, LCSSDistanceFunction, LinearKernelFunction, LocallyWeightedDistanceFunction, LPNormDistanceFunction, ManhattanDistanceFunction, PCABasedCorrelationDistanceFunction, PolynomialKernelFunction, RepresentationSelectingDistanceFunction, SimilarityAdapterAbstract, SimilarityAdapterArccos, SimilarityAdapterLinear, SimilarityAdapterLn, SubspaceDistanceFunction, WeightedDistanceFunction

public interface DistanceFunction<O extends DatabaseObject,D extends Distance<D>>
extends MeasurementFunction<O,D>

Interface DistanceFunction describes the requirements of any distance function.

Author:

Arthur Zimek

Method Summary

D	distance(Integer id1, Integer id2) Returns the distance between the two objects specified by their object ids.
D	distance(Integer id1, O o2) Returns the distance between the two specified objects.
D	distance(O o1, O o2) Computes the distance between two given DatabaseObjects according to this distance function.

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.MeasurementFunction

infiniteDistance, isInfiniteDistance, isNullDistance, isUndefinedDistance, nullDistance, requiredInputPattern, setDatabase, undefinedDistance, valueOf

Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable

checkGlobalParameterConstraints, collectOptions, getParameters, setParameters, shortDescription

Method Detail

distance

D distance(O o1,
           O o2)

Computes the distance between two given DatabaseObjects according to this distance function.

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

distance

D distance(Integer id1,
           Integer id2)

Returns the distance between the two objects specified by their object ids.

Parameters:

id1 - first object id

id2 - second object id

Returns:

the distance between the two objects specified by their object ids

distance

D distance(Integer id1,
           O o2)

Returns the distance between the two specified objects.

Parameters:

id1 - first object id

o2 - second DatabaseObject

Returns:

the distance between the two object specified by their object ids