Debian Codegraph @

docs/apidoc/html/classXapian_1_1ValueIterator.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.15.0"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>Xapian: API Documentation: Xapian::ValueIterator Class Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18 <tbody>
19 <tr style="height: 56px;">
20 <td id="projectalign" style="padding-left: 0.5em;">
21 <div id="projectname">xapian-core
22 &#160;<span id="projectnumber">1.4.31</span>
23 </div>
24 </td>
25 </tr>
26 </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.15.0 -->
31 <script type="text/javascript">
32 $(function() { codefold.init(); });
33 </script>
34 <script type="text/javascript" src="menudata.js"></script>
35 <script type="text/javascript" src="menu.js"></script>
36 <script type="text/javascript">
37 $(function() {
38 initMenu('',false,false,'search.php','Search',false);
39 });
40 </script>
41 <div id="main-nav"></div>
42 <div id="nav-path" class="navpath">
43 <ul>
44 <li class="navelem"><a href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a href="classXapian_1_1ValueIterator.html">ValueIterator</a></li> </ul>
45 </div>
46 </div><!-- top -->
47 <div id="doc-content">
48 <div class="header">
49 <div class="summary">
50 <a href="#pub-methods">Public Member Functions</a> &#124;
51 <a href="classXapian_1_1ValueIterator-members.html">List of all members</a> </div>
52 <div class="headertitle"><div class="title">Xapian::ValueIterator Class Reference</div></div>
53 </div><!--header-->
54 <div class="contents">
55
56 <p>Class for iterating over document values.
57 <a href="#details">More...</a></p>
58
59 <p><code>#include &lt;valueiterator.h&gt;</code></p>
60 <table class="memberdecls">
61 <tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
62 Public Member Functions</h2></td></tr>
63 <tr class="memitem:ae8f251e2647b9b73b1b516c8bc2a15e4" id="r_ae8f251e2647b9b73b1b516c8bc2a15e4"><td class="memItemLeft" align="right" valign="top"><a id="ae8f251e2647b9b73b1b516c8bc2a15e4" name="ae8f251e2647b9b73b1b516c8bc2a15e4"></a>
64 &#160;</td><td class="memItemRight" valign="bottom"><b>ValueIterator</b> (const ValueIterator &amp;o)</td></tr>
65 <tr class="memdesc:ae8f251e2647b9b73b1b516c8bc2a15e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <br /></td></tr>
66 <tr class="memitem:ad692d82332f101012df85acb3affb43c" id="r_ad692d82332f101012df85acb3affb43c"><td class="memItemLeft" align="right" valign="top"><a id="ad692d82332f101012df85acb3affb43c" name="ad692d82332f101012df85acb3affb43c"></a>
67 ValueIterator &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const ValueIterator &amp;o)</td></tr>
68 <tr class="memdesc:ad692d82332f101012df85acb3affb43c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment. <br /></td></tr>
69 <tr class="memitem:a4084631b78f8c9f95b3bc1f5546549dc" id="r_a4084631b78f8c9f95b3bc1f5546549dc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4084631b78f8c9f95b3bc1f5546549dc">ValueIterator</a> ()</td></tr>
70 <tr class="memdesc:a4084631b78f8c9f95b3bc1f5546549dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
71 <tr class="memitem:a5a3c9c62e2667580261ef312758942ae" id="r_a5a3c9c62e2667580261ef312758942ae"><td class="memItemLeft" align="right" valign="top"><a id="a5a3c9c62e2667580261ef312758942ae" name="a5a3c9c62e2667580261ef312758942ae"></a>
72 &#160;</td><td class="memItemRight" valign="bottom"><b>~ValueIterator</b> ()</td></tr>
73 <tr class="memdesc:a5a3c9c62e2667580261ef312758942ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
74 <tr class="memitem:a86246ce4cf6bc8b7d6ee1f48bdf51c38" id="r_a86246ce4cf6bc8b7d6ee1f48bdf51c38"><td class="memItemLeft" align="right" valign="top"><a id="a86246ce4cf6bc8b7d6ee1f48bdf51c38" name="a86246ce4cf6bc8b7d6ee1f48bdf51c38"></a>
75 std::string&#160;</td><td class="memItemRight" valign="bottom"><b>operator*</b> () const</td></tr>
76 <tr class="memdesc:a86246ce4cf6bc8b7d6ee1f48bdf51c38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the value at the current position. <br /></td></tr>
77 <tr class="memitem:a1647d51cb2dfa2881f58b86fe99a2284" id="r_a1647d51cb2dfa2881f58b86fe99a2284"><td class="memItemLeft" align="right" valign="top"><a id="a1647d51cb2dfa2881f58b86fe99a2284" name="a1647d51cb2dfa2881f58b86fe99a2284"></a>
78 ValueIterator &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator++</b> ()</td></tr>
79 <tr class="memdesc:a1647d51cb2dfa2881f58b86fe99a2284"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance the iterator to the next position. <br /></td></tr>
80 <tr class="memitem:a2e64dd8cd7c46e5e8ed5a5cfd8a72457" id="r_a2e64dd8cd7c46e5e8ed5a5cfd8a72457"><td class="memItemLeft" align="right" valign="top"><a id="a2e64dd8cd7c46e5e8ed5a5cfd8a72457" name="a2e64dd8cd7c46e5e8ed5a5cfd8a72457"></a>
81 DerefWrapper_&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>operator++</b> (int)</td></tr>
82 <tr class="memdesc:a2e64dd8cd7c46e5e8ed5a5cfd8a72457"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance the iterator to the next position (postfix version). <br /></td></tr>
83 <tr class="memitem:aa818fa4e4d20cffa158ec0846c4a45d6" id="r_aa818fa4e4d20cffa158ec0846c4a45d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa818fa4e4d20cffa158ec0846c4a45d6">get_docid</a> () const</td></tr>
84 <tr class="memdesc:aa818fa4e4d20cffa158ec0846c4a45d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the docid at the current position. <br /></td></tr>
85 <tr class="memitem:ad507ddef176cdaf03cdd87b0a524848a" id="r_ad507ddef176cdaf03cdd87b0a524848a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad507ddef176cdaf03cdd87b0a524848a">get_valueno</a> () const</td></tr>
86 <tr class="memdesc:ad507ddef176cdaf03cdd87b0a524848a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the value slot number for the current position. <br /></td></tr>
87 <tr class="memitem:aecff65bcb208c551bfee41fec244fbbf" id="r_aecff65bcb208c551bfee41fec244fbbf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aecff65bcb208c551bfee41fec244fbbf">skip_to</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> docid_or_slot)</td></tr>
88 <tr class="memdesc:aecff65bcb208c551bfee41fec244fbbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance the iterator to document id or value slot <em class="arg">docid_or_slot</em>. <br /></td></tr>
89 <tr class="memitem:ae41c268fb5e79b1e4f8cd90a62ec92dd" id="r_ae41c268fb5e79b1e4f8cd90a62ec92dd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae41c268fb5e79b1e4f8cd90a62ec92dd">check</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> <a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">docid</a>)</td></tr>
90 <tr class="memdesc:ae41c268fb5e79b1e4f8cd90a62ec92dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the specified docid occurs. <br /></td></tr>
91 <tr class="memitem:a98c9631fd52b218982cc03d32e47fa47" id="r_a98c9631fd52b218982cc03d32e47fa47"><td class="memItemLeft" align="right" valign="top"><a id="a98c9631fd52b218982cc03d32e47fa47" name="a98c9631fd52b218982cc03d32e47fa47"></a>
92 std::string&#160;</td><td class="memItemRight" valign="bottom"><b>get_description</b> () const</td></tr>
93 <tr class="memdesc:a98c9631fd52b218982cc03d32e47fa47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
94 </table>
95 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
96 <div class="textblock"><p>Class for iterating over document values. </p>
97 </div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
98 <a id="a4084631b78f8c9f95b3bc1f5546549dc" name="a4084631b78f8c9f95b3bc1f5546549dc"></a>
99 <h2 class="memtitle"><span class="permalink"><a href="#a4084631b78f8c9f95b3bc1f5546549dc">&#9670;&#160;</a></span>ValueIterator()</h2>
100
101 <div class="memitem">
102 <div class="memproto">
103 <table class="mlabels">
104 <tr>
105 <td class="mlabels-left">
106 <table class="memname">
107 <tr>
108 <td class="memname">Xapian::ValueIterator::ValueIterator </td>
109 <td>(</td>
110 <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
111 <td></td>
112 </tr>
113 </table>
114 </td>
115 <td class="mlabels-right">
116 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
117 </tr>
118 </table>
119 </div><div class="memdoc">
120
121 <p>Default constructor. </p>
122 <p>Creates an uninitialised iterator, which can't be used before being assigned to, but is sometimes syntactically convenient. </p>
123
124 </div>
125 </div>
126 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
127 <a id="ae41c268fb5e79b1e4f8cd90a62ec92dd" name="ae41c268fb5e79b1e4f8cd90a62ec92dd"></a>
128 <h2 class="memtitle"><span class="permalink"><a href="#ae41c268fb5e79b1e4f8cd90a62ec92dd">&#9670;&#160;</a></span>check()</h2>
129
130 <div class="memitem">
131 <div class="memproto">
132 <table class="memname">
133 <tr>
134 <td class="memname">bool Xapian::ValueIterator::check </td>
135 <td>(</td>
136 <td class="paramtype"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a></td> <td class="paramname"><span class="paramname"><em>docid</em></span></td><td>)</td>
137 <td></td>
138 </tr>
139 </table>
140 </div><div class="memdoc">
141
142 <p>Check if the specified docid occurs. </p>
143 <p>The caller is required to ensure that the specified document id <em class="arg">did</em> actually exists in the database.</p>
144 <p>This method acts like <a class="el" href="#aecff65bcb208c551bfee41fec244fbbf" title="Advance the iterator to document id or value slot docid_or_slot.">skip_to()</a> if that can be done at little extra cost, in which case it then returns true. This is how chert and glass databases behave because they store values in streams which allow for an efficient implementation of <a class="el" href="#aecff65bcb208c551bfee41fec244fbbf" title="Advance the iterator to document id or value slot docid_or_slot.">skip_to()</a>.</p>
145 <p>Otherwise it simply checks if a particular docid is present. If it is, it returns true. If it isn't, it returns false, and leaves the position unspecified (and hence the result of calling methods which depend on the current position, such as <a class="el" href="#aa818fa4e4d20cffa158ec0846c4a45d6" title="Return the docid at the current position.">get_docid()</a>, are also unspecified). In this state, next() will advance to the first matching position after document <em class="arg">did</em>, and <a class="el" href="#aecff65bcb208c551bfee41fec244fbbf" title="Advance the iterator to document id or value slot docid_or_slot.">skip_to()</a> will act as it would if the position was the first matching position after document <em class="arg">did</em>.</p>
146 <p>Currently the inmemory and remote backends behave in the latter way because they don't support streamed values and so <a class="el" href="#aecff65bcb208c551bfee41fec244fbbf" title="Advance the iterator to document id or value slot docid_or_slot.">skip_to()</a> must check each document it skips over which is significantly slower.</p>
147 <dl class="params"><dt>Parameters</dt><dd>
148 <table class="params">
149 <tr><td class="paramname">docid</td><td>The document id to check. </td></tr>
150 </table>
151 </dd>
152 </dl>
153
154 <p class="reference">References <a class="el" href="#ae41c268fb5e79b1e4f8cd90a62ec92dd">check()</a>.</p>
155
156 <p class="reference">Referenced by <a class="el" href="#ae41c268fb5e79b1e4f8cd90a62ec92dd">check()</a>.</p>
157
158 </div>
159 </div>
160 <a id="aa818fa4e4d20cffa158ec0846c4a45d6" name="aa818fa4e4d20cffa158ec0846c4a45d6"></a>
161 <h2 class="memtitle"><span class="permalink"><a href="#aa818fa4e4d20cffa158ec0846c4a45d6">&#9670;&#160;</a></span>get_docid()</h2>
162
163 <div class="memitem">
164 <div class="memproto">
165 <table class="memname">
166 <tr>
167 <td class="memname"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> Xapian::ValueIterator::get_docid </td>
168 <td>(</td>
169 <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
170 <td> const</td>
171 </tr>
172 </table>
173 </div><div class="memdoc">
174
175 <p>Return the docid at the current position. </p>
176 <p>If we're iterating over values of a document, this method will throw <a class="el" href="classXapian_1_1InvalidOperationError.html" title="InvalidOperationError indicates the API was used in an invalid way.">Xapian::InvalidOperationError</a>. </p>
177
178 </div>
179 </div>
180 <a id="ad507ddef176cdaf03cdd87b0a524848a" name="ad507ddef176cdaf03cdd87b0a524848a"></a>
181 <h2 class="memtitle"><span class="permalink"><a href="#ad507ddef176cdaf03cdd87b0a524848a">&#9670;&#160;</a></span>get_valueno()</h2>
182
183 <div class="memitem">
184 <div class="memproto">
185 <table class="memname">
186 <tr>
187 <td class="memname"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> Xapian::ValueIterator::get_valueno </td>
188 <td>(</td>
189 <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
190 <td> const</td>
191 </tr>
192 </table>
193 </div><div class="memdoc">
194
195 <p>Return the value slot number for the current position. </p>
196 <p>If the iterator is over all values in a slot, this returns that slot's number. If the iterator is over the values in a particular document, it returns the number of each slot in turn. </p>
197
198 </div>
199 </div>
200 <a id="aecff65bcb208c551bfee41fec244fbbf" name="aecff65bcb208c551bfee41fec244fbbf"></a>
201 <h2 class="memtitle"><span class="permalink"><a href="#aecff65bcb208c551bfee41fec244fbbf">&#9670;&#160;</a></span>skip_to()</h2>
202
203 <div class="memitem">
204 <div class="memproto">
205 <table class="memname">
206 <tr>
207 <td class="memname">void Xapian::ValueIterator::skip_to </td>
208 <td>(</td>
209 <td class="paramtype"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a></td> <td class="paramname"><span class="paramname"><em>docid_or_slot</em></span></td><td>)</td>
210 <td></td>
211 </tr>
212 </table>
213 </div><div class="memdoc">
214
215 <p>Advance the iterator to document id or value slot <em class="arg">docid_or_slot</em>. </p>
216 <p>If this iterator is over values in a document, then this method advances the iterator to value slot <em class="arg">docid_or_slot</em>, or the first slot after it if there is no value in slot <em class="arg">slot</em>.</p>
217 <p>If this iterator is over values in a particular slot, then this method advances the iterator to document id <em class="arg">docid_or_slot</em>, or the first document id after it if there is no value in the slot we're iterating over for document <em class="arg">docid_or_slot</em>.</p>
218 <p>Note: The "two-faced" nature of this method is due to how C++ overloading works. <a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f" title="A unique identifier for a document.">Xapian::docid</a> and <a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea" title="The number for a value slot in a document.">Xapian::valueno</a> are both typedefs for the same unsigned integer type, so overloading can't distinguish them.</p>
219 <dl class="params"><dt>Parameters</dt><dd>
220 <table class="params">
221 <tr><td class="paramname">docid_or_slot</td><td>The docid/slot to advance to. </td></tr>
222 </table>
223 </dd>
224 </dl>
225
226 </div>
227 </div>
228 <hr/>The documentation for this class was generated from the following file:<ul>
229 <li>xapian/<a class="el" href="valueiterator_8h.html">valueiterator.h</a></li>
230 </ul>
231 </div><!-- contents -->
232 <!-- start footer part -->
233 <hr class="footer"/><address class="footer"><small>
234 Generated by <a href="https://www.doxygen.org/">Doxygen 1.15.0</a>
235 </small></address>
236 </body>
237 </html>