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

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

All Implemented Interfaces:

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

public class MinimumDistanceFunction
extends AbstractVectorDoubleDistanceFunction
implements SpatialPrimitiveDoubleDistanceFunction<NumberVector<?,?>>

Maximum distance function to compute the Minimum distance for a pair of FeatureVectors.

Nested Class Summary

static class

MinimumDistanceFunction.Parameterizer Parameterization class.

Field Summary

static MinimumDistanceFunction

STATIC Static instance.

Constructor Summary

MinimumDistanceFunction()
Deprecated. Use static instance!

Method Summary

DoubleDistance	centerDistance(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the centroids of the two given MBRs according to this distance function.
double	doubleCenterDistance(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the centroids of the two given MBRs according to this distance function.
double	doubleDistance(NumberVector<?,?> v1, NumberVector<?,?> v2) Computes the distance between two given Objects according to this distance function.
double	doubleMinDist(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the two given MBRs according to this distance function.
boolean	equals(Object obj)
<T extends NumberVector<?,?>> SpatialPrimitiveDistanceQuery<T,DoubleDistance>	instantiate(Relation<T> relation) Instantiate with a database to get the actual distance query.
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.AbstractVectorDoubleDistanceFunction

distance, getDistanceFactory, getInputTypeRestriction

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

isMetric, 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, isMetric, isSymmetric

Field Detail

STATIC

public static final MinimumDistanceFunction STATIC

Static instance. Use this.

Constructor Detail

MinimumDistanceFunction

@Deprecated
public MinimumDistanceFunction()

Deprecated. Use static instance!

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

Method Detail

doubleDistance

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

Description copied from interface: PrimitiveDoubleDistanceFunction

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

Specified by:

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

Parameters:

v1 - first Object

v2 - second Object

Returns:

the distance between two given Objects according to this distance function

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

doubleCenterDistance

public double doubleCenterDistance(SpatialComparable mbr1,
                                   SpatialComparable mbr2)

Description copied from interface: SpatialPrimitiveDoubleDistanceFunction

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

Specified by:

doubleCenterDistance in interface SpatialPrimitiveDoubleDistanceFunction<NumberVector<?,?>>

Parameters:

mbr1 - the first MBR object

mbr2 - the second MBR object

Returns:

the distance between the centroids of 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

centerDistance

public DoubleDistance centerDistance(SpatialComparable mbr1,
                                     SpatialComparable mbr2)

Description copied from interface: SpatialPrimitiveDistanceFunction

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

Specified by:

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

Parameters:

mbr1 - the first MBR object

mbr2 - the second MBR object

Returns:

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

toString

public String toString()

Overrides:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object