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

Interface SimilarityFunction<O,D extends Distance<?>>

Type Parameters:

O - object type

D - distance type

All Superinterfaces:

Parameterizable

All Known Subinterfaces:

DBIDSimilarityFunction<D>, IndexBasedSimilarityFunction<O,D>, NormalizedPrimitiveSimilarityFunction<O,D>, NormalizedSimilarityFunction<O,D>, PrimitiveSimilarityFunction<O,D>

All Known Implementing Classes:

AbstractDBIDSimilarityFunction, AbstractIndexBasedSimilarityFunction, AbstractPrimitiveSimilarityFunction, FooKernelFunction, FractionalSharedNearestNeighborSimilarityFunction, InvertedDistanceSimilarityFunction, Kulczynski1SimilarityFunction, Kulczynski2SimilarityFunction, LinearKernelFunction, PolynomialKernelFunction, SharedNearestNeighborSimilarityFunction

public interface SimilarityFunction<O,D extends Distance<?>>
extends Parameterizable

Interface SimilarityFunction describes the requirements of any similarity function.

Method Summary

Methods

Modifier and Type	Method and Description
D	getDistanceFactory() Get a distance factory.
TypeInformation	getInputTypeRestriction() Get the input data type of the function.
<T extends O> SimilarityQuery<T,D>	instantiate(Relation<T> relation) Instantiate with a representation to get the actual similarity query.
boolean	isSymmetric() Is this function symmetric?

Method Detail

isSymmetric

boolean isSymmetric()

Is this function symmetric?

Returns:

true when symmetric

getInputTypeRestriction

TypeInformation getInputTypeRestriction()

Get the input data type of the function.

getDistanceFactory

D getDistanceFactory()

Get a distance factory.

Returns:

distance factory

instantiate

<T extends O> SimilarityQuery<T,D> instantiate(Relation<T> relation)

Instantiate with a representation to get the actual similarity query.

Parameters:

relation - Representation to use

Returns:

Actual distance query.