AbstractSimilarityAdapter.Par (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- elki.distance.adapter.AbstractSimilarityAdapter.Par<O,S>

All Implemented Interfaces:

Parameterizer

Direct Known Subclasses:

ArccosSimilarityAdapter.Par, LinearSimilarityAdapter.Par, LnSimilarityAdapter.Par

Enclosing class:

AbstractSimilarityAdapter<O>
```
public abstract static class AbstractSimilarityAdapter.Par<O,S extends Similarity<? super O>>
extends java.lang.Object
implements Parameterizer
```
Parameterization class.

Author:

Erich Schubert

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.lang.Class<Similarity<? super O>>`	`ARBITRARY_SIMILARITY`	Arbitrary Similarity functions
`protected java.lang.Class<NormalizedSimilarity<? super O>>`	`NORMALIZED_SIMILARITY`	Normalized similarity functions
`static OptionID`	`SIMILARITY_FUNCTION_ID`	Parameter to specify the similarity function to derive the distance between database objects from.
`protected S`	`similarityFunction`	Holds the similarity function.

Constructor Summary

Constructors
Constructor Description

Par()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`configure(Parameterization config)`	Configure the class.
`protected abstract java.lang.Class<? extends S>`	`getSimilarityRestriction()`	Get the similarity function restriction.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface elki.utilities.optionhandling.Parameterizer
make

- Field Detail
  - SIMILARITY_FUNCTION_ID
```
public static final OptionID SIMILARITY_FUNCTION_ID
```
    Parameter to specify the similarity function to derive the distance between database objects from. Must extend Similarity .
  - similarityFunction
```
protected S extends Similarity<? super O> similarityFunction
```
    Holds the similarity function.
  - ARBITRARY_SIMILARITY
```
protected java.lang.Class<Similarity<? super O>> ARBITRARY_SIMILARITY
```
    Arbitrary Similarity functions
  - NORMALIZED_SIMILARITY
```
protected java.lang.Class<NormalizedSimilarity<? super O>> NORMALIZED_SIMILARITY
```
    Normalized similarity functions
- Constructor Detail
  - Par
```
public Par()
```
- Method Detail
  - configure
```
public void configure(Parameterization config)
```
    Description copied from interface: Parameterizer
    
    Configure the class.
    Note: the status is collected by the parameterization object, so that multiple errors may arise and be reported in one run.
    
    Specified by:
    
    configure in interface Parameterizer
    
    Parameters:
    
    config - Parameterization
  - getSimilarityRestriction
```
protected abstract java.lang.Class<? extends S> getSimilarityRestriction()
```
    Get the similarity function restriction.
    
    Returns:
    
    Distance function supported.