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 de.fu_berlin.ties.io.Storable;
25  
26  /***
27   * Provides a read-only view on {@link de.fu_berlin.ties.eval.Accuracy}
28   * statistics and the underlying raw counts.
29   *
30   * @author Christian Siefkes
31   * @version $Revision: 1.1 $, $Date: 2004/05/18 13:46:10 $, $Author: siefkes $
32   */
33  public interface AccuracyView extends Storable {
34  
35      /***
36       * Calculates and returns the <em>accuracy</em>:
37       * <em>A</em> = <em>true</em> / (<em>true</em> + <em>false</em>).
38       *
39       * @return the accuracy
40       */
41      double getAccuracy();
42  
43      /***
44       * Returns the number of false decisions.
45       * @return the number of false decisions
46       */
47      long getFalseCount();
48  
49      /***
50       * Returns the number of true decisions.
51       * @return the number of true decisions
52       */
53      long getTrueCount();
54  
55  }