fr.univnantes.termsuite.metrics

Interface SimilarityDistance

All Known Implementing Classes:

AbstractSimilarityDistance, Cosine, Jaccard

public interface SimilarityDistance

An interface for similarity distance measure between two ContextVectors.

Method Summary

Modifier and Type	Method and Description
static java.lang.Class<? extends SimilarityDistance>	forName(java.lang.String name)
ExplainedValue	getExplainedValue(ContextVector first, ContextVector second) Computes the value of the similarity distance between two ContextVectors and produces an explanation of the distance value, i.e. a list of vectors' component contributing the most to the final distance value.
double	getValue(ContextVector first, ContextVector second) Computes the value of the similarity distance between two ContextVectors.
static java.lang.Class<? extends SimilarityDistance>[]	values()

Method Detail

getValue

double getValue(ContextVector first,
                ContextVector second)

Computes the value of the similarity distance between two ContextVectors.

Parameters:

first - a context vector

second - a context vector

Returns:

the distance according to this similarity distance

getExplainedValue

ExplainedValue getExplainedValue(ContextVector first,
                                 ContextVector second)

Computes the value of the similarity distance between two ContextVectors and produces an explanation of the distance value, i.e. a list of vectors' component contributing the most to the final distance value.

Parameters:

first - a context vector

second - a context vector

Returns:

an ExplainedValue object holding both the distance value and the explanation.

See Also:

Explanation, ExplainedValue

values

static java.lang.Class<? extends SimilarityDistance>[] values()

forName

static java.lang.Class<? extends SimilarityDistance> forName(java.lang.String name)