View Javadoc

1   /*
2    * Copyright (C) 2004 Christian Siefkes <christian@siefkes.net>.
3    * Development of this software is supported by the German Research Society,
4    * Berlin-Brandenburg Graduate School in Distributed Information Systems
5    * (DFG grant no. GRK 316).
6    *
7    * This library is free software; you can redistribute it and/or
8    * modify it under the terms of the GNU Lesser General Public
9    * License as published by the Free Software Foundation; either
10   * version 2.1 of the License, or (at your option) any later version.
11   *
12   * This library is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this library; if not, visit
19   * http://www.gnu.org/licenses/lgpl.html or write to the Free Software
20   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
21   */
22  package de.fu_berlin.ties.eval;
23  
24  import org.apache.commons.math.stat.StatisticalSummary;
25  
26  /***
27   * Implementations of this interface can show
28   * {@linkplain org.apache.commons.math.stat.StatisticalSummary statistical
29   * summaries} of precision, recall, and F1 metrics updated in several
30   * operations.
31   *
32   * @author Christian Siefkes
33   * @version $Revision: 1.1 $, $Date: 2004/02/19 18:15:51 $, $Author: siefkes $
34   */
35  public interface FMetricsSummary {
36  
37      /***
38        * Returns a summary view on the F1 values. This is not a snapshot but
39        * will change whenever the underlying values are changed.
40        *
41        * @return a summary view on the F1 value
42        */
43       StatisticalSummary viewF1Summary();
44  
45       /***
46        * Returns a summary view on the precision values. This is not a snapshot
47        * but will change whenever the underlying values are changed.
48        *
49        * @return a summary view on the precision value
50        */
51       StatisticalSummary viewPrecisionSummary();
52  
53       /***
54        * Returns a summary view on the recall values. This is not a snapshot but
55        * will change whenever the underlying values are changed.
56        *
57        * @return a summary view on the recall value
58        */
59       StatisticalSummary viewRecallSummary();
60  
61  }