File: classXapian_1_1PositionIterator.html

package info (click to toggle)
xapian-core 1.4.22-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 22,816 kB
  • sloc: cpp: 92,138; ansic: 9,983; sh: 4,929; perl: 850; makefile: 503; javascript: 331; tcl: 319; python: 40
file content (163 lines) | stat: -rw-r--r-- 11,040 bytes parent folder | download 
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
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::PositionIterator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">xapian-core
   &#160;<span id="projectnumber">1.4.22</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</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_1PositionIterator.html">PositionIterator</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classXapian_1_1PositionIterator-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Xapian::PositionIterator Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Class for iterating over term positions.  
 <a href="classXapian_1_1PositionIterator.html#details">More...</a></p>

<p><code>#include &lt;positioniterator.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8b9d10db35fa9e2944012ea57a0b9d23"><td class="memItemLeft" align="right" valign="top"><a id="a8b9d10db35fa9e2944012ea57a0b9d23" name="a8b9d10db35fa9e2944012ea57a0b9d23"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>PositionIterator</b> (const <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> &amp;o)</td></tr>
<tr class="memdesc:a8b9d10db35fa9e2944012ea57a0b9d23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:a8b9d10db35fa9e2944012ea57a0b9d23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25a2f0d966660cb72d795b43590f5db2"><td class="memItemLeft" align="right" valign="top"><a id="a25a2f0d966660cb72d795b43590f5db2" name="a25a2f0d966660cb72d795b43590f5db2"></a>
<a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> &amp;o)</td></tr>
<tr class="memdesc:a25a2f0d966660cb72d795b43590f5db2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment. <br /></td></tr>
<tr class="separator:a25a2f0d966660cb72d795b43590f5db2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a475e11e82d8268d23b750c787531ab9a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PositionIterator.html#a475e11e82d8268d23b750c787531ab9a">PositionIterator</a> ()</td></tr>
<tr class="memdesc:a475e11e82d8268d23b750c787531ab9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="classXapian_1_1PositionIterator.html#a475e11e82d8268d23b750c787531ab9a">More...</a><br /></td></tr>
<tr class="separator:a475e11e82d8268d23b750c787531ab9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a84f5de9867d1413c0dacb704d63c04"><td class="memItemLeft" align="right" valign="top"><a id="a9a84f5de9867d1413c0dacb704d63c04" name="a9a84f5de9867d1413c0dacb704d63c04"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>~PositionIterator</b> ()</td></tr>
<tr class="memdesc:a9a84f5de9867d1413c0dacb704d63c04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a9a84f5de9867d1413c0dacb704d63c04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cd28b3c837e6dc17bb67e60812a5aa3"><td class="memItemLeft" align="right" valign="top"><a id="a7cd28b3c837e6dc17bb67e60812a5aa3" name="a7cd28b3c837e6dc17bb67e60812a5aa3"></a>
<a class="el" href="namespaceXapian.html#ae1faeb9bd109b4d78a02d4b5f7b123ed">Xapian::termpos</a>&#160;</td><td class="memItemRight" valign="bottom"><b>operator*</b> () const</td></tr>
<tr class="memdesc:a7cd28b3c837e6dc17bb67e60812a5aa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the term position at the current iterator position. <br /></td></tr>
<tr class="separator:a7cd28b3c837e6dc17bb67e60812a5aa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e953a9dcd8f13f8120f14f7e65ad16d"><td class="memItemLeft" align="right" valign="top"><a id="a9e953a9dcd8f13f8120f14f7e65ad16d" name="a9e953a9dcd8f13f8120f14f7e65ad16d"></a>
<a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator++</b> ()</td></tr>
<tr class="memdesc:a9e953a9dcd8f13f8120f14f7e65ad16d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance the iterator to the next position. <br /></td></tr>
<tr class="separator:a9e953a9dcd8f13f8120f14f7e65ad16d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98ef83b8ce8373501b25b84b96af167b"><td class="memItemLeft" align="right" valign="top"><a id="a98ef83b8ce8373501b25b84b96af167b" name="a98ef83b8ce8373501b25b84b96af167b"></a>
DerefWrapper_&lt; <a class="el" href="namespaceXapian.html#ae1faeb9bd109b4d78a02d4b5f7b123ed">Xapian::termpos</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>operator++</b> (int)</td></tr>
<tr class="memdesc:a98ef83b8ce8373501b25b84b96af167b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance the iterator to the next position (postfix version). <br /></td></tr>
<tr class="separator:a98ef83b8ce8373501b25b84b96af167b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23ffca163d3be13e8e2ad0bb5a996198"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PositionIterator.html#a23ffca163d3be13e8e2ad0bb5a996198">skip_to</a> (<a class="el" href="namespaceXapian.html#ae1faeb9bd109b4d78a02d4b5f7b123ed">Xapian::termpos</a> <a class="el" href="namespaceXapian.html#ae1faeb9bd109b4d78a02d4b5f7b123ed">termpos</a>)</td></tr>
<tr class="memdesc:a23ffca163d3be13e8e2ad0bb5a996198"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance the iterator to term position <em>termpos</em>.  <a href="classXapian_1_1PositionIterator.html#a23ffca163d3be13e8e2ad0bb5a996198">More...</a><br /></td></tr>
<tr class="separator:a23ffca163d3be13e8e2ad0bb5a996198"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab518a749d9421adbda2ebaad4ba44948"><td class="memItemLeft" align="right" valign="top"><a id="ab518a749d9421adbda2ebaad4ba44948" name="ab518a749d9421adbda2ebaad4ba44948"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>get_description</b> () const</td></tr>
<tr class="memdesc:ab518a749d9421adbda2ebaad4ba44948"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:ab518a749d9421adbda2ebaad4ba44948"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Class for iterating over term positions. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a475e11e82d8268d23b750c787531ab9a" name="a475e11e82d8268d23b750c787531ab9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a475e11e82d8268d23b750c787531ab9a">&#9670;&nbsp;</a></span>PositionIterator()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Xapian::PositionIterator::PositionIterator </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>Default constructor. </p>
<p >Creates an uninitialised iterator, which can't be used before being assigned to, but is sometimes syntactically convenient. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a23ffca163d3be13e8e2ad0bb5a996198" name="a23ffca163d3be13e8e2ad0bb5a996198"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23ffca163d3be13e8e2ad0bb5a996198">&#9670;&nbsp;</a></span>skip_to()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Xapian::PositionIterator::skip_to </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceXapian.html#ae1faeb9bd109b4d78a02d4b5f7b123ed">Xapian::termpos</a>&#160;</td>
          <td class="paramname"><em>termpos</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Advance the iterator to term position <em>termpos</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">termpos</td><td>The position to advance to. If this position isn't in the stream being iterated, then the iterator is moved to the next term position after it which is. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="positioniterator_8h.html">positioniterator.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.4</a>
</small></address>
</body>
</html>