tutorial.distancefunction

Class TutorialDistanceFunction

java.lang.Object

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

tutorial.distancefunction.TutorialDistanceFunction

All Implemented Interfaces:

DistanceFunction<NumberVector>, NumberVectorDistanceFunction<NumberVector>, PrimitiveDistanceFunction<NumberVector>

public class TutorialDistanceFunction
extends AbstractNumberVectorDistanceFunction

Tutorial distance function example for ELKI.

See Distance function tutorial

Since:

0.5.0

Author:

Erich Schubert

Constructor Summary

Constructors

Constructor and Description
TutorialDistanceFunction()

Method Summary

Modifier and Type	Method and Description
double	distance(NumberVector o1, NumberVector o2) Computes the distance between two given vectors according to this distance function.
SimpleTypeInformation<? super NumberVector>	getInputTypeRestriction() Get the input data type of the function.

Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractNumberVectorDistanceFunction

dimensionality, dimensionality, dimensionality, dimensionality, dimensionality, dimensionality, dimensionality, dimensionality

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

instantiate

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

isMetric, isSquared, isSymmetric

Constructor Detail

TutorialDistanceFunction

public TutorialDistanceFunction()

Method Detail

distance

public double distance(NumberVector o1,
                       NumberVector o2)

Description copied from interface: NumberVectorDistanceFunction

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

Parameters:

o1 - first vector

o2 - second vector

Returns:

the distance between two given vectors according to this distance function

getInputTypeRestriction

public SimpleTypeInformation<? super NumberVector> getInputTypeRestriction()

Description copied from interface: DistanceFunction

Get the input data type of the function.

Specified by:

getInputTypeRestriction in interface DistanceFunction<NumberVector>

Specified by:

getInputTypeRestriction in interface PrimitiveDistanceFunction<NumberVector>

Overrides:

getInputTypeRestriction in class AbstractNumberVectorDistanceFunction

Returns:

Type restriction