retreval 0.1 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/TODO +1 -1
- data/doc/CHANGELOG.html +124 -0
- data/doc/Retreval.html +212 -0
- data/doc/Retreval/Document.html +297 -0
- data/doc/Retreval/GoldStandard.html +1013 -0
- data/doc/Retreval/Judgement.html +353 -0
- data/doc/Retreval/Options.html +406 -0
- data/doc/Retreval/Query.html +296 -0
- data/doc/Retreval/QueryResult.html +746 -0
- data/doc/Retreval/QueryResultSet.html +429 -0
- data/doc/Retreval/RankedQueryResult.html +556 -0
- data/doc/Retreval/ResultDocument.html +253 -0
- data/doc/Retreval/Runner.html +506 -0
- data/doc/Retreval/UnrankedQueryResult.html +278 -0
- data/doc/Retreval/User.html +354 -0
- data/doc/TODO.html +124 -0
- data/doc/TestGoldStandard.html +551 -0
- data/doc/TestQueryResult.html +606 -0
- data/doc/bin/retreval.html +54 -0
- data/doc/created.rid +10 -0
- data/doc/index.html +218 -0
- data/doc/lib/retreval/gold_standard_rb.html +52 -0
- data/doc/lib/retreval/options_rb.html +56 -0
- data/doc/lib/retreval/query_result_rb.html +54 -0
- data/doc/lib/retreval/runner_rb.html +56 -0
- data/doc/rdoc.css +706 -0
- data/doc/test/test_gold_standard_rb.html +56 -0
- data/doc/test/test_query_result_rb.html +58 -0
- data/lib/retreval/gold_standard.rb +6 -9
- data/lib/retreval/query_result.rb +5 -2
- data/retreval.gemspec +1 -1
- metadata +29 -2
data/TODO
CHANGED
data/doc/CHANGELOG.html
ADDED
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
4
|
+
|
|
5
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
6
|
+
<head>
|
|
7
|
+
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
|
|
8
|
+
|
|
9
|
+
<title>File: CHANGELOG [RDoc Documentation]</title>
|
|
10
|
+
|
|
11
|
+
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
|
|
12
|
+
|
|
13
|
+
<script src="./js/jquery.js" type="text/javascript"
|
|
14
|
+
charset="utf-8"></script>
|
|
15
|
+
<script src="./js/thickbox-compressed.js" type="text/javascript"
|
|
16
|
+
charset="utf-8"></script>
|
|
17
|
+
<script src="./js/quicksearch.js" type="text/javascript"
|
|
18
|
+
charset="utf-8"></script>
|
|
19
|
+
<script src="./js/darkfish.js" type="text/javascript"
|
|
20
|
+
charset="utf-8"></script>
|
|
21
|
+
</head>
|
|
22
|
+
|
|
23
|
+
<body class="file">
|
|
24
|
+
<div id="metadata">
|
|
25
|
+
<div id="home-metadata">
|
|
26
|
+
<div id="home-section" class="section">
|
|
27
|
+
<h3 class="section-header">
|
|
28
|
+
<a href="./index.html">Home</a>
|
|
29
|
+
<a href="./index.html#classes">Classes</a>
|
|
30
|
+
<a href="./index.html#methods">Methods</a>
|
|
31
|
+
</h3>
|
|
32
|
+
</div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="project-metadata">
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<div id="fileindex-section" class="section project-section">
|
|
39
|
+
<h3 class="section-header">Files</h3>
|
|
40
|
+
<ul>
|
|
41
|
+
|
|
42
|
+
<li class="file"><a href="./CHANGELOG.html">CHANGELOG</a></li>
|
|
43
|
+
|
|
44
|
+
<li class="file"><a href="./TODO.html">TODO</a></li>
|
|
45
|
+
|
|
46
|
+
</ul>
|
|
47
|
+
</div>
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
<div id="classindex-section" class="section project-section">
|
|
51
|
+
<h3 class="section-header">Class Index
|
|
52
|
+
<span class="search-toggle"><img src="./images/find.png"
|
|
53
|
+
height="16" width="16" alt="[+]"
|
|
54
|
+
title="show/hide quicksearch" /></span></h3>
|
|
55
|
+
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
|
56
|
+
<fieldset>
|
|
57
|
+
<legend>Quicksearch</legend>
|
|
58
|
+
<input type="text" name="quicksearch" value=""
|
|
59
|
+
class="quicksearch-field" />
|
|
60
|
+
</fieldset>
|
|
61
|
+
</form>
|
|
62
|
+
|
|
63
|
+
<ul class="link-list">
|
|
64
|
+
|
|
65
|
+
<li><a href="./Retreval.html">Retreval</a></li>
|
|
66
|
+
|
|
67
|
+
<li><a href="./Retreval/Document.html">Retreval::Document</a></li>
|
|
68
|
+
|
|
69
|
+
<li><a href="./Retreval/GoldStandard.html">Retreval::GoldStandard</a></li>
|
|
70
|
+
|
|
71
|
+
<li><a href="./Retreval/Judgement.html">Retreval::Judgement</a></li>
|
|
72
|
+
|
|
73
|
+
<li><a href="./Retreval/Options.html">Retreval::Options</a></li>
|
|
74
|
+
|
|
75
|
+
<li><a href="./Retreval/Query.html">Retreval::Query</a></li>
|
|
76
|
+
|
|
77
|
+
<li><a href="./Retreval/QueryResult.html">Retreval::QueryResult</a></li>
|
|
78
|
+
|
|
79
|
+
<li><a href="./Retreval/QueryResultSet.html">Retreval::QueryResultSet</a></li>
|
|
80
|
+
|
|
81
|
+
<li><a href="./Retreval/RankedQueryResult.html">Retreval::RankedQueryResult</a></li>
|
|
82
|
+
|
|
83
|
+
<li><a href="./Retreval/ResultDocument.html">Retreval::ResultDocument</a></li>
|
|
84
|
+
|
|
85
|
+
<li><a href="./Retreval/Runner.html">Retreval::Runner</a></li>
|
|
86
|
+
|
|
87
|
+
<li><a href="./Retreval/UnrankedQueryResult.html">Retreval::UnrankedQueryResult</a></li>
|
|
88
|
+
|
|
89
|
+
<li><a href="./Retreval/User.html">Retreval::User</a></li>
|
|
90
|
+
|
|
91
|
+
<li><a href="./TestGoldStandard.html">TestGoldStandard</a></li>
|
|
92
|
+
|
|
93
|
+
<li><a href="./TestQueryResult.html">TestQueryResult</a></li>
|
|
94
|
+
|
|
95
|
+
</ul>
|
|
96
|
+
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
|
97
|
+
</div>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
</div>
|
|
102
|
+
|
|
103
|
+
<div id="documentation">
|
|
104
|
+
<p>
|
|
105
|
+
<a href="CHANGELOG.html">CHANGELOG</a>
|
|
106
|
+
</p>
|
|
107
|
+
<h6>Version 0.1</h6>
|
|
108
|
+
<hr style="height: 9px"></hr><ul>
|
|
109
|
+
<li><p>
|
|
110
|
+
First public version released.
|
|
111
|
+
</p>
|
|
112
|
+
</li>
|
|
113
|
+
</ul>
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
<div id="validator-badges">
|
|
118
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
119
|
+
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
|
120
|
+
Rdoc Generator</a> 1.1.6</small>.</p>
|
|
121
|
+
</div>
|
|
122
|
+
</body>
|
|
123
|
+
</html>
|
|
124
|
+
|
data/doc/Retreval.html
ADDED
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
5
|
+
<head>
|
|
6
|
+
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
|
|
7
|
+
|
|
8
|
+
<title>Module: Retreval</title>
|
|
9
|
+
|
|
10
|
+
<link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
|
|
11
|
+
|
|
12
|
+
<script src="./js/jquery.js" type="text/javascript"
|
|
13
|
+
charset="utf-8"></script>
|
|
14
|
+
<script src="./js/thickbox-compressed.js" type="text/javascript"
|
|
15
|
+
charset="utf-8"></script>
|
|
16
|
+
<script src="./js/quicksearch.js" type="text/javascript"
|
|
17
|
+
charset="utf-8"></script>
|
|
18
|
+
<script src="./js/darkfish.js" type="text/javascript"
|
|
19
|
+
charset="utf-8"></script>
|
|
20
|
+
|
|
21
|
+
</head>
|
|
22
|
+
<body class="module">
|
|
23
|
+
|
|
24
|
+
<div id="metadata">
|
|
25
|
+
<div id="home-metadata">
|
|
26
|
+
<div id="home-section" class="section">
|
|
27
|
+
<h3 class="section-header">
|
|
28
|
+
<a href="./index.html">Home</a>
|
|
29
|
+
<a href="./index.html#classes">Classes</a>
|
|
30
|
+
<a href="./index.html#methods">Methods</a>
|
|
31
|
+
</h3>
|
|
32
|
+
</div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="file-metadata">
|
|
36
|
+
<div id="file-list-section" class="section">
|
|
37
|
+
<h3 class="section-header">In Files</h3>
|
|
38
|
+
<div class="section-body">
|
|
39
|
+
<ul>
|
|
40
|
+
|
|
41
|
+
<li><a href="./lib/retreval/gold_standard_rb.html?TB_iframe=true&height=550&width=785"
|
|
42
|
+
class="thickbox" title="lib/retreval/gold_standard.rb">lib/retreval/gold_standard.rb</a></li>
|
|
43
|
+
|
|
44
|
+
<li><a href="./lib/retreval/options_rb.html?TB_iframe=true&height=550&width=785"
|
|
45
|
+
class="thickbox" title="lib/retreval/options.rb">lib/retreval/options.rb</a></li>
|
|
46
|
+
|
|
47
|
+
<li><a href="./lib/retreval/query_result_rb.html?TB_iframe=true&height=550&width=785"
|
|
48
|
+
class="thickbox" title="lib/retreval/query_result.rb">lib/retreval/query_result.rb</a></li>
|
|
49
|
+
|
|
50
|
+
<li><a href="./lib/retreval/runner_rb.html?TB_iframe=true&height=550&width=785"
|
|
51
|
+
class="thickbox" title="lib/retreval/runner.rb">lib/retreval/runner.rb</a></li>
|
|
52
|
+
|
|
53
|
+
</ul>
|
|
54
|
+
</div>
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
|
|
60
|
+
<div id="class-metadata">
|
|
61
|
+
|
|
62
|
+
<!-- Parent Class -->
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
<!-- Namespace Contents -->
|
|
66
|
+
|
|
67
|
+
<div id="namespace-list-section" class="section">
|
|
68
|
+
<h3 class="section-header">Namespace</h3>
|
|
69
|
+
<ul class="link-list">
|
|
70
|
+
|
|
71
|
+
<li><span class="type">CLASS</span> <a href="Retreval/Document.html">Retreval::Document</a></li>
|
|
72
|
+
|
|
73
|
+
<li><span class="type">CLASS</span> <a href="Retreval/GoldStandard.html">Retreval::GoldStandard</a></li>
|
|
74
|
+
|
|
75
|
+
<li><span class="type">CLASS</span> <a href="Retreval/Judgement.html">Retreval::Judgement</a></li>
|
|
76
|
+
|
|
77
|
+
<li><span class="type">CLASS</span> <a href="Retreval/Options.html">Retreval::Options</a></li>
|
|
78
|
+
|
|
79
|
+
<li><span class="type">CLASS</span> <a href="Retreval/Query.html">Retreval::Query</a></li>
|
|
80
|
+
|
|
81
|
+
<li><span class="type">CLASS</span> <a href="Retreval/QueryResult.html">Retreval::QueryResult</a></li>
|
|
82
|
+
|
|
83
|
+
<li><span class="type">CLASS</span> <a href="Retreval/QueryResultSet.html">Retreval::QueryResultSet</a></li>
|
|
84
|
+
|
|
85
|
+
<li><span class="type">CLASS</span> <a href="Retreval/RankedQueryResult.html">Retreval::RankedQueryResult</a></li>
|
|
86
|
+
|
|
87
|
+
<li><span class="type">CLASS</span> <a href="Retreval/ResultDocument.html">Retreval::ResultDocument</a></li>
|
|
88
|
+
|
|
89
|
+
<li><span class="type">CLASS</span> <a href="Retreval/Runner.html">Retreval::Runner</a></li>
|
|
90
|
+
|
|
91
|
+
<li><span class="type">CLASS</span> <a href="Retreval/UnrankedQueryResult.html">Retreval::UnrankedQueryResult</a></li>
|
|
92
|
+
|
|
93
|
+
<li><span class="type">CLASS</span> <a href="Retreval/User.html">Retreval::User</a></li>
|
|
94
|
+
|
|
95
|
+
</ul>
|
|
96
|
+
</div>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<!-- Method Quickref -->
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
<!-- Included Modules -->
|
|
103
|
+
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
<div id="project-metadata">
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
<div id="fileindex-section" class="section project-section">
|
|
110
|
+
<h3 class="section-header">Files</h3>
|
|
111
|
+
<ul>
|
|
112
|
+
|
|
113
|
+
<li class="file"><a href="./CHANGELOG.html">CHANGELOG</a></li>
|
|
114
|
+
|
|
115
|
+
<li class="file"><a href="./TODO.html">TODO</a></li>
|
|
116
|
+
|
|
117
|
+
</ul>
|
|
118
|
+
</div>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<div id="classindex-section" class="section project-section">
|
|
122
|
+
<h3 class="section-header">Class Index
|
|
123
|
+
<span class="search-toggle"><img src="./images/find.png"
|
|
124
|
+
height="16" width="16" alt="[+]"
|
|
125
|
+
title="show/hide quicksearch" /></span></h3>
|
|
126
|
+
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
|
127
|
+
<fieldset>
|
|
128
|
+
<legend>Quicksearch</legend>
|
|
129
|
+
<input type="text" name="quicksearch" value=""
|
|
130
|
+
class="quicksearch-field" />
|
|
131
|
+
</fieldset>
|
|
132
|
+
</form>
|
|
133
|
+
|
|
134
|
+
<ul class="link-list">
|
|
135
|
+
|
|
136
|
+
<li><a href="./Retreval.html">Retreval</a></li>
|
|
137
|
+
|
|
138
|
+
<li><a href="./Retreval/Document.html">Retreval::Document</a></li>
|
|
139
|
+
|
|
140
|
+
<li><a href="./Retreval/GoldStandard.html">Retreval::GoldStandard</a></li>
|
|
141
|
+
|
|
142
|
+
<li><a href="./Retreval/Judgement.html">Retreval::Judgement</a></li>
|
|
143
|
+
|
|
144
|
+
<li><a href="./Retreval/Options.html">Retreval::Options</a></li>
|
|
145
|
+
|
|
146
|
+
<li><a href="./Retreval/Query.html">Retreval::Query</a></li>
|
|
147
|
+
|
|
148
|
+
<li><a href="./Retreval/QueryResult.html">Retreval::QueryResult</a></li>
|
|
149
|
+
|
|
150
|
+
<li><a href="./Retreval/QueryResultSet.html">Retreval::QueryResultSet</a></li>
|
|
151
|
+
|
|
152
|
+
<li><a href="./Retreval/RankedQueryResult.html">Retreval::RankedQueryResult</a></li>
|
|
153
|
+
|
|
154
|
+
<li><a href="./Retreval/ResultDocument.html">Retreval::ResultDocument</a></li>
|
|
155
|
+
|
|
156
|
+
<li><a href="./Retreval/Runner.html">Retreval::Runner</a></li>
|
|
157
|
+
|
|
158
|
+
<li><a href="./Retreval/UnrankedQueryResult.html">Retreval::UnrankedQueryResult</a></li>
|
|
159
|
+
|
|
160
|
+
<li><a href="./Retreval/User.html">Retreval::User</a></li>
|
|
161
|
+
|
|
162
|
+
<li><a href="./TestGoldStandard.html">TestGoldStandard</a></li>
|
|
163
|
+
|
|
164
|
+
<li><a href="./TestQueryResult.html">TestQueryResult</a></li>
|
|
165
|
+
|
|
166
|
+
</ul>
|
|
167
|
+
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
|
168
|
+
</div>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
</div>
|
|
172
|
+
</div>
|
|
173
|
+
|
|
174
|
+
<div id="documentation">
|
|
175
|
+
<h1 class="module">Retreval</h1>
|
|
176
|
+
|
|
177
|
+
<div id="description">
|
|
178
|
+
<p>
|
|
179
|
+
The <a href="Retreval.html">Retreval</a> allows to load and define Gold
|
|
180
|
+
Standards, add <a href="Retreval/Query.html">Query</a> Results and
|
|
181
|
+
calculate the most common metrics used in information retrieval evaluation.
|
|
182
|
+
</p>
|
|
183
|
+
|
|
184
|
+
</div>
|
|
185
|
+
|
|
186
|
+
<!-- Constants -->
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<!-- Attributes -->
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<!-- Methods -->
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
</div>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<div id="rdoc-debugging-section-dump" class="debugging-section">
|
|
199
|
+
|
|
200
|
+
<p>Disabled; run with --debug to generate this.</p>
|
|
201
|
+
|
|
202
|
+
</div>
|
|
203
|
+
|
|
204
|
+
<div id="validator-badges">
|
|
205
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
206
|
+
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
|
207
|
+
Rdoc Generator</a> 1.1.6</small>.</p>
|
|
208
|
+
</div>
|
|
209
|
+
|
|
210
|
+
</body>
|
|
211
|
+
</html>
|
|
212
|
+
|
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
5
|
+
<head>
|
|
6
|
+
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
|
|
7
|
+
|
|
8
|
+
<title>Class: Retreval::Document</title>
|
|
9
|
+
|
|
10
|
+
<link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
|
|
11
|
+
|
|
12
|
+
<script src="../js/jquery.js" type="text/javascript"
|
|
13
|
+
charset="utf-8"></script>
|
|
14
|
+
<script src="../js/thickbox-compressed.js" type="text/javascript"
|
|
15
|
+
charset="utf-8"></script>
|
|
16
|
+
<script src="../js/quicksearch.js" type="text/javascript"
|
|
17
|
+
charset="utf-8"></script>
|
|
18
|
+
<script src="../js/darkfish.js" type="text/javascript"
|
|
19
|
+
charset="utf-8"></script>
|
|
20
|
+
|
|
21
|
+
</head>
|
|
22
|
+
<body class="class">
|
|
23
|
+
|
|
24
|
+
<div id="metadata">
|
|
25
|
+
<div id="home-metadata">
|
|
26
|
+
<div id="home-section" class="section">
|
|
27
|
+
<h3 class="section-header">
|
|
28
|
+
<a href="../index.html">Home</a>
|
|
29
|
+
<a href="../index.html#classes">Classes</a>
|
|
30
|
+
<a href="../index.html#methods">Methods</a>
|
|
31
|
+
</h3>
|
|
32
|
+
</div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="file-metadata">
|
|
36
|
+
<div id="file-list-section" class="section">
|
|
37
|
+
<h3 class="section-header">In Files</h3>
|
|
38
|
+
<div class="section-body">
|
|
39
|
+
<ul>
|
|
40
|
+
|
|
41
|
+
<li><a href="../lib/retreval/gold_standard_rb.html?TB_iframe=true&height=550&width=785"
|
|
42
|
+
class="thickbox" title="lib/retreval/gold_standard.rb">lib/retreval/gold_standard.rb</a></li>
|
|
43
|
+
|
|
44
|
+
</ul>
|
|
45
|
+
</div>
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
<div id="class-metadata">
|
|
52
|
+
|
|
53
|
+
<!-- Parent Class -->
|
|
54
|
+
|
|
55
|
+
<div id="parent-class-section" class="section">
|
|
56
|
+
<h3 class="section-header">Parent</h3>
|
|
57
|
+
|
|
58
|
+
<p class="link">Object</p>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
<!-- Namespace Contents -->
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
<!-- Method Quickref -->
|
|
67
|
+
|
|
68
|
+
<div id="method-list-section" class="section">
|
|
69
|
+
<h3 class="section-header">Methods</h3>
|
|
70
|
+
<ul class="link-list">
|
|
71
|
+
|
|
72
|
+
<li><a href="#method-c-new">::new</a></li>
|
|
73
|
+
|
|
74
|
+
<li><a href="#method-i-%3D%3D">#==</a></li>
|
|
75
|
+
|
|
76
|
+
</ul>
|
|
77
|
+
</div>
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
<!-- Included Modules -->
|
|
81
|
+
|
|
82
|
+
</div>
|
|
83
|
+
|
|
84
|
+
<div id="project-metadata">
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
<div id="fileindex-section" class="section project-section">
|
|
88
|
+
<h3 class="section-header">Files</h3>
|
|
89
|
+
<ul>
|
|
90
|
+
|
|
91
|
+
<li class="file"><a href="../CHANGELOG.html">CHANGELOG</a></li>
|
|
92
|
+
|
|
93
|
+
<li class="file"><a href="../TODO.html">TODO</a></li>
|
|
94
|
+
|
|
95
|
+
</ul>
|
|
96
|
+
</div>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<div id="classindex-section" class="section project-section">
|
|
100
|
+
<h3 class="section-header">Class Index
|
|
101
|
+
<span class="search-toggle"><img src="../images/find.png"
|
|
102
|
+
height="16" width="16" alt="[+]"
|
|
103
|
+
title="show/hide quicksearch" /></span></h3>
|
|
104
|
+
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
|
105
|
+
<fieldset>
|
|
106
|
+
<legend>Quicksearch</legend>
|
|
107
|
+
<input type="text" name="quicksearch" value=""
|
|
108
|
+
class="quicksearch-field" />
|
|
109
|
+
</fieldset>
|
|
110
|
+
</form>
|
|
111
|
+
|
|
112
|
+
<ul class="link-list">
|
|
113
|
+
|
|
114
|
+
<li><a href="../Retreval.html">Retreval</a></li>
|
|
115
|
+
|
|
116
|
+
<li><a href="../Retreval/Document.html">Retreval::Document</a></li>
|
|
117
|
+
|
|
118
|
+
<li><a href="../Retreval/GoldStandard.html">Retreval::GoldStandard</a></li>
|
|
119
|
+
|
|
120
|
+
<li><a href="../Retreval/Judgement.html">Retreval::Judgement</a></li>
|
|
121
|
+
|
|
122
|
+
<li><a href="../Retreval/Options.html">Retreval::Options</a></li>
|
|
123
|
+
|
|
124
|
+
<li><a href="../Retreval/Query.html">Retreval::Query</a></li>
|
|
125
|
+
|
|
126
|
+
<li><a href="../Retreval/QueryResult.html">Retreval::QueryResult</a></li>
|
|
127
|
+
|
|
128
|
+
<li><a href="../Retreval/QueryResultSet.html">Retreval::QueryResultSet</a></li>
|
|
129
|
+
|
|
130
|
+
<li><a href="../Retreval/RankedQueryResult.html">Retreval::RankedQueryResult</a></li>
|
|
131
|
+
|
|
132
|
+
<li><a href="../Retreval/ResultDocument.html">Retreval::ResultDocument</a></li>
|
|
133
|
+
|
|
134
|
+
<li><a href="../Retreval/Runner.html">Retreval::Runner</a></li>
|
|
135
|
+
|
|
136
|
+
<li><a href="../Retreval/UnrankedQueryResult.html">Retreval::UnrankedQueryResult</a></li>
|
|
137
|
+
|
|
138
|
+
<li><a href="../Retreval/User.html">Retreval::User</a></li>
|
|
139
|
+
|
|
140
|
+
<li><a href="../TestGoldStandard.html">TestGoldStandard</a></li>
|
|
141
|
+
|
|
142
|
+
<li><a href="../TestQueryResult.html">TestQueryResult</a></li>
|
|
143
|
+
|
|
144
|
+
</ul>
|
|
145
|
+
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
|
146
|
+
</div>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
</div>
|
|
150
|
+
</div>
|
|
151
|
+
|
|
152
|
+
<div id="documentation">
|
|
153
|
+
<h1 class="class">Retreval::Document</h1>
|
|
154
|
+
|
|
155
|
+
<div id="description">
|
|
156
|
+
<p>
|
|
157
|
+
A <a href="Document.html">Document</a> is a generic resource that is
|
|
158
|
+
identified by its ID (which could be anything).
|
|
159
|
+
</p>
|
|
160
|
+
|
|
161
|
+
</div>
|
|
162
|
+
|
|
163
|
+
<!-- Constants -->
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
<!-- Attributes -->
|
|
167
|
+
|
|
168
|
+
<div id="attribute-method-details" class="method-section section">
|
|
169
|
+
<h3 class="section-header">Attributes</h3>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<div id="id-attribute-method" class="method-detail">
|
|
173
|
+
<a name="id"></a>
|
|
174
|
+
|
|
175
|
+
<div class="method-heading attribute-method-heading">
|
|
176
|
+
<span class="method-name">id</span><span
|
|
177
|
+
class="attribute-access-type">[R]</span>
|
|
178
|
+
</div>
|
|
179
|
+
|
|
180
|
+
<div class="method-description">
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
</div>
|
|
185
|
+
</div>
|
|
186
|
+
|
|
187
|
+
</div>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<!-- Methods -->
|
|
191
|
+
|
|
192
|
+
<div id="public-class-method-details" class="method-section section">
|
|
193
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
<div id="new-method" class="method-detail ">
|
|
197
|
+
<a name="method-c-new"></a>
|
|
198
|
+
|
|
199
|
+
<div class="method-heading">
|
|
200
|
+
|
|
201
|
+
<span class="method-name">new</span><span
|
|
202
|
+
class="method-args">(args)</span>
|
|
203
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
204
|
+
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
<div class="method-description">
|
|
208
|
+
|
|
209
|
+
<p>
|
|
210
|
+
Creates a new <a href="Document.html">Document</a> object with a specified
|
|
211
|
+
id
|
|
212
|
+
</p>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
<div class="method-source-code"
|
|
217
|
+
id="new-source">
|
|
218
|
+
<pre>
|
|
219
|
+
<span class="ruby-comment cmt"># File lib/retreval/gold_standard.rb, line 360</span>
|
|
220
|
+
360: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">args</span>)
|
|
221
|
+
361: <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:id</span>].<span class="ruby-identifier">to_s</span>
|
|
222
|
+
362: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Can not construct a Document with an empty identifier"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@id</span>.<span class="ruby-identifier">nil?</span>
|
|
223
|
+
363: <span class="ruby-keyword kw">end</span></pre>
|
|
224
|
+
</div>
|
|
225
|
+
|
|
226
|
+
</div>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</div>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
</div>
|
|
235
|
+
|
|
236
|
+
<div id="public-instance-method-details" class="method-section section">
|
|
237
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
<div id="--method" class="method-detail ">
|
|
241
|
+
<a name="method-i-%3D%3D"></a>
|
|
242
|
+
|
|
243
|
+
<div class="method-heading">
|
|
244
|
+
|
|
245
|
+
<span class="method-name">==</span><span
|
|
246
|
+
class="method-args">(document)</span>
|
|
247
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
248
|
+
|
|
249
|
+
</div>
|
|
250
|
+
|
|
251
|
+
<div class="method-description">
|
|
252
|
+
|
|
253
|
+
<p>
|
|
254
|
+
Compares two <a href="Document.html">Document</a> objects according to
|
|
255
|
+
their id
|
|
256
|
+
</p>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<div class="method-source-code"
|
|
261
|
+
id="--source">
|
|
262
|
+
<pre>
|
|
263
|
+
<span class="ruby-comment cmt"># File lib/retreval/gold_standard.rb, line 355</span>
|
|
264
|
+
355: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">==</span>(<span class="ruby-identifier">document</span>)
|
|
265
|
+
356: <span class="ruby-identifier">document</span>.<span class="ruby-identifier">id</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">id</span>
|
|
266
|
+
357: <span class="ruby-keyword kw">end</span></pre>
|
|
267
|
+
</div>
|
|
268
|
+
|
|
269
|
+
</div>
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
</div>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
</div>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
</div>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
<div id="rdoc-debugging-section-dump" class="debugging-section">
|
|
284
|
+
|
|
285
|
+
<p>Disabled; run with --debug to generate this.</p>
|
|
286
|
+
|
|
287
|
+
</div>
|
|
288
|
+
|
|
289
|
+
<div id="validator-badges">
|
|
290
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
291
|
+
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
|
292
|
+
Rdoc Generator</a> 1.1.6</small>.</p>
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
</body>
|
|
296
|
+
</html>
|
|
297
|
+
|