edu.mit.jmwe.harness.result
Interface IBaseResult

All Known Subinterfaces:
IOverallResult<T,S>, ISentenceResult<T,S>
All Known Implementing Classes:
MWEResult, SentenceResult

public interface IBaseResult

Results store, at a minimum, f-measure, precision, and recall scores and the values used to calculate them.

Since:
jMWE 1.0.0
Version:
$Id: IBaseResult.java 613 2011-05-06 21:31:24Z markaf $
Author:
M.A. Finlayson

Method Summary
 double getFScore()
          Returns the F1 score, a double between zero and 1, inclusive.
 double getPrecision()
          Returns the precision, a double between zero and 1, inclusive.
 double getRecall()
          Returns the recall, a double between zero and 1, inclusive.
 int getTotalAnswers()
          Returns the total number of answers.
 int getTotalCorrect()
          Returns the total number of items correctly identified.
 int getTotalFound()
          Returns the total number items found.
 

Method Detail

getPrecision

double getPrecision()
Returns the precision, a double between zero and 1, inclusive.

Returns:
the precision, a double between zero and 1, inclusive.
Since:
jMWE 1.0.0

getRecall

double getRecall()
Returns the recall, a double between zero and 1, inclusive.

Returns:
the recall, a double between zero and 1, inclusive.
Since:
jMWE 1.0.0

getFScore

double getFScore()
Returns the F1 score, a double between zero and 1, inclusive. The F1 score, or f-measure, is the harmonic mean of the precision and the recall.

Returns:
the F1 score, a double between zero and 1, inclusive.
Since:
jMWE 1.0.0

getTotalFound

int getTotalFound()
Returns the total number items found.

Since:
jMWE 1.0.0

getTotalAnswers

int getTotalAnswers()
Returns the total number of answers.

Since:
jMWE 1.0.0

getTotalCorrect

int getTotalCorrect()
Returns the total number of items correctly identified.

Since:
jMWE 1.0.0


Copyright © 2011 Massachusetts Institute of Technology. All Rights Reserved.