View Javadoc

1   /*
2    * Copyright (C) 2004-2006 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 program is free software; you can redistribute it and/or modify
8    * it under the terms of the GNU General Public License as published by
9    * the Free Software Foundation; either version 2 of the License, or
10   * (at your option) any later version.
11   *
12   * This program 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
15   * GNU General Public License for more details.
16   *
17   * You should have received a copy of the GNU General Public License
18   * along with this program; if not, visit
19   * http://www.gnu.org/licenses/gpl.html or write to the Free Software
20   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
21   */
22  package de.fu_berlin.ties.eval;
23  
24  import org.apache.commons.math.stat.descriptive.StatisticalSummary;
25  
26  
27  /***
28   * Implementations of this interface can show
29   * {@linkplain org.apache.commons.math.stat.descriptive.StatisticalSummary
30   * statistical summaries} of precision, recall, and F1 metrics updated in
31   * several operations.
32   *
33   * @author Christian Siefkes
34   * @version $Revision: 1.5 $, $Date: 2006/10/21 16:04:11 $, $Author: siefkes $
35   */
36  public interface FMetricsSummary {
37  
38      /***
39        * Returns a summary view on the F1 values. This is not a snapshot but
40        * will change whenever the underlying values are changed.
41        *
42        * @return a summary view on the F1 value
43        */
44       StatisticalSummary viewF1Summary();
45  
46       /***
47        * Returns a summary view on the precision values. This is not a snapshot
48        * but will change whenever the underlying values are changed.
49        *
50        * @return a summary view on the precision value
51        */
52       StatisticalSummary viewPrecisionSummary();
53  
54       /***
55        * Returns a summary view on the recall values. This is not a snapshot but
56        * will change whenever the underlying values are changed.
57        *
58        * @return a summary view on the recall value
59        */
60       StatisticalSummary viewRecallSummary();
61  
62  }