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  /***
25   * Classes implementing this interface provide input for calculating evaluation
26   * metrics: <em>true positives</em>, <em>false negatives</em> and
27   * <em>false positives</em>.
28   *
29   * @author Christian Siefkes
30   * @version $Revision: 1.1 $, $Date: 2004/02/02 18:35:57 $, $Author: siefkes $
31   */
32  public interface EvalInput {
33  
34      /***
35       * Returns the number of false negatives (false rejections).
36       * @return the number of false negatives
37       */
38      long getFalseNeg();
39  
40      /***
41       * Returns the number of false positives (false acceptances).
42       * @return the number of false positives
43       */
44      long getFalsePos();
45  
46      /***
47       * Returns the number of true positives (correct recognitions).
48       * @return the number of true positives
49       */
50      long getTruePos();
51  
52  }