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

Class EuclideanDistanceFunction

java.lang.Object

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractPrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>

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

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

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

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

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

All Implemented Interfaces:

DistanceFunction<NumberVector<?>,DoubleDistance>, DoubleNorm<NumberVector<?>>, Norm<NumberVector<?>,DoubleDistance>, NumberVectorDistanceFunction<DoubleDistance>, PrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>, PrimitiveDoubleDistanceFunction<NumberVector<?>>, SpatialPrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>, SpatialPrimitiveDoubleDistanceFunction<NumberVector<?>>, Parameterizable

@Alias(value={"euclidean","euclid","l2","EuclideanDistanceFunction","de.lmu.ifi.dbs.elki.distance.distancefunction.EuclideanDistanceFunction"})
public class EuclideanDistanceFunction
extends LPNormDistanceFunction

Provides the Euclidean distance for FeatureVectors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EuclideanDistanceFunction.Parameterizer Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
static EuclideanDistanceFunction	STATIC Static instance.

Fields inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.minkowski.LPNormDistanceFunction

P_ID

Constructor Summary

Constructors

Constructor and Description
EuclideanDistanceFunction() Deprecated. Use static instance!

Method Summary

Methods

Modifier and Type	Method and Description
double	doubleDistance(NumberVector<?> v1, NumberVector<?> v2) Returns the distance between the specified FeatureVectors as a LP-Norm for the currently set p.
double	doubleMinDist(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the two given MBRs according to this distance function.
protected double	doubleMinDistObject(SpatialComparable mbr, NumberVector<?> v)
double	doubleNorm(NumberVector<?> v) Compute the norm of object obj as double value.
boolean	equals(Object obj)
boolean	isMetric() Is this distance function metric (in particular, does it satisfy the triangle equation?)
String	toString()

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

getP

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

instantiate, minDist

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

norm

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

distance, getDistanceFactory, getInputTypeRestriction

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

isSymmetric

Methods inherited from class java.lang.Object

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

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

distance, getInputTypeRestriction

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

getDistanceFactory, isSymmetric

Field Detail

STATIC

public static final EuclideanDistanceFunction STATIC

Static instance. Use this!

Constructor Detail

EuclideanDistanceFunction

@Deprecated
public EuclideanDistanceFunction()

Deprecated. Use static instance!

Provides a Euclidean distance function that can compute the Euclidean distance (that is a DoubleDistance) for FeatureVectors.

Method Detail

doubleDistance

public double doubleDistance(NumberVector<?> v1,
                    NumberVector<?> v2)

Description copied from class: LPNormDistanceFunction

Returns the distance between the specified FeatureVectors as a LP-Norm for the currently set p.

Specified by:

doubleDistance in interface PrimitiveDoubleDistanceFunction<NumberVector<?>>

Overrides:

doubleDistance in class LPNormDistanceFunction

Parameters:

v1 - first FeatureVector

v2 - second FeatureVector

Returns:

the distance between the specified FeatureVectors as a LP-Norm for the currently set p

doubleNorm

public double doubleNorm(NumberVector<?> v)

Description copied from interface: DoubleNorm

Compute the norm of object obj as double value.

Specified by:

doubleNorm in interface DoubleNorm<NumberVector<?>>

Overrides:

doubleNorm in class LPNormDistanceFunction

Parameters:

v - Object

Returns:

Double

doubleMinDistObject

protected double doubleMinDistObject(SpatialComparable mbr,
                         NumberVector<?> v)

doubleMinDist

public double doubleMinDist(SpatialComparable mbr1,
                   SpatialComparable mbr2)

Description copied from interface: SpatialPrimitiveDoubleDistanceFunction

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

Specified by:

doubleMinDist in interface SpatialPrimitiveDoubleDistanceFunction<NumberVector<?>>

Overrides:

doubleMinDist in class LPNormDistanceFunction

Parameters:

mbr1 - the first MBR object

mbr2 - the second MBR object

Returns:

the distance between the two given MBRs according to this distance function

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<NumberVector<?>,DoubleDistance>

Overrides:

isMetric in class LPNormDistanceFunction

Returns:

true when metric.

toString

public String toString()

Overrides:

toString in class LPNormDistanceFunction

equals

public boolean equals(Object obj)

Overrides:

equals in class LPNormDistanceFunction