de.lmu.ifi.dbs.elki.distance.similarityfunction

Interface PrimitiveSimilarityFunction<O>

Type Parameters:

O - object type

All Superinterfaces:

SimilarityFunction<O>

All Known Subinterfaces:

ClusteringDistanceSimilarityFunction, DBIDSimilarityFunction, NormalizedPrimitiveSimilarityFunction<O>

All Known Implementing Classes:

AbstractDBIDSimilarityFunction, AbstractVectorSimilarityFunction, ClusteringAdjustedRandIndexSimilarityFunction, ClusteringBCubedF1SimilarityFunction, ClusteringFowlkesMallowsSimilarityFunction, ClusteringRandIndexSimilarityFunction, ClusterIntersectionSimilarityFunction, ClusterJaccardSimilarityFunction, HellingerDistanceFunction, InvertedDistanceSimilarityFunction, JaccardSimilarityDistanceFunction, Kulczynski1SimilarityFunction, Kulczynski2SimilarityFunction, LaplaceKernelFunction, LinearKernelFunction, PolynomialKernelFunction, RadialBasisFunctionKernelFunction, RationalQuadraticKernelFunction, SigmoidKernelFunction

public interface PrimitiveSimilarityFunction<O>
extends SimilarityFunction<O>

Interface SimilarityFunction describes the requirements of any similarity function.

Since:

0.1

Author:

Elke Achtert

Method Summary

Modifier and Type	Method and Description
default <T extends O> SimilarityQuery<T>	instantiate(Relation<T> relation) Instantiate with a representation to get the actual similarity query.
double	similarity(O o1, O o2) Computes the similarity between two given DatabaseObjects according to this similarity function.

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.similarityfunction.SimilarityFunction

getInputTypeRestriction, isSymmetric

Method Detail

similarity

double similarity(O o1,
                  O o2)

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

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the similarity between two given DatabaseObjects according to this similarity function

instantiate

default <T extends O> SimilarityQuery<T> instantiate(Relation<T> relation)

Description copied from interface: SimilarityFunction

Instantiate with a representation to get the actual similarity query.

Specified by:

instantiate in interface SimilarityFunction<O>

Parameters:

relation - Representation to use

Returns:

Actual distance query.