fr.univnantes.termsuite.metrics

Class AbstractSimilarityDistance

java.lang.Object

fr.univnantes.termsuite.metrics.AbstractSimilarityDistance

All Implemented Interfaces:

SimilarityDistance

Direct Known Subclasses:

Cosine, Jaccard

public abstract class AbstractSimilarityDistance
extends java.lang.Object
implements SimilarityDistance

An abstract implementation of SimilarityDistance that manages the similarity explanation.

See Also:

SimilarityDistance, Explanation

Constructor Summary

Constructors

Constructor and Description
AbstractSimilarityDistance()

Method Summary

Modifier and Type	Method and Description
ExplainedValue	getExplainedValue(ContextVector v1, ContextVector v2) 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 v1, ContextVector v2) Computes the value of the similarity distance between two ContextVectors.
protected abstract double	getValue(ContextVector source, ContextVector target, Explanation explainedValue)

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.univnantes.termsuite.metrics.SimilarityDistance

forName, values

Constructor Detail

AbstractSimilarityDistance

public AbstractSimilarityDistance()

Method Detail

getExplainedValue

public ExplainedValue getExplainedValue(ContextVector v1,
                                        ContextVector v2)

Description copied from interface: SimilarityDistance

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.

Specified by:

getExplainedValue in interface SimilarityDistance

Parameters:

v1 - a context vector

v2 - a context vector

Returns:

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

See Also:

Explanation, ExplainedValue

getValue

public double getValue(ContextVector v1,
                       ContextVector v2)

Description copied from interface: SimilarityDistance

Computes the value of the similarity distance between two ContextVectors.

Specified by:

getValue in interface SimilarityDistance

Parameters:

v1 - a context vector

v2 - a context vector

Returns:

the distance according to this similarity distance

getValue

protected abstract double getValue(ContextVector source,
                                   ContextVector target,
                                   Explanation explainedValue)