edu.ucla.sspace.similarity

Class CosineSimilarity

java.lang.Object

edu.ucla.sspace.similarity.AbstractSymmetricSimilarityFunction

edu.ucla.sspace.similarity.CosineSimilarity

All Implemented Interfaces:

SimilarityFunction

public class CosineSimilarity
extends AbstractSymmetricSimilarityFunction

Returns the cosine similarity between any two Vectors.

This metric is symmetric.

Author:

Keith Stevens

Constructor Summary

Constructors

Constructor and Description
CosineSimilarity()

Method Summary

Methods

Modifier and Type	Method and Description
double	sim(DoubleVector v1, DoubleVector v2) Returns the similarity between v1 and v2.
double	sim(IntegerVector v1, IntegerVector v2) Returns the similarity between v1 and v2.
double	sim(Vector v1, Vector v2) Returns the similarity between v1 and v2.

Methods inherited from class edu.ucla.sspace.similarity.AbstractSymmetricSimilarityFunction

isSymmetric, setParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CosineSimilarity

public CosineSimilarity()

Method Detail

sim

public double sim(DoubleVector v1,
         DoubleVector v2)

Returns the similarity between v1 and v2. If SimilarityFunction.isSymmetric() is false, the ordering does matter.

sim

public double sim(IntegerVector v1,
         IntegerVector v2)

Returns the similarity between v1 and v2. If SimilarityFunction.isSymmetric() is false, the ordering does matter.

sim

public double sim(Vector v1,
         Vector v2)

Returns the similarity between v1 and v2. If SimilarityFunction.isSymmetric() is false, the ordering does matter.