de.lmu.ifi.dbs.elki.distance.distancefunction

Class AbstractIndexBasedDistanceFunction<O,I extends Index>

java.lang.Object

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDatabaseDistanceFunction<O>

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractIndexBasedDistanceFunction<O,I>

Type Parameters:

O - the type of object to compute the distances in between

I - the type of Index used

All Implemented Interfaces:

DistanceFunction<O>, IndexBasedDistanceFunction<O>

Direct Known Subclasses:

SharedNearestNeighborJaccardDistanceFunction

public abstract class AbstractIndexBasedDistanceFunction<O,I extends Index>
extends AbstractDatabaseDistanceFunction<O>
implements IndexBasedDistanceFunction<O>

Abstract super class for distance functions needing a database index.

Author:

Elke Achtert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractIndexBasedDistanceFunction.Instance<O,I extends Index,F extends DistanceFunction<? super O>> The actual instance bound to a particular database.
static class	AbstractIndexBasedDistanceFunction.Parameterizer<F extends IndexFactory<?,?>> Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
protected IndexFactory<O,I>	indexFactory Parameter to specify the preprocessor to be used.

Fields inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.IndexBasedDistanceFunction

INDEX_ID

Constructor Summary

Constructors

Constructor and Description
AbstractIndexBasedDistanceFunction(IndexFactory<O,I> indexFactory) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
TypeInformation	getInputTypeRestriction() Get the input data type of the function.
boolean	isMetric() Is this distance function metric (in particular, does it satisfy the triangle equation?)
boolean	isSymmetric() Is this function symmetric?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.DistanceFunction

instantiate

Field Detail

indexFactory

protected IndexFactory<O,I extends Index> indexFactory

Parameter to specify the preprocessor to be used.

Key: -distancefunction.preprocessor

Constructor Detail

AbstractIndexBasedDistanceFunction

public AbstractIndexBasedDistanceFunction(IndexFactory<O,I> indexFactory)

Constructor.

Parameters:

indexFactory - Index factory

Method Detail

isMetric

public boolean isMetric()

Description copied from interface: DistanceFunction

Is this distance function metric (in particular, does it satisfy the triangle equation?)

Specified by:

isMetric in interface DistanceFunction<O>

Overrides:

isMetric in class AbstractDatabaseDistanceFunction<O>

Returns:

true when metric.

isSymmetric

public boolean isSymmetric()

Description copied from interface: DistanceFunction

Is this function symmetric?

Specified by:

isSymmetric in interface DistanceFunction<O>

Overrides:

isSymmetric in class AbstractDatabaseDistanceFunction<O>

Returns:

true when symmetric

getInputTypeRestriction

public final TypeInformation getInputTypeRestriction()

Description copied from interface: DistanceFunction

Get the input data type of the function.

Specified by:

getInputTypeRestriction in interface DistanceFunction<O>

Returns:

Type restriction