de.lmu.ifi.dbs.elki.distance.distancefunction

Interface DistanceFunction<O>

Type Parameters:

O - Object type

All Known Subinterfaces:

ClusteringDistanceSimilarityFunction, DBIDDistanceFunction, DBIDRangeDistanceFunction, DimensionSelectingSubspaceDistanceFunction<O>, IndexBasedDistanceFunction<O>, Norm<O>, NumberVectorDistanceFunction<O>, PrimitiveDistanceFunction<O>, SpatialPrimitiveDistanceFunction<V>, WeightedNumberVectorDistanceFunction<V>

All Known Implementing Classes:

AbsolutePearsonCorrelationDistanceFunction, AbsoluteUncenteredCorrelationDistanceFunction, AbstractDatabaseDistanceFunction, AbstractDBIDRangeDistanceFunction, AbstractDimensionsSelectingDistanceFunction, AbstractEditDistanceFunction, AbstractIndexBasedDistanceFunction, AbstractNumberVectorDistanceFunction, AbstractSetDistanceFunction, AbstractSimilarityAdapter, ArcCosineDistanceFunction, ArcCosineUnitlengthDistanceFunction, ArccosSimilarityAdapter, BrayCurtisDistanceFunction, CanberraDistanceFunction, ChiDistanceFunction, ChiSquaredDistanceFunction, ClarkDistanceFunction, ClusteringAdjustedRandIndexSimilarityFunction, ClusteringBCubedF1SimilarityFunction, ClusteringFowlkesMallowsSimilarityFunction, ClusteringRandIndexSimilarityFunction, ClusterIntersectionSimilarityFunction, ClusterJaccardSimilarityFunction, CosineDistanceFunction, CosineUnitlengthDistanceFunction, DerivativeDTWDistanceFunction, DimensionSelectingLatLngDistanceFunction, DiskCacheBasedDoubleDistanceFunction, DiskCacheBasedFloatDistanceFunction, DTWDistanceFunction, EDRDistanceFunction, ERPDistanceFunction, EuclideanDistanceFunction, FileBasedSparseDoubleDistanceFunction, FileBasedSparseFloatDistanceFunction, FisherRaoDistanceFunction, HammingDistanceFunction, HellingerDistanceFunction, HistogramIntersectionDistanceFunction, HistogramMatchDistanceFunction, HSBHistogramQuadraticDistanceFunction, JaccardSimilarityDistanceFunction, JeffreyDivergenceDistanceFunction, JensenShannonDivergenceDistanceFunction, KolmogorovSmirnovDistanceFunction, Kulczynski1SimilarityFunction, KullbackLeiblerDivergenceAsymmetricDistanceFunction, KullbackLeiblerDivergenceReverseAsymmetricDistanceFunction, LatLngDistanceFunction, LCSSDistanceFunction, LevenshteinDistanceFunction, LinearAdapterLinear, LinearKernelFunction, LngLatDistanceFunction, LnSimilarityAdapter, LPIntegerNormDistanceFunction, LPNormDistanceFunction, MahalanobisDistanceFunction, ManhattanDistanceFunction, MatrixWeightedQuadraticDistanceFunction, MaximumDistanceFunction, MinimumDistanceFunction, MultiLPNorm, NormalizedLevenshteinDistanceFunction, OnedimensionalDistanceFunction, PearsonCorrelationDistanceFunction, PolynomialKernelFunction, RandomStableDistanceFunction, RGBHistogramQuadraticDistanceFunction, SharedNearestNeighborJaccardDistanceFunction, SparseEuclideanDistanceFunction, SparseLPNormDistanceFunction, SparseManhattanDistanceFunction, SparseMaximumDistanceFunction, SparseSquaredEuclideanDistanceFunction, SqrtJensenShannonDivergenceDistanceFunction, SquaredEuclideanDistanceFunction, SquaredPearsonCorrelationDistanceFunction, SquaredUncenteredCorrelationDistanceFunction, SubspaceEuclideanDistanceFunction, SubspaceLPNormDistanceFunction, SubspaceManhattanDistanceFunction, SubspaceMaximumDistanceFunction, TriangularDiscriminationDistanceFunction, TriangularDistanceFunction, TutorialDistanceFunction, UncenteredCorrelationDistanceFunction, WeightedCanberraDistanceFunction, WeightedEuclideanDistanceFunction, WeightedLPNormDistanceFunction, WeightedManhattanDistanceFunction, WeightedMaximumDistanceFunction, WeightedPearsonCorrelationDistanceFunction, WeightedSquaredEuclideanDistanceFunction, WeightedSquaredPearsonCorrelationDistanceFunction

public interface DistanceFunction<O>

Base interface for any kind of distances.

Since:

0.1

Author:

Erich Schubert

Method Summary

Modifier and Type	Method and Description
TypeInformation	getInputTypeRestriction() Get the input data type of the function.
<T extends O> DistanceQuery<T>	instantiate(Relation<T> relation) Instantiate with a database to get the actual distance query.
default boolean	isMetric() Is this distance function metric (satisfy the triangle inequality)
default boolean	isSquared() Squared distances, that would become metric after square root.
default boolean	isSymmetric() Is this function symmetric?

Method Detail

isSymmetric

default boolean isSymmetric()

Is this function symmetric?

Returns:

true when symmetric

isMetric

default boolean isMetric()

Is this distance function metric (satisfy the triangle inequality)

Returns:

true when metric.

isSquared

default boolean isSquared()

Squared distances, that would become metric after square root. E.g. squared Euclidean.

Returns:

true when squared.

getInputTypeRestriction

TypeInformation getInputTypeRestriction()

Get the input data type of the function.

Returns:

Type restriction

instantiate

<T extends O> DistanceQuery<T> instantiate(Relation<T> relation)

Instantiate with a database to get the actual distance query.

Parameters:

relation - The representation to use

Returns:

Actual distance query.