Similarity (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

Type Parameters:

O - object type

All Known Subinterfaces:

ClusteringDistanceSimilarity, DBIDSimilarity, IndexBasedSimilarity<O>, NormalizedPrimitiveSimilarity<O>, NormalizedSimilarity<O>, PrimitiveSimilarity<O>

All Known Implementing Classes:

AbstractDBIDSimilarity, AbstractIndexBasedSimilarity, AbstractVectorSimilarity, ClusteringAdjustedRandIndexSimilarity, ClusteringBCubedF1Similarity, ClusteringFowlkesMallowsSimilarity, ClusteringRandIndexSimilarity, ClusterIntersectionSimilarity, ClusterJaccardSimilarity, FractionalSharedNearestNeighborSimilarity, HellingerDistance, InvertedDistanceSimilarity, JaccardSimilarityDistance, Kulczynski1Similarity, Kulczynski2Similarity, LaplaceKernel, LinearKernel, PolynomialKernel, RadialBasisFunctionKernel, RationalQuadraticKernel, SharedNearestNeighborSimilarity, SigmoidKernel
```
public interface Similarity<O>
```
Interface Similarity describes the requirements of any similarity function.

Since:

0.1

Author:

Erich Schubert

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`TypeInformation`	`getInputTypeRestriction()`	Get the input data type of the function.
`<T extends O> SimilarityQuery<T>`	`instantiate(Relation<T> relation)`	Instantiate with a representation to get the actual similarity query.
`default boolean`	`isSymmetric()`	Is this function symmetric?

- Method Detail
  - isSymmetric
```
default boolean isSymmetric()
```
    Is this function symmetric?
    
    Returns:
    
    true when symmetric
  - getInputTypeRestriction
```
TypeInformation getInputTypeRestriction()
```
    Get the input data type of the function.
  - instantiate
```
<T extends O> SimilarityQuery<T> instantiate(Relation<T> relation)
```
    Instantiate with a representation to get the actual similarity query.
    
    Parameters:
    
    relation - Representation to use
    
    Returns:
    
    Actual distance query.