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

Class AbstractPrimitiveDistanceFunction<O>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

DistanceFunction<O>, PrimitiveDistanceFunction<O>

Direct Known Subclasses:

AbstractDimensionsSelectingDistanceFunction, AbstractNumberVectorDistanceFunction, AbstractSetDistanceFunction, LevenshteinDistanceFunction, NormalizedLevenshteinDistanceFunction, SparseLPNormDistanceFunction

public abstract class AbstractPrimitiveDistanceFunction<O>
extends Object
implements PrimitiveDistanceFunction<O>

AbstractDistanceFunction provides some methods valid for any extending class.

Since:

0.4.0

Author:

Arthur Zimek

Constructor Summary

Constructors

Constructor and Description
AbstractPrimitiveDistanceFunction() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
abstract double	distance(O o1, O o2) Computes the distance between two given DatabaseObjects according to this distance function.
<T extends O> DistanceQuery<T>	instantiate(Relation<T> relation) Instantiate with a database to get the actual distance query.
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.PrimitiveDistanceFunction

getInputTypeRestriction

Constructor Detail

AbstractPrimitiveDistanceFunction

public AbstractPrimitiveDistanceFunction()

Constructor.

Method Detail

distance

public abstract double distance(O o1,
              O o2)

Description copied from interface: PrimitiveDistanceFunction

Computes the distance between two given DatabaseObjects according to this distance function.

Specified by:

distance in interface PrimitiveDistanceFunction<O>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

isSymmetric

public boolean isSymmetric()

Description copied from interface: DistanceFunction

Is this function symmetric?

Specified by:

isSymmetric in interface DistanceFunction<O>

Returns:

true when symmetric

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>

Returns:

true when metric.

instantiate

public <T extends O> DistanceQuery<T> instantiate(Relation<T> relation)

Instantiate with a database to get the actual distance query.

Specified by:

instantiate in interface DistanceFunction<O>

Parameters:

relation - Representation

Returns:

Actual distance query.