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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: Xapian::ESetIterator 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.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1ESetIterator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::ESetIterator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Iterator over a <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results. ">Xapian::ESet</a>.
<a href="classXapian_1_1ESetIterator.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac61be6aa36fc2f6ebe5c4cc4865de473"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#ac61be6aa36fc2f6ebe5c4cc4865de473">ESetIterator</a> ()</td></tr>
<tr class="memdesc:ac61be6aa36fc2f6ebe5c4cc4865de473"><td class="mdescLeft"> </td><td class="mdescRight">Create an unpositioned <a class="el" href="classXapian_1_1ESetIterator.html" title="Iterator over a Xapian::ESet. ">ESetIterator</a>. <a href="#ac61be6aa36fc2f6ebe5c4cc4865de473">More...</a><br /></td></tr>
<tr class="separator:ac61be6aa36fc2f6ebe5c4cc4865de473"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc6352922a445d7286b9f1cbdfd7aca0"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#acc6352922a445d7286b9f1cbdfd7aca0">operator*</a> () const</td></tr>
<tr class="memdesc:acc6352922a445d7286b9f1cbdfd7aca0"><td class="mdescLeft"> </td><td class="mdescRight">Get the term at the current position. <a href="#acc6352922a445d7286b9f1cbdfd7aca0">More...</a><br /></td></tr>
<tr class="separator:acc6352922a445d7286b9f1cbdfd7aca0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14d2d57a48f2e7aed1580a6f782bed41"><td class="memItemLeft" align="right" valign="top"><a id="a14d2d57a48f2e7aed1580a6f782bed41"></a>
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#a14d2d57a48f2e7aed1580a6f782bed41">operator++</a> ()</td></tr>
<tr class="memdesc:a14d2d57a48f2e7aed1580a6f782bed41"><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the next position. <br /></td></tr>
<tr class="separator:a14d2d57a48f2e7aed1580a6f782bed41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adad0209772938f1d5c495ad722fb0dad"><td class="memItemLeft" align="right" valign="top"><a id="adad0209772938f1d5c495ad722fb0dad"></a>
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#adad0209772938f1d5c495ad722fb0dad">operator++</a> (int)</td></tr>
<tr class="memdesc:adad0209772938f1d5c495ad722fb0dad"><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the next position (postfix version). <br /></td></tr>
<tr class="separator:adad0209772938f1d5c495ad722fb0dad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1e2d498af7508403153a45ba813e439"><td class="memItemLeft" align="right" valign="top"><a id="ae1e2d498af7508403153a45ba813e439"></a>
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#ae1e2d498af7508403153a45ba813e439">operator--</a> ()</td></tr>
<tr class="memdesc:ae1e2d498af7508403153a45ba813e439"><td class="mdescLeft"> </td><td class="mdescRight">Move the iterator to the previous position. <br /></td></tr>
<tr class="separator:ae1e2d498af7508403153a45ba813e439"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a11724a059a1590e45c3a3b38cb43dc"><td class="memItemLeft" align="right" valign="top"><a id="a3a11724a059a1590e45c3a3b38cb43dc"></a>
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#a3a11724a059a1590e45c3a3b38cb43dc">operator--</a> (int)</td></tr>
<tr class="memdesc:a3a11724a059a1590e45c3a3b38cb43dc"><td class="mdescLeft"> </td><td class="mdescRight">Move the iterator to the previous position (postfix version). <br /></td></tr>
<tr class="separator:a3a11724a059a1590e45c3a3b38cb43dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7ea2d10b5ff380e09f9a9f0cb1c78e1"><td class="memItemLeft" align="right" valign="top"><a id="af7ea2d10b5ff380e09f9a9f0cb1c78e1"></a>
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#af7ea2d10b5ff380e09f9a9f0cb1c78e1">operator+=</a> (difference_type n)</td></tr>
<tr class="memdesc:af7ea2d10b5ff380e09f9a9f0cb1c78e1"><td class="mdescLeft"> </td><td class="mdescRight">Move the iterator forwards by n positions. <br /></td></tr>
<tr class="separator:af7ea2d10b5ff380e09f9a9f0cb1c78e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6fa1a044ddd97f6e7afe5cdbaca3aaea"><td class="memItemLeft" align="right" valign="top"><a id="a6fa1a044ddd97f6e7afe5cdbaca3aaea"></a>
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#a6fa1a044ddd97f6e7afe5cdbaca3aaea">operator-=</a> (difference_type n)</td></tr>
<tr class="memdesc:a6fa1a044ddd97f6e7afe5cdbaca3aaea"><td class="mdescLeft"> </td><td class="mdescRight">Move the iterator back by n positions. <br /></td></tr>
<tr class="separator:a6fa1a044ddd97f6e7afe5cdbaca3aaea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a94e0c4871c614afe4a317b4896bd2833"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#a94e0c4871c614afe4a317b4896bd2833">operator+</a> (difference_type n) const</td></tr>
<tr class="memdesc:a94e0c4871c614afe4a317b4896bd2833"><td class="mdescLeft"> </td><td class="mdescRight">Return the iterator incremented by <em>n</em> positions. <a href="#a94e0c4871c614afe4a317b4896bd2833">More...</a><br /></td></tr>
<tr class="separator:a94e0c4871c614afe4a317b4896bd2833"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a122db831a476e9cb224dcdd7e22cf82b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#a122db831a476e9cb224dcdd7e22cf82b">operator-</a> (difference_type n) const</td></tr>
<tr class="memdesc:a122db831a476e9cb224dcdd7e22cf82b"><td class="mdescLeft"> </td><td class="mdescRight">Return the iterator decremented by <em>n</em> positions. <a href="#a122db831a476e9cb224dcdd7e22cf82b">More...</a><br /></td></tr>
<tr class="separator:a122db831a476e9cb224dcdd7e22cf82b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77a749d5d0eb45b7a2e84e9f6e66e0b3"><td class="memItemLeft" align="right" valign="top">difference_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#a77a749d5d0eb45b7a2e84e9f6e66e0b3">operator-</a> (const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &o) const</td></tr>
<tr class="memdesc:a77a749d5d0eb45b7a2e84e9f6e66e0b3"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of positions between <em>o</em> and this iterator. <a href="#a77a749d5d0eb45b7a2e84e9f6e66e0b3">More...</a><br /></td></tr>
<tr class="separator:a77a749d5d0eb45b7a2e84e9f6e66e0b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af9c8a9ee5b86ab323f21e21293ebe4d8"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#af9c8a9ee5b86ab323f21e21293ebe4d8">get_weight</a> () const</td></tr>
<tr class="memdesc:af9c8a9ee5b86ab323f21e21293ebe4d8"><td class="mdescLeft"> </td><td class="mdescRight">Get the weight for the current position. <a href="#af9c8a9ee5b86ab323f21e21293ebe4d8">More...</a><br /></td></tr>
<tr class="separator:af9c8a9ee5b86ab323f21e21293ebe4d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab932d08de7fbb1f2ea118095c3d885fe"><td class="memItemLeft" align="right" valign="top"><a id="ab932d08de7fbb1f2ea118095c3d885fe"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#ab932d08de7fbb1f2ea118095c3d885fe">get_description</a> () const</td></tr>
<tr class="memdesc:ab932d08de7fbb1f2ea118095c3d885fe"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:ab932d08de7fbb1f2ea118095c3d885fe"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Iterator over a <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results. ">Xapian::ESet</a>. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ac61be6aa36fc2f6ebe5c4cc4865de473"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac61be6aa36fc2f6ebe5c4cc4865de473">◆ </a></span>ESetIterator()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::ESetIterator::ESetIterator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an unpositioned <a class="el" href="classXapian_1_1ESetIterator.html" title="Iterator over a Xapian::ESet. ">ESetIterator</a>. </p>
<p class="reference">References <a class="el" href="namespaceXapian.html#ad6c424a7b62b804bd350412ffcd01a6d">Xapian::operator*()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af9c8a9ee5b86ab323f21e21293ebe4d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9c8a9ee5b86ab323f21e21293ebe4d8">◆ </a></span>get_weight()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Xapian::ESetIterator::get_weight </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the weight for the current position. </p>
</div>
</div>
<a id="acc6352922a445d7286b9f1cbdfd7aca0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc6352922a445d7286b9f1cbdfd7aca0">◆ </a></span>operator*()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::ESetIterator::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the term at the current position. </p>
</div>
</div>
<a id="a94e0c4871c614afe4a317b4896bd2833"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94e0c4871c614afe4a317b4896bd2833">◆ </a></span>operator+()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> Xapian::ESetIterator::operator+ </td>
<td>(</td>
<td class="paramtype">difference_type </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the iterator incremented by <em>n</em> positions. </p>
<p>If <em>n</em> is negative, decrements by (-n) positions. </p>
</div>
</div>
<a id="a122db831a476e9cb224dcdd7e22cf82b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a122db831a476e9cb224dcdd7e22cf82b">◆ </a></span>operator-() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> Xapian::ESetIterator::operator- </td>
<td>(</td>
<td class="paramtype">difference_type </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the iterator decremented by <em>n</em> positions. </p>
<p>If <em>n</em> is negative, increments by (-n) positions. </p>
</div>
</div>
<a id="a77a749d5d0eb45b7a2e84e9f6e66e0b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77a749d5d0eb45b7a2e84e9f6e66e0b3">◆ </a></span>operator-() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">difference_type Xapian::ESetIterator::operator- </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> & </td>
<td class="paramname"><em>o</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the number of positions between <em>o</em> and this iterator. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="eset_8h.html">eset.h</a></li>
</ul>
</div><!-- contents -->
<hr>
<address><small>
Documentation for Xapian (version 1.4.3).<br>
Generated on Wed Jan 25 2017 by
<a href="http://www.doxygen.org/">Doxygen 1.8.13</a>.
</small></address>
</body>
</html>
|