org.lenskit.similarity

Class SpearmanRankCorrelation

java.lang.Object

org.lenskit.similarity.SpearmanRankCorrelation

All Implemented Interfaces:

java.io.Serializable, VectorSimilarity

@Shareable
 @ThreadSafe
public class SpearmanRankCorrelation
extends java.lang.Object
implements VectorSimilarity, java.io.Serializable

Similarity function using Spearman rank correlation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SpearmanRankCorrelation()
SpearmanRankCorrelation(double damping)

Method Summary

Modifier and Type	Method and Description
boolean	isSparse() Query whether this similarity function is sparse (returns 0 for vectors with disjoint key sets).
boolean	isSymmetric() Query whether this similarity function is symmetric.
double	similarity(Long2DoubleMap vec1, Long2DoubleMap vec2) Compute the similarity between two vectors.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpearmanRankCorrelation

@Inject
public SpearmanRankCorrelation(@SimilarityDamping
                                       double damping)

SpearmanRankCorrelation

public SpearmanRankCorrelation()

Method Detail

similarity

public double similarity(Long2DoubleMap vec1,
                         Long2DoubleMap vec2)

Description copied from interface: VectorSimilarity

Compute the similarity between two vectors.

Specified by:

similarity in interface VectorSimilarity

Parameters:

vec1 - The left vector to compare.

vec2 - The right vector to compare.

Returns:

The similarity, in the range [-1,1].

isSparse

public boolean isSparse()

Description copied from interface: VectorSimilarity

Query whether this similarity function is sparse (returns 0 for vectors with disjoint key sets).

Specified by:

isSparse in interface VectorSimilarity

Returns:

true iff VectorSimilarity.similarity(Long2DoubleMap, Long2DoubleMap) will always return true when applied to two vectors with no keys in common.

isSymmetric

public boolean isSymmetric()

Description copied from interface: VectorSimilarity

Query whether this similarity function is symmetric. Symmetric similarity functions return the same result when called on (A,B) and (B,A).

Specified by:

isSymmetric in interface VectorSimilarity

Returns:

true if the function is symmetric.