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

Class CosineDistanceFunction

java.lang.Object

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

All Implemented Interfaces:

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

@Priority(value=100)
 @Alias(value="cosine")
public class CosineDistanceFunction
extends java.lang.Object
implements SpatialPrimitiveDistanceFunction<NumberVector>, NumberVectorDistanceFunction<NumberVector>

Cosine distance function for feature vectors.

The cosine distance is computed from the cosine similarity by 1-(cosine similarity).

Cosine similarity is defined as \[ \tfrac{\vec{x}\cdot\vec{y}}{||a||\cdot||b||} \] Cosine distance then is defined as \[ 1 - \tfrac{\vec{x}\cdot\vec{y}}{||a||\cdot||b||} \in [0;2] \]

ArcCosineDistanceFunction may sometimes be more appropriate, but also more computationally expensive.

Since:

0.1

Author:

Arthur Zimek

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static CosineDistanceFunction	STATIC Static instance

Constructor Summary

Constructors

Constructor and Description
CosineDistanceFunction() Deprecated. Use static instance

Method Summary

Modifier and Type	Method and Description
double	distance(NumberVector v1, NumberVector v2) Computes the cosine distance for two given feature vectors.
boolean	equals(java.lang.Object obj)
SimpleTypeInformation<? super NumberVector>	getInputTypeRestriction() Get the input data type of the function.
int	hashCode()
double	minDist(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the two given MBRs according to this distance function.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

instantiate

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

isMetric, isSquared, isSymmetric

Field Detail

STATIC

public static final CosineDistanceFunction STATIC

Static instance

Constructor Detail

CosineDistanceFunction

@Deprecated
public CosineDistanceFunction()

Deprecated. Use static instance

Constructor - use STATIC instead.

Method Detail

distance

public double distance(NumberVector v1,
                       NumberVector v2)

Computes the cosine distance for two given feature vectors. The cosine distance is computed from the cosine similarity by 1-(cosine similarity).

Specified by:

distance in interface NumberVectorDistanceFunction<NumberVector>

Specified by:

distance in interface PrimitiveDistanceFunction<NumberVector>

Parameters:

v1 - first feature vector

v2 - second feature vector

Returns:

the cosine distance for two given feature vectors v1 and v2

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getInputTypeRestriction

public SimpleTypeInformation<? super NumberVector> getInputTypeRestriction()

Description copied from interface: DistanceFunction

Get the input data type of the function.

Specified by:

getInputTypeRestriction in interface DistanceFunction<NumberVector>

Specified by:

getInputTypeRestriction in interface PrimitiveDistanceFunction<NumberVector>

Returns:

Type restriction