Package org.aksw.palmetto.calculations.direct

Class LogRatioConfirmationMeasure

java.lang.Object

org.aksw.palmetto.calculations.direct.AbstractUndefinedResultHandlingConfirmationMeasure

org.aksw.palmetto.calculations.direct.LogRatioConfirmationMeasure

All Implemented Interfaces:

ConfirmationMeasure, DirectConfirmationMeasure, LogBasedCalculation

public class LogRatioConfirmationMeasure
extends AbstractUndefinedResultHandlingConfirmationMeasure
implements LogBasedCalculation

This confirmation measure calculates the logarithm of the ratio between the joint probability of W' and W* and the product of the two marginal probabilities. result = log((P(W',W*) + e)/(P(W')*P(W*))) Another name for it is pointwise mutual information (PMI). The e is defined by LogBasedCalculation.EPSILON.

Author:

Michael Röder

Field Summary

Fields inherited from class org.aksw.palmetto.calculations.direct.AbstractUndefinedResultHandlingConfirmationMeasure

resultIfCalcUndefined

Fields inherited from interface org.aksw.palmetto.calculations.direct.LogBasedCalculation

EPSILON

Constructor Summary

Constructors

Constructor	Description
LogRatioConfirmationMeasure()
LogRatioConfirmationMeasure(double resultIfCalcUndefined)

Method Summary

Modifier and Type	Method	Description
double[]	calculateConfirmationValues(SubsetProbabilities subsetProbabilities)	Calculates the confirmation values for the given subset probabilities.
String	getName()	Returns the name of the measure.

Methods inherited from class org.aksw.palmetto.calculations.direct.AbstractUndefinedResultHandlingConfirmationMeasure

getResultIfCalcUndefined, setResultIfCalcUndefined

Methods inherited from class java.lang.Object

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

Constructor Details

LogRatioConfirmationMeasure

public LogRatioConfirmationMeasure()

LogRatioConfirmationMeasure

public LogRatioConfirmationMeasure(double resultIfCalcUndefined)

Method Details

calculateConfirmationValues

public double[] calculateConfirmationValues(SubsetProbabilities subsetProbabilities)

Description copied from interface: DirectConfirmationMeasure

Calculates the confirmation values for the given subset probabilities.

Specified by:

calculateConfirmationValues in interface DirectConfirmationMeasure

Parameters:

subsetProbabilities - subset probabilities used for the calculation

Returns:

confirmation values

getName

public String getName()

Description copied from interface: ConfirmationMeasure

Returns the name of the measure.

Specified by:

getName in interface ConfirmationMeasure

Returns:

the name of the measure.