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

java.lang.Object
- elki.similarity.AbstractIndexBasedSimilarity<O,F>

Type Parameters:

O - object type

F - index type

All Implemented Interfaces:

IndexBasedSimilarity<O>, elki.similarity.Similarity<O>
```
public abstract class AbstractIndexBasedSimilarity<O,F extends elki.index.IndexFactory<O>>
extends java.lang.Object
implements IndexBasedSimilarity<O>
```
Abstract super class for distance functions needing a preprocessor.

Since:

0.1

Author:

Elke Achtert

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AbstractIndexBasedSimilarity.Instance<O,I extends elki.index.Index>`	The actual instance bound to a particular database.
`static class`	`AbstractIndexBasedSimilarity.Par<F extends elki.index.IndexFactory<?>>`	Parameterization class.

Field Summary

Fields
Modifier and Type Field Description

protected F indexFactory
Parameter to specify the preprocessor to be used.

Constructor Summary

Constructors
Constructor Description

AbstractIndexBasedSimilarity(F indexFactory)
Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`elki.data.type.TypeInformation`	`getInputTypeRestriction()`
`abstract <T extends O> AbstractIndexBasedSimilarity.Instance<T,?>`	`instantiate(elki.database.relation.Relation<T> database)`	Preprocess the database to get the actual distance function.
`boolean`	`isSymmetric()`

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

- Field Detail
  - indexFactory
```
protected F extends elki.index.IndexFactory<O> indexFactory
```
    Parameter to specify the preprocessor to be used.
- Constructor Detail
  - AbstractIndexBasedSimilarity
```
public AbstractIndexBasedSimilarity(F indexFactory)
```
    Constructor.
    
    Parameters:
    
    indexFactory -
- Method Detail
  - instantiate
```
public abstract <T extends O> AbstractIndexBasedSimilarity.Instance<T,?> instantiate(elki.database.relation.Relation<T> database)
```
    Description copied from interface: IndexBasedSimilarity
    
    Preprocess the database to get the actual distance function.
    
    Specified by:
    
    instantiate in interface IndexBasedSimilarity<O>
    
    Specified by:
    
    instantiate in interface elki.similarity.Similarity<O>
    
    Returns:
    
    Actual distance query.
  - isSymmetric
```
public boolean isSymmetric()
```
    Specified by:
    
    isSymmetric in interface elki.similarity.Similarity<O>
  - getInputTypeRestriction
```
public final elki.data.type.TypeInformation getInputTypeRestriction()
```
    Specified by:
    
    getInputTypeRestriction in interface elki.similarity.Similarity<O>