1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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 the statistics calculated by the
28 * {@link de.fu_berlin.ties.eval.FeatureCount} class and the underlying raw
29 * counts.
30 *
31 * @author Christian Siefkes
32 * @version $Revision: 1.3 $, $Date: 2004/02/17 18:10:28 $, $Author: siefkes $
33 */
34 public interface FeatureCountView extends Storable {
35
36 /***
37 * Calculates and returns the average number of context representations in a
38 * document.
39 *
40 * @return the average number of context representations
41 */
42 double getAverageContexts();
43
44 /***
45 * Calculates and returns the average number of non-comment features in a
46 * context representation.
47 *
48 * @return the average number of features
49 */
50 double getAverageFeatures();
51
52 /***
53 * Calculates and returns the average number of unique non-comment features
54 * in a context representation.
55 *
56 * @return the average number of features
57 */
58 double getAverageUniqueFeatures();
59
60 /***
61 * Returns the number of characters counted so far. Only characters
62 * <em>within</em> features are counted; separators between different
63 * features are ignored.
64 *
65 * @return the value of the attribute
66 */
67 long getCharacters();
68
69 /***
70 * Calculates and returns the average number of characters in a context
71 * representation. Only characters <em>within</em> features are considered;
72 * separators between different features are ignored.
73 *
74 * @return the average number of characters in a context
75 */
76 double getCharactersPerContext();
77
78 /***
79 * Calculates and returns the average number of characters in a feature.
80 *
81 * @return the average number of characters in a feature
82 */
83 double getCharactersPerFeature();
84
85 /***
86 * Returns the number of representations evaluated so far.
87 * @return the value of the attribute
88 */
89 long getContexts();
90
91 /***
92 * Returns the number of documents counted so far.
93 * @return the value of the attribute
94 */
95 long getDocuments();
96
97
98 /***
99 * Returns the number of non-comment features encountered so far.
100 * @return the value of the attribute
101 */
102 long getFeatureSum();
103
104 /***
105 * Returns the number of non-comment non-duplicate features encountered so
106 * far. Duplicates within the same context representation are ignored; but
107 * equal features in different representations are not recognized as
108 * duplicate.
109 *
110 * @return the value of the attribute
111 */
112 long getUniqueFeatureSum();
113
114 }