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

Type Parameters:

O - object type

D - distance type

All Superinterfaces:

MeasurementFunction<O,D>, Parameterizable

All Known Subinterfaces:

KernelFunction<O,D>, NormalizedSimilarityFunction<O,D>

All Known Implementing Classes:

AbstractDoubleKernelFunction, AbstractIntegerSimilarityFunction, AbstractKernelFunction, AbstractPreprocessorBasedSimilarityFunction, AbstractSimilarityFunction, ArbitraryKernelFunctionWrapper, FooKernelFunction, FractionalSharedNearestNeighborSimilarityFunction, LinearKernelFunction, PolynomialKernelFunction, SharedNearestNeighborSimilarityFunction

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

Interface SimilarityFunction describes the requirements of any similarity function.

Author:

Elke Achtert

Method Summary

D	similarity(Integer id1, Integer id2) Returns the similarity between the two objects specified by their object ids.
D	similarity(Integer id1, O o2) Returns the similarity between the two specified objects.
D	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.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

similarity

D similarity(Integer id1,
             Integer id2)

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

Parameters:

id1 - first object id

id2 - second object id

Returns:

the similarity between the two objects specified by their object ids

similarity

D similarity(Integer id1,
             O o2)

Returns the similarity between the two specified objects.

Parameters:

id1 - first object id

o2 - second DatabaseObject

Returns:

the similarity between the two objects specified by their object ids

similarity

D 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