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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::PostingIterator 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_1PostingIterator.html">PostingIterator</a>
</div>
</div>
<div class="contents">
<h1>Xapian::PostingIterator Class Reference</h1><!-- doxytag: class="Xapian::PostingIterator" -->An iterator pointing to items in a list of postings.
<a href="#_details">More...</a>
<p>
<p>
<a href="classXapian_1_1PostingIterator-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="340c72921b18f4ea5c15b077f14e61ce"></a><!-- doxytag: member="Xapian::PostingIterator::iterator_category" ref="340c72921b18f4ea5c15b077f14e61ce" args="" -->
typedef std::input_iterator_tag </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#340c72921b18f4ea5c15b077f14e61ce">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="405384ad29c3ff95658372329a9bcd58"></a><!-- doxytag: member="Xapian::PostingIterator::value_type" ref="405384ad29c3ff95658372329a9bcd58" args="" -->
typedef <a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#405384ad29c3ff95658372329a9bcd58">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="a95ef4f8e09c54c347f863cd2814de11"></a><!-- doxytag: member="Xapian::PostingIterator::difference_type" ref="a95ef4f8e09c54c347f863cd2814de11" 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_1PostingIterator.html#a95ef4f8e09c54c347f863cd2814de11">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="c8aba644bb6ace6a773eff34a1587853"></a><!-- doxytag: member="Xapian::PostingIterator::pointer" ref="c8aba644bb6ace6a773eff34a1587853" args="" -->
typedef <a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#c8aba644bb6ace6a773eff34a1587853">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="eaa71e8d29d4cbe492be8a8e5cff512c"></a><!-- doxytag: member="Xapian::PostingIterator::reference" ref="eaa71e8d29d4cbe492be8a8e5cff512c" args="" -->
typedef <a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#eaa71e8d29d4cbe492be8a8e5cff512c">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="e75789243bba29a7911173979aadca43"></a><!-- doxytag: member="Xapian::PostingIterator::PostingIterator" ref="e75789243bba29a7911173979aadca43" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#e75789243bba29a7911173979aadca43">PostingIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor - for declaring an uninitialised iterator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="688eb4778f5dafb7d1a589010216dbe4"></a><!-- doxytag: member="Xapian::PostingIterator::~PostingIterator" ref="688eb4778f5dafb7d1a589010216dbe4" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#688eb4778f5dafb7d1a589010216dbe4">~PostingIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#d4a09de16483b0e9aeb49adc7fefb707">PostingIterator</a> (const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed. <a href="#d4a09de16483b0e9aeb49adc7fefb707"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#c74abb0678bf756aae322b83805deef5">operator=</a> (const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed. <a href="#c74abb0678bf756aae322b83805deef5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12252ab2accdd682265c58eef1871d13"></a><!-- doxytag: member="Xapian::PostingIterator::operator++" ref="12252ab2accdd682265c58eef1871d13" args="()" -->
<a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#12252ab2accdd682265c58eef1871d13">operator++</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the next position. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ef8b3b627ccbea748aea715bc67eeb70"></a><!-- doxytag: member="Xapian::PostingIterator::operator++" ref="ef8b3b627ccbea748aea715bc67eeb70" args="(int)" -->
DerefWrapper_< <a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">docid</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#ef8b3b627ccbea748aea715bc67eeb70">operator++</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the next position (postfix version). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#665a45d91c6c7ea010b4c9f3b2efbe9e">skip_to</a> (<a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> did)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the specified docid. <a href="#665a45d91c6c7ea010b4c9f3b2efbe9e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2525c396fe296173322e679ddb02a3c"></a><!-- doxytag: member="Xapian::PostingIterator::operator*" ref="f2525c396fe296173322e679ddb02a3c" args="() const " -->
<a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#f2525c396fe296173322e679ddb02a3c">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the document id at the current position in the postlist. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#14d4c5cc78dcb149b04c30a280e2751f">get_doclength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the length of the document at the current position in the postlist. <a href="#14d4c5cc78dcb149b04c30a280e2751f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c05e628e438614e20a4b1292cb982b87"></a><!-- doxytag: member="Xapian::PostingIterator::get_wdf" ref="c05e628e438614e20a4b1292cb982b87" args="() const " -->
<a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#c05e628e438614e20a4b1292cb982b87">get_wdf</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the within document frequency of the document at the current position in the postlist. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="94935d23e4806725737426ee298322c3"></a><!-- doxytag: member="Xapian::PostingIterator::positionlist_begin" ref="94935d23e4806725737426ee298322c3" args="() const " -->
<a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#94935d23e4806725737426ee298322c3">positionlist_begin</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return <a class="el" href="classXapian_1_1PositionIterator.html" title="An iterator pointing to items in a list of positions.">PositionIterator</a> pointing to start of positionlist for current document. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="618c4e850550b870cbddc640e0f8a489"></a><!-- doxytag: member="Xapian::PostingIterator::positionlist_end" ref="618c4e850550b870cbddc640e0f8a489" args="() const " -->
<a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#618c4e850550b870cbddc640e0f8a489">positionlist_end</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return <a class="el" href="classXapian_1_1PositionIterator.html" title="An iterator pointing to items in a list of positions.">PositionIterator</a> pointing to end of positionlist for current document. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e4a19ca6b9fb16ad3e266ed7a676e3a"></a><!-- doxytag: member="Xapian::PostingIterator::get_description" ref="8e4a19ca6b9fb16ad3e266ed7a676e3a" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#8e4a19ca6b9fb16ad3e266ed7a676e3a">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="1413237d58c5562c62e433b336f2c066"></a><!-- doxytag: member="Xapian::PostingIterator::operator==" ref="1413237d58c5562c62e433b336f2c066" args="(const PostingIterator &a, const PostingIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#1413237d58c5562c62e433b336f2c066">operator==</a> (const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &a, const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test equality of two PostingIterators. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An iterator pointing to items in a list of postings. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="d4a09de16483b0e9aeb49adc7fefb707"></a><!-- doxytag: member="Xapian::PostingIterator::PostingIterator" ref="d4a09de16483b0e9aeb49adc7fefb707" args="(const PostingIterator &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::PostingIterator::PostingIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copying is allowed.
<p>
The internals are reference counted, so copying is also cheap.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="14d4c5cc78dcb149b04c30a280e2751f"></a><!-- doxytag: member="Xapian::PostingIterator::get_doclength" ref="14d4c5cc78dcb149b04c30a280e2751f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> Xapian::PostingIterator::get_doclength </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the length of the document at the current position in the postlist.
<p>
This information may be stored in the postlist, in which case this lookup should be extremely fast (indeed, not require further disk access). If the information is not present in the postlist, it will be retrieved from the database, at a greater performance cost.
</div>
</div><p>
<a class="anchor" name="c74abb0678bf756aae322b83805deef5"></a><!-- doxytag: member="Xapian::PostingIterator::operator=" ref="c74abb0678bf756aae322b83805deef5" args="(const PostingIterator &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::PostingIterator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment is allowed.
<p>
The internals are reference counted, so assignment is also cheap.
</div>
</div><p>
<a class="anchor" name="665a45d91c6c7ea010b4c9f3b2efbe9e"></a><!-- doxytag: member="Xapian::PostingIterator::skip_to" ref="665a45d91c6c7ea010b4c9f3b2efbe9e" args="(Xapian::docid did)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::PostingIterator::skip_to </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> </td>
<td class="paramname"> <em>did</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Advance the iterator to the specified docid.
<p>
If the specified docid isn't in the list, position ourselves on the first document after it (or at_end() if no greater docids are present).
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="postingiterator_8h.html">postingiterator.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>
|
