de.lmu.ifi.dbs.elki.distance.similarityfunction

Class Kulczynski1SimilarityFunction

java.lang.Object

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

de.lmu.ifi.dbs.elki.distance.similarityfunction.Kulczynski1SimilarityFunction

All Implemented Interfaces:

DistanceFunction<NumberVector>, NumberVectorDistanceFunction<NumberVector>, PrimitiveDistanceFunction<NumberVector>, SpatialPrimitiveDistanceFunction<NumberVector>, PrimitiveSimilarityFunction<NumberVector>, SimilarityFunction<NumberVector>

@Reference(authors="M.-M. Deza, E. Deza",
           title="Dictionary of distances",
           booktitle="Dictionary of distances",
           url="https://doi.org/10.1007/978-3-642-00234-2",
           bibkey="doi:10.1007/978-3-642-00234-2")
 @Alias(value="de.lmu.ifi.dbs.elki.distance.distancefunction.Kulczynski1DistanceFunction")
public class Kulczynski1SimilarityFunction
extends AbstractNumberVectorDistanceFunction
implements SpatialPrimitiveDistanceFunction<NumberVector>, PrimitiveSimilarityFunction<NumberVector>

Kulczynski similarity 1.

\[ s_\text{Kulczynski-1}(\vec{x},\vec{y}):= \tfrac{\sum\nolimits_i\min\{x_i,y_i\}}{\sum\nolimits_i |x_i-y_i|} \] or in distance form: \[ d_\text{Kulczynski-1}(\vec{x},\vec{y}):= \tfrac{\sum\nolimits_i |x_i-y_i|}{\sum\nolimits_i\min\{x_i,y_i\}} \]

Reference:

M.-M. Deza and E. Deza
Dictionary of distances

Since:

0.6.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
Kulczynski1SimilarityFunction() Deprecated. Use STATIC instance instead.

Method Summary

Modifier and Type	Method and Description
double	distance(NumberVector v1, NumberVector v2) Computes the distance between two given DatabaseObjects according to this distance function.
<T extends NumberVector> SpatialPrimitiveDistanceSimilarityQuery<T>	instantiate(Relation<T> database) Instantiate with a database to get the actual distance query.
boolean	isSymmetric() Is this function symmetric?
double	minDist(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the two given MBRs according to this distance function.
double	similarity(NumberVector v1, NumberVector v2) Computes the similarity between two given DatabaseObjects according to this similarity function.

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

dimensionality, dimensionality, dimensionality, dimensionality, dimensionality, dimensionality, dimensionality, dimensionality, getInputTypeRestriction

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

getInputTypeRestriction

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

isMetric, isSquared

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.similarityfunction.SimilarityFunction

getInputTypeRestriction

Field Detail

STATIC

public static final Kulczynski1SimilarityFunction STATIC

Static instance.

Constructor Detail

Kulczynski1SimilarityFunction

@Deprecated
public Kulczynski1SimilarityFunction()

Deprecated. Use STATIC instance instead.

Constructor.

Method Detail

distance

public double distance(NumberVector v1,
                       NumberVector v2)

Description copied from interface: PrimitiveDistanceFunction

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

Specified by:

distance in interface NumberVectorDistanceFunction<NumberVector>

Specified by:

distance in interface PrimitiveDistanceFunction<NumberVector>

Parameters:

v1 - first DatabaseObject

v2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

minDist

public double 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>

Parameters:

mbr1 - the first MBR object

mbr2 - the second MBR object

Returns:

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

similarity

public double similarity(NumberVector v1,
                         NumberVector v2)

Description copied from interface: PrimitiveSimilarityFunction

Computes the similarity between two given DatabaseObjects according to this similarity function.

Specified by:

similarity in interface PrimitiveSimilarityFunction<NumberVector>

Parameters:

v1 - first DatabaseObject

v2 - second DatabaseObject

Returns:

the similarity between two given DatabaseObjects according to this similarity function

isSymmetric

public boolean isSymmetric()

Description copied from interface: DistanceFunction

Is this function symmetric?

Specified by:

isSymmetric in interface DistanceFunction<NumberVector>

Specified by:

isSymmetric in interface SimilarityFunction<NumberVector>

Returns:

true when symmetric

instantiate

public <T extends NumberVector> SpatialPrimitiveDistanceSimilarityQuery<T> instantiate(Relation<T> database)

Description copied from interface: DistanceFunction

Instantiate with a database to get the actual distance query.

Specified by:

instantiate in interface DistanceFunction<NumberVector>

Specified by:

instantiate in interface PrimitiveDistanceFunction<NumberVector>

Specified by:

instantiate in interface SpatialPrimitiveDistanceFunction<NumberVector>

Specified by:

instantiate in interface PrimitiveSimilarityFunction<NumberVector>

Specified by:

instantiate in interface SimilarityFunction<NumberVector>

Parameters:

database - The representation to use

Returns:

Actual distance query.