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

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

Type Parameters:

O - Object type

I - Index type

All Implemented Interfaces:

DatabaseSimilarityQuery<O>, elki.database.query.similarity.SimilarityQuery<O>, IndexBasedSimilarity.Instance<O,I>

Enclosing class:

AbstractIndexBasedSimilarity<O,F extends elki.index.IndexFactory<O>>
```
public abstract static class AbstractIndexBasedSimilarity.Instance<O,I extends elki.index.Index>
extends java.lang.Object
implements IndexBasedSimilarity.Instance<O,I>
```
The actual instance bound to a particular database.

Author:

Erich Schubert

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  protected I index
  Parent index
  
  protected elki.database.relation.Relation<O> relation
  Relation to query.
- Constructor Summary
  
  Constructors
  Constructor Description
  
  Instance(elki.database.relation.Relation<O> relation, I index)
  Constructor.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  I getIndex()
  Get the index used.
  
  elki.database.relation.Relation<? extends O> getRelation()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface elki.database.query.similarity.DatabaseSimilarityQuery
    similarity, similarity, similarity
  - Methods inherited from interface elki.database.query.similarity.SimilarityQuery
    getSimilarity, similarity

- Field Detail
  - relation
```
protected final elki.database.relation.Relation<O> relation
```
    Relation to query.
  - index
```
protected final I extends elki.index.Index index
```
    Parent index
- Constructor Detail
  - Instance
```
public Instance(elki.database.relation.Relation<O> relation,
                I index)
```
    Constructor.
    
    Parameters:
    
    relation - Data relation
    
    index - Index to use
- Method Detail
  - getRelation
```
public elki.database.relation.Relation<? extends O> getRelation()
```
    Specified by:
    
    getRelation in interface elki.database.query.similarity.SimilarityQuery<O>
  - getIndex
```
public I getIndex()
```
    Description copied from interface: IndexBasedSimilarity.Instance
    
    Get the index used.
    
    Specified by:
    
    getIndex in interface IndexBasedSimilarity.Instance<O,I extends elki.index.Index>
    
    Returns:
    
    the index used