1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
package de.lmu.ifi.dbs.elki.evaluation.scores;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2015
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.CommonConstraints;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.IntParameter;
/**
* Evaluate using Precision@k, or R-precision (when {@code k=0}).
*
* When {@code k=0}, then it is set to the number of positive objects, and the
* returned value is the R-precision, or the precision-recall break-even-point
* (BEP).
*
* @author Erich Schubert
*/
public class PrecisionAtKEvaluation extends AbstractScoreEvaluation {
/**
* Static instance
*/
public static final PrecisionAtKEvaluation RPRECISION = new PrecisionAtKEvaluation(0);
/**
* Parameter k.
*/
int k;
/**
* Constructor.
*
* @param k k to evaluate at. May be 0.
*/
public PrecisionAtKEvaluation(int k) {
this.k = k;
}
@Override
public <I extends ScoreIter> double evaluate(Predicate<? super I> predicate, I iter) {
final int k = (this.k > 0) ? this.k : predicate.numPositive();
int total = 0;
double score = 0.;
while(iter.valid() && total < k) {
int posthis = 0, cntthis = 0;
// positive or negative match?
do {
if(predicate.test(iter)) {
++posthis;
}
++cntthis;
iter.advance();
} // Loop while tied:
while(iter.valid() && iter.tiedToPrevious());
// Special tie computations only when we reach k.
if(total + cntthis > k) {
// p = posthis / cntthis chance of being positive
// n = (k-total) draws.
// expected value = n * p
score += posthis / (double) cntthis * (k - total);
total = k;
break;
}
score += posthis;
total += cntthis;
}
return score / total;
}
@Override
public double expected(int pos, int all) {
return pos / (double) all;
}
/**
* Parameterization class.
*
* @author Erich Schubert
*
* @apiviz.exclude
*/
public static class Parameterizer extends AbstractParameterizer {
/**
* Option ID for the k parameter.
*/
public static final OptionID K_ID = new OptionID("precision.k", //
"k value for precision@k. Can be set to 0, to get R-precision, or the precision-recall-break-even-point.");
/**
* K parameter
*/
int k;
@Override
protected void makeOptions(Parameterization config) {
super.makeOptions(config);
IntParameter kP = new IntParameter(K_ID) //
.setDefaultValue(0) //
.addConstraint(CommonConstraints.GREATER_EQUAL_ZERO_INT);
if(config.grab(kP)) {
k = kP.intValue();
}
}
@Override
protected PrecisionAtKEvaluation makeInstance() {
return k > 0 ? new PrecisionAtKEvaluation(k) : RPRECISION;
}
}
}
|