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

java.lang.Object
- elki.distance.AbstractIndexBasedDistance.Instance<O,I,F>

Type Parameters:

O - Object type

I - Index type

F - Distance function type

All Implemented Interfaces:

DatabaseDistanceQuery<O>, DistanceQuery<O>, IndexBasedDistance.Instance<O,I>

Direct Known Subclasses:

SharedNearestNeighborJaccardDistance.Instance

Enclosing class:

AbstractIndexBasedDistance<O,F extends IndexFactory<O>>
```
public abstract static class AbstractIndexBasedDistance.Instance<O,I extends Index,F extends Distance<? super O>>
extends java.lang.Object
implements IndexBasedDistance.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
Index we use

protected F parent
Our parent distance function

protected Relation<O> relation
Relation to query.

Constructor Summary

Constructors
Constructor Description

Instance(Relation<O> relation, I index, F parent)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`F`	`getDistance()`	Get the inner distance function.
`I`	`getIndex()`	Get the index used.
`Relation<? extends O>`	`getRelation()`	Access the underlying data query.

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.distance.DatabaseDistanceQuery
distance, distance, distance

Methods inherited from interface elki.database.query.distance.DistanceQuery
distance

- Field Detail
  - relation
```
protected final Relation<O> relation
```
    Relation to query.
  - index
```
protected final I extends Index index
```
    Index we use
  - parent
```
protected F extends Distance<? super O> parent
```
    Our parent distance function
- Constructor Detail
  - Instance
```
public Instance(Relation<O> relation,
                I index,
                F parent)
```
    Constructor.
    
    Parameters:
    
    relation - Database
    
    index - Index to use
    
    parent - Parent distance function
- Method Detail
  - getRelation
```
public Relation<? extends O> getRelation()
```
    Description copied from interface: DistanceQuery
    
    Access the underlying data query.
    
    Specified by:
    
    getRelation in interface DistanceQuery<O>
    
    Returns:
    
    data query in use
  - getIndex
```
public I getIndex()
```
    Description copied from interface: IndexBasedDistance.Instance
    
    Get the index used.
    
    Specified by:
    
    getIndex in interface IndexBasedDistance.Instance<O,I extends Index>
    
    Returns:
    
    the index used
  - getDistance
```
public F getDistance()
```
    Description copied from interface: DistanceQuery
    
    Get the inner distance function.
    
    Specified by:
    
    getDistance in interface DistanceQuery<O>
    
    Returns:
    
    Distance function