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

Class ManhattanDistanceFunction

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

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={"taxicab","cityblock","l1","ManhattanDistanceFunction","de.lmu.ifi.dbs.elki.distance.distancefunction.ManhattanDistanceFunction"})
public class ManhattanDistanceFunction
extends LPNormDistanceFunction

Manhattan distance function to compute the Manhattan distance for a pair of FeatureVectors.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ManhattanDistanceFunction	STATIC The static instance to use.

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

P_ID

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
double	doubleDistance(NumberVector<?> v1, NumberVector<?> v2) Compute the Manhattan distance.
double	doubleMinDist(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the two given MBRs according to this distance function.
private double	doubleMinDistObject(SpatialComparable mbr, NumberVector<?> v)
double	doubleNorm(NumberVector<?> v) Returns the Manhattan norm of the given vector.
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 ManhattanDistanceFunction STATIC

The static instance to use.

Constructor Detail

ManhattanDistanceFunction

@Deprecated
public ManhattanDistanceFunction()

Deprecated. Use static instance!

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

Method Detail

doubleDistance

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

Compute the Manhattan distance.

Specified by:

doubleDistance in interface PrimitiveDoubleDistanceFunction<NumberVector<?>>

Overrides:

doubleDistance in class LPNormDistanceFunction

Parameters:

v1 - first vector

v2 - second vector

Returns:

Manhattan distance value

doubleNorm

public double doubleNorm(NumberVector<?> v)

Returns the Manhattan norm of the given vector.

Specified by:

doubleNorm in interface DoubleNorm<NumberVector<?>>

Overrides:

doubleNorm in class LPNormDistanceFunction

Parameters:

v - the vector to compute the norm of

Returns:

the Manhattan norm of the given vector

doubleMinDistObject

private 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