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

Class LPNormDistanceFunction

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.LPNormDistanceFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

EuclideanDistanceFunction, ManhattanDistanceFunction, MaximumDistanceFunction, WeightedLPNormDistanceFunction

public class LPNormDistanceFunction
extends AbstractVectorDoubleDistanceNorm
implements SpatialPrimitiveDoubleDistanceFunction<NumberVector<?,?>>

Provides a LP-Norm for FeatureVectors.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
private double	p Keeps the currently set p.
static OptionID	P_ID OptionID for the "p" parameter

Constructor Summary

Constructors

Constructor and Description
LPNormDistanceFunction(double p) Constructor, internal version.

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.
double	doubleNorm(NumberVector<?,?> v) Compute the norm of object obj as double value.
boolean	equals(Object obj)
double	getP() Get the functions p parameter.
<T extends NumberVector<?,?>> SpatialPrimitiveDistanceQuery<T,DoubleDistance>	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?)
DoubleDistance	minDist(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the two given MBRs according to this distance function.
String	toString()

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

P_ID

public static final OptionID P_ID

OptionID for the "p" parameter

p

private double p

Keeps the currently set p.

Constructor Detail

LPNormDistanceFunction

public LPNormDistanceFunction(double p)

Constructor, internal version.

Parameters:

p - Parameter p

Method Detail

doubleDistance

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

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

Specified by:

doubleDistance in interface PrimitiveDoubleDistanceFunction<NumberVector<?,?>>

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

Parameters:

v - Object

Returns:

Double

getP

public double getP()

Get the functions p parameter.

Returns:

p

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

Parameters:

mbr1 - the first MBR object

mbr2 - the second MBR object

Returns:

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

minDist

public DoubleDistance minDist(SpatialComparable mbr1,
                     SpatialComparable mbr2)

Description copied from interface: SpatialPrimitiveDistanceFunction

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

Specified by:

minDist in interface SpatialPrimitiveDistanceFunction<NumberVector<?,?>,DoubleDistance>

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

Returns:

true when metric.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

instantiate

public <T extends NumberVector<?,?>> SpatialPrimitiveDistanceQuery<T,DoubleDistance> instantiate(Relation<T> relation)

Description copied from class: AbstractPrimitiveDistanceFunction

Instantiate with a database to get the actual distance query.

Specified by:

instantiate in interface DistanceFunction<NumberVector<?,?>,DoubleDistance>

Specified by:

instantiate in interface SpatialPrimitiveDistanceFunction<NumberVector<?,?>,DoubleDistance>

Overrides:

instantiate in class AbstractPrimitiveDistanceFunction<NumberVector<?,?>,DoubleDistance>

Parameters:

relation - Representation

Returns:

Actual distance query.