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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::MSetIterator Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.5.9 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
var num=this.id.replace(/[^[0-9]/g,'');
var button=this.firstChild;
var sectionDiv=document.getElementById('dynsection'+num);
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
sectionDiv.style.display='block';
button.src='open.gif';
}else{
sectionDiv.style.display='none';
button.src='closed.gif';
}
}
function initDynSections(){
var divs=document.getElementsByTagName('div');
var sectionCounter=1;
for(var i=0;i<divs.length-1;i++){
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
var header=divs[i];
var section=divs[i+1];
var button=header.firstChild;
if (button!='IMG'){
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
button=document.createElement('img');
divs[i].insertBefore(button,divs[i].firstChild);
}
header.style.cursor='pointer';
header.onclick=changeDisplayState;
header.id='dynheader'+sectionCounter;
button.src='closed.gif';
section.id='dynsection'+sectionCounter;
section.style.display='none';
section.style.marginLeft='14px';
sectionCounter++;
}
}
}
window.onload = initDynSections;
-->
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a>
</div>
</div>
<div class="contents">
<h1>Xapian::MSetIterator Class Reference</h1><!-- doxytag: class="Xapian::MSetIterator" -->An iterator pointing to items in an <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<a href="#_details">More...</a>
<p>
<p>
<a href="classXapian_1_1MSetIterator-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5e6296943b75d873cc6e21cb04a7bf44"></a><!-- doxytag: member="Xapian::MSetIterator::iterator_category" ref="5e6296943b75d873cc6e21cb04a7bf44" args="" -->
typedef <br class="typebreak">
std::bidirectional_iterator_tag </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#5e6296943b75d873cc6e21cb04a7bf44">iterator_category</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="20dc0a349ee3a6c13e88b3930be2d1e3"></a><!-- doxytag: member="Xapian::MSetIterator::value_type" ref="20dc0a349ee3a6c13e88b3930be2d1e3" args="" -->
typedef <a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#20dc0a349ee3a6c13e88b3930be2d1e3">value_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="99f8773f332ef160d17056ee47f665a7"></a><!-- doxytag: member="Xapian::MSetIterator::difference_type" ref="99f8773f332ef160d17056ee47f665a7" args="" -->
typedef <a class="el" href="namespaceXapian.html#958ff32fd7a85f2b8a4784ac18397f2b">Xapian::doccount_diff</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#99f8773f332ef160d17056ee47f665a7">difference_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b82ce0bb3c82847d99e4ea81d51d02c5"></a><!-- doxytag: member="Xapian::MSetIterator::pointer" ref="b82ce0bb3c82847d99e4ea81d51d02c5" args="" -->
typedef <a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#b82ce0bb3c82847d99e4ea81d51d02c5">pointer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="53ca63620c8714a477ae2d930b84012a"></a><!-- doxytag: member="Xapian::MSetIterator::reference" ref="53ca63620c8714a477ae2d930b84012a" args="" -->
typedef <a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#53ca63620c8714a477ae2d930b84012a">reference</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="24089616ca88737d235d50fe39c10a5b"></a><!-- doxytag: member="Xapian::MSetIterator::MSetIterator" ref="24089616ca88737d235d50fe39c10a5b" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#24089616ca88737d235d50fe39c10a5b">MSetIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an uninitialised iterator; this cannot be used, but is convenient syntactically. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65b8ccf4acd764feb8c29afc0f25e5ac"></a><!-- doxytag: member="Xapian::MSetIterator::MSetIterator" ref="65b8ccf4acd764feb8c29afc0f25e5ac" args="(const MSetIterator &other)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#65b8ccf4acd764feb8c29afc0f25e5ac">MSetIterator</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed (and is cheap). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="109ec6c9a89d390ac82479905ae2b5e1"></a><!-- doxytag: member="Xapian::MSetIterator::operator=" ref="109ec6c9a89d390ac82479905ae2b5e1" args="(const MSetIterator &other)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#109ec6c9a89d390ac82479905ae2b5e1">operator=</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed (and is cheap). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4ac6e0c3cac3be285be16b1bf5bf490"></a><!-- doxytag: member="Xapian::MSetIterator::operator++" ref="d4ac6e0c3cac3be285be16b1bf5bf490" args="()" -->
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#d4ac6e0c3cac3be285be16b1bf5bf490">operator++</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fa449795683d7ffe7387db58373d6fee"></a><!-- doxytag: member="Xapian::MSetIterator::operator++" ref="fa449795683d7ffe7387db58373d6fee" args="(int)" -->
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#fa449795683d7ffe7387db58373d6fee">operator++</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator (postfix variant). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b904a30ffcd05700a908ee7e9645a61"></a><!-- doxytag: member="Xapian::MSetIterator::operator--" ref="4b904a30ffcd05700a908ee7e9645a61" args="()" -->
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#4b904a30ffcd05700a908ee7e9645a61">operator--</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrement the iterator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dadef547ef6a82c35d6a78b2187a56c4"></a><!-- doxytag: member="Xapian::MSetIterator::operator--" ref="dadef547ef6a82c35d6a78b2187a56c4" args="(int)" -->
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#dadef547ef6a82c35d6a78b2187a56c4">operator--</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrement the iterator (postfix variant). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6adc92605d7218bdd11db5fb19e68f7e"></a><!-- doxytag: member="Xapian::MSetIterator::operator*" ref="6adc92605d7218bdd11db5fb19e68f7e" args="() const " -->
<a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#6adc92605d7218bdd11db5fb19e68f7e">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the document ID for the current position. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#b3cd71bd6aa3b5677eacf99f369e482c">get_document</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database.">Xapian::Document</a> object for the current position. <a href="#b3cd71bd6aa3b5677eacf99f369e482c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#7921b513e0e0b055134c8c1c8264a149">get_rank</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the rank of the document at the current position. <a href="#7921b513e0e0b055134c8c1c8264a149"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0cdaf0f122fb363b2bbff50ec8d1a00"></a><!-- doxytag: member="Xapian::MSetIterator::get_weight" ref="b0cdaf0f122fb363b2bbff50ec8d1a00" args="() const " -->
<a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#b0cdaf0f122fb363b2bbff50ec8d1a00">get_weight</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the weight of the document at the current position. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a0c5216cb505912318e6a552725e3af"></a><!-- doxytag: member="Xapian::MSetIterator::get_collapse_key" ref="5a0c5216cb505912318e6a552725e3af" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#5a0c5216cb505912318e6a552725e3af">get_collapse_key</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the collapse key for this document. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#4d2d8fae854bc997dd417234061a3fe2">get_collapse_count</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an estimate of the number of documents that have been collapsed into this one. <a href="#4d2d8fae854bc997dd417234061a3fe2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#22ea0a80c58a2047dd929621b75ed9a2">Xapian::percent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#99514c11a9291175d20fafa73a0839fd">get_percent</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This returns the weight of the document as a percentage score. <a href="#99514c11a9291175d20fafa73a0839fd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95d1c5a337e5f128e58bf68745b036c2"></a><!-- doxytag: member="Xapian::MSetIterator::get_description" ref="95d1c5a337e5f128e58bf68745b036c2" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#95d1c5a337e5f128e58bf68745b036c2">get_description</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4107b130f6713cad73255369d6b43f91"></a><!-- doxytag: member="Xapian::MSetIterator::operator==" ref="4107b130f6713cad73255369d6b43f91" args="(const MSetIterator &a, const MSetIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#4107b130f6713cad73255369d6b43f91">operator==</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &a, const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality test for <a class="el" href="classXapian_1_1MSetIterator.html" title="An iterator pointing to items in an MSet.">MSetIterator</a> objects. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="44de20741fa12cd650ee986e57a51161"></a><!-- doxytag: member="Xapian::MSetIterator::operator!=" ref="44de20741fa12cd650ee986e57a51161" args="(const MSetIterator &a, const MSetIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#44de20741fa12cd650ee986e57a51161">operator!=</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &a, const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inequality test for <a class="el" href="classXapian_1_1MSetIterator.html" title="An iterator pointing to items in an MSet.">MSetIterator</a> objects. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An iterator pointing to items in an <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<p>
This is used for access to individual results of a match. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4d2d8fae854bc997dd417234061a3fe2"></a><!-- doxytag: member="Xapian::MSetIterator::get_collapse_count" ref="4d2d8fae854bc997dd417234061a3fe2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> Xapian::MSetIterator::get_collapse_count </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get an estimate of the number of documents that have been collapsed into this one.
<p>
The estimate will always be less than or equal to the actual number of other documents satisfying the match criteria with the same collapse key as this document.<p>
This method may return 0 even though there are other documents with the same collapse key which satisfying the match criteria. However if this method returns non-zero, there definitely are other such documents. So this method may be used to inform the user that there are "at least N other matches in this group", or to control whether to offer a "show other documents in this group" feature (but note that it may not offer it in every case where it would show other documents).
</div>
</div><p>
<a class="anchor" name="b3cd71bd6aa3b5677eacf99f369e482c"></a><!-- doxytag: member="Xapian::MSetIterator::get_document" ref="b3cd71bd6aa3b5677eacf99f369e482c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> Xapian::MSetIterator::get_document </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database.">Xapian::Document</a> object for the current position.
<p>
This method returns a <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database.">Xapian::Document</a> object which provides the information about the document pointed to by the <a class="el" href="classXapian_1_1MSetIterator.html" title="An iterator pointing to items in an MSet.">MSetIterator</a>.<p>
If the underlying database has suitable support, using this call (rather than asking the database for a document based on its document ID) will enable the system to ensure that the correct data is returned, and that the document has not been deleted or changed since the query was performed.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database.">Xapian::Document</a> object containing the document data.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXapian_1_1DocNotFoundError.html" title="Indicates an attempt to access a document not present in the database.">Xapian::DocNotFoundError</a></em> </td><td>The document specified could not be found in the database. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="99514c11a9291175d20fafa73a0839fd"></a><!-- doxytag: member="Xapian::MSetIterator::get_percent" ref="99514c11a9291175d20fafa73a0839fd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#22ea0a80c58a2047dd929621b75ed9a2">Xapian::percent</a> Xapian::MSetIterator::get_percent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This returns the weight of the document as a percentage score.
<p>
The return value will be an integer in the range 0 to 100: 0 meaning that the item did not match the query at all.<p>
The intention is that the highest weighted document will get 100 if it matches all the weight-contributing terms in the query. However, currently it may get a lower percentage score if you use a <a class="el" href="classXapian_1_1MatchDecider.html" title="Base class for matcher decision functor.">MatchDecider</a> and the sorting is primarily by value. In this case, the percentage for a particular document may vary depending on the first, max_size, and checkatleast parameters passed to <a class="el" href="classXapian_1_1Enquire.html#edb5fb761acc0bb2249bec375883a093" title="Get (a portion of) the match set for the current query.">Enquire::get_mset()</a> (this bug is hard to fix without having to apply the <a class="el" href="classXapian_1_1MatchDecider.html" title="Base class for matcher decision functor.">MatchDecider</a> to potentially many more documents, which is potentially costly).
</div>
</div><p>
<a class="anchor" name="7921b513e0e0b055134c8c1c8264a149"></a><!-- doxytag: member="Xapian::MSetIterator::get_rank" ref="7921b513e0e0b055134c8c1c8264a149" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> Xapian::MSetIterator::get_rank </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the rank of the document at the current position.
<p>
The rank is the position that this document is at in the ordered list of results of the query. The result is 0-based - i.e. the top-ranked document has a rank of 0.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="enquire_8h.html">enquire.h</a></ul>
</div>
<hr>
<address><small>
Documentation for Xapian (version 1.2.12).<br>
Generated on 27 Jun 2012 by
<a href="http://www.doxygen.org/">Doxygen 1.5.9</a>.
</small></address>
</body>
</html>
|
