fr.univnantes.termsuite.metrics

Class Explanation

java.lang.Object

fr.univnantes.termsuite.metrics.Explanation

All Implemented Interfaces:

IExplanation

public class Explanation
extends java.lang.Object
implements IExplanation

An object storing information about what can explains the value returned by a SimilarityDistance object for two ContextVectors. The explanation comes in the form of a list of Explanation.ExplanationFeature objects where each Explanation.ExplanationFeature gives a value to a co-term that appeared in both ContextVector compared. The value of an ExplainedValue does not represent any tangible reality but the bigger is that value, the most influent the associated co-term is for the Similarrity measure.

See Also:

SimilarityDistance, ContextVector, Explanation.ExplanationFeature

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Explanation.ExplanationFeature

Constructor Summary

Constructors

Constructor and Description
Explanation(int topN) Builds an explanation object.

Method Summary

Modifier and Type	Method and Description
void	addExplanation(Term coTerm, double value)
static Explanation	emptyExplanation() An empty explanation.
java.lang.String	getText()
java.util.List<Explanation.ExplanationFeature>	getTopNFeatures() Gives the top n important entries for this alignment process.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Explanation

public Explanation(int topN)

Builds an explanation object.

Parameters:

topN -

Method Detail

getTopNFeatures

public java.util.List<Explanation.ExplanationFeature> getTopNFeatures()

Gives the top n important entries for this alignment process.

Returns:

addExplanation

public void addExplanation(Term coTerm,
                           double value)

emptyExplanation

public static Explanation emptyExplanation()

An empty explanation.

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getText

public java.lang.String getText()

Specified by:

getText in interface IExplanation