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
|
<!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.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::TermIterator 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
 <span id="projectnumber">1.4.18</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(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_1TermIterator.html">TermIterator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1TermIterator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::TermIterator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class for iterating over a list of terms.
<a href="classXapian_1_1TermIterator.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:a03e04a51d4aeaa108cdd1f988de4b259"><td class="memItemLeft" align="right" valign="top"><a id="a03e04a51d4aeaa108cdd1f988de4b259"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#a03e04a51d4aeaa108cdd1f988de4b259">TermIterator</a> (const <a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> &o)</td></tr>
<tr class="memdesc:a03e04a51d4aeaa108cdd1f988de4b259"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:a03e04a51d4aeaa108cdd1f988de4b259"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59097c3c1098630a1095218b1ed7da71"><td class="memItemLeft" align="right" valign="top"><a id="a59097c3c1098630a1095218b1ed7da71"></a>
<a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#a59097c3c1098630a1095218b1ed7da71">operator=</a> (const <a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> &o)</td></tr>
<tr class="memdesc:a59097c3c1098630a1095218b1ed7da71"><td class="mdescLeft"> </td><td class="mdescRight">Assignment. <br /></td></tr>
<tr class="separator:a59097c3c1098630a1095218b1ed7da71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd50fb35c84e433fc3762447e28b4bab"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#afd50fb35c84e433fc3762447e28b4bab">TermIterator</a> ()</td></tr>
<tr class="memdesc:afd50fb35c84e433fc3762447e28b4bab"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="classXapian_1_1TermIterator.html#afd50fb35c84e433fc3762447e28b4bab">More...</a><br /></td></tr>
<tr class="separator:afd50fb35c84e433fc3762447e28b4bab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a914de6019011c9c25b00e84f556af681"><td class="memItemLeft" align="right" valign="top"><a id="a914de6019011c9c25b00e84f556af681"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#a914de6019011c9c25b00e84f556af681">~TermIterator</a> ()</td></tr>
<tr class="memdesc:a914de6019011c9c25b00e84f556af681"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a914de6019011c9c25b00e84f556af681"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87341566520ea6f30970e26688ffbaad"><td class="memItemLeft" align="right" valign="top"><a id="a87341566520ea6f30970e26688ffbaad"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#a87341566520ea6f30970e26688ffbaad">operator*</a> () const</td></tr>
<tr class="memdesc:a87341566520ea6f30970e26688ffbaad"><td class="mdescLeft"> </td><td class="mdescRight">Return the term at the current position. <br /></td></tr>
<tr class="separator:a87341566520ea6f30970e26688ffbaad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaaedc9fd9d03bbde76d22d61b6dd92f9"><td class="memItemLeft" align="right" valign="top"><a id="aaaedc9fd9d03bbde76d22d61b6dd92f9"></a>
<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#aaaedc9fd9d03bbde76d22d61b6dd92f9">get_wdf</a> () const</td></tr>
<tr class="memdesc:aaaedc9fd9d03bbde76d22d61b6dd92f9"><td class="mdescLeft"> </td><td class="mdescRight">Return the wdf for the term at the current position. <br /></td></tr>
<tr class="separator:aaaedc9fd9d03bbde76d22d61b6dd92f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31977ce8a6d66c294a45042b3bc1193b"><td class="memItemLeft" align="right" valign="top"><a id="a31977ce8a6d66c294a45042b3bc1193b"></a>
<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#a31977ce8a6d66c294a45042b3bc1193b">get_termfreq</a> () const</td></tr>
<tr class="memdesc:a31977ce8a6d66c294a45042b3bc1193b"><td class="mdescLeft"> </td><td class="mdescRight">Return the term frequency for the term at the current position. <br /></td></tr>
<tr class="separator:a31977ce8a6d66c294a45042b3bc1193b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a409559e64d9d1687cc0c5875f79e2382"><td class="memItemLeft" align="right" valign="top"><a id="a409559e64d9d1687cc0c5875f79e2382"></a>
<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#a409559e64d9d1687cc0c5875f79e2382">positionlist_count</a> () const</td></tr>
<tr class="memdesc:a409559e64d9d1687cc0c5875f79e2382"><td class="mdescLeft"> </td><td class="mdescRight">Return the length of the position list for the current position. <br /></td></tr>
<tr class="separator:a409559e64d9d1687cc0c5875f79e2382"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe5f0fd13bbabdfa6c2ead19d066991e"><td class="memItemLeft" align="right" valign="top"><a id="afe5f0fd13bbabdfa6c2ead19d066991e"></a>
<a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#afe5f0fd13bbabdfa6c2ead19d066991e">positionlist_begin</a> () const</td></tr>
<tr class="memdesc:afe5f0fd13bbabdfa6c2ead19d066991e"><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classXapian_1_1PositionIterator.html" title="Class for iterating over term positions.">PositionIterator</a> for the current term. <br /></td></tr>
<tr class="separator:afe5f0fd13bbabdfa6c2ead19d066991e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a820091c0f1ddb5be92384ad528b6031d"><td class="memItemLeft" align="right" valign="top"><a id="a820091c0f1ddb5be92384ad528b6031d"></a>
<a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#a820091c0f1ddb5be92384ad528b6031d">positionlist_end</a> () const</td></tr>
<tr class="memdesc:a820091c0f1ddb5be92384ad528b6031d"><td class="mdescLeft"> </td><td class="mdescRight">Return an end <a class="el" href="classXapian_1_1PositionIterator.html" title="Class for iterating over term positions.">PositionIterator</a> for the current term. <br /></td></tr>
<tr class="separator:a820091c0f1ddb5be92384ad528b6031d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04d4db66b44b0e948f8cd925130aacb0"><td class="memItemLeft" align="right" valign="top"><a id="a04d4db66b44b0e948f8cd925130aacb0"></a>
<a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#a04d4db66b44b0e948f8cd925130aacb0">operator++</a> ()</td></tr>
<tr class="memdesc:a04d4db66b44b0e948f8cd925130aacb0"><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the next position. <br /></td></tr>
<tr class="separator:a04d4db66b44b0e948f8cd925130aacb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a425243a43291345eef2659fb1d085f"><td class="memItemLeft" align="right" valign="top"><a id="a2a425243a43291345eef2659fb1d085f"></a>
DerefWrapper_< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#a2a425243a43291345eef2659fb1d085f">operator++</a> (int)</td></tr>
<tr class="memdesc:a2a425243a43291345eef2659fb1d085f"><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the next position (postfix version). <br /></td></tr>
<tr class="separator:a2a425243a43291345eef2659fb1d085f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b1993d2587d6d9acc7c63212c4b56ae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#a7b1993d2587d6d9acc7c63212c4b56ae">skip_to</a> (const std::string &term)</td></tr>
<tr class="memdesc:a7b1993d2587d6d9acc7c63212c4b56ae"><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to term <em>term</em>. <a href="classXapian_1_1TermIterator.html#a7b1993d2587d6d9acc7c63212c4b56ae">More...</a><br /></td></tr>
<tr class="separator:a7b1993d2587d6d9acc7c63212c4b56ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54f7c6dde0fe066e040bd89f1dfd20ce"><td class="memItemLeft" align="right" valign="top"><a id="a54f7c6dde0fe066e040bd89f1dfd20ce"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#a54f7c6dde0fe066e040bd89f1dfd20ce">get_description</a> () const</td></tr>
<tr class="memdesc:a54f7c6dde0fe066e040bd89f1dfd20ce"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:a54f7c6dde0fe066e040bd89f1dfd20ce"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class for iterating over a list of terms. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="afd50fb35c84e433fc3762447e28b4bab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd50fb35c84e433fc3762447e28b4bab">◆ </a></span>TermIterator()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::TermIterator::TermIterator </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="a7b1993d2587d6d9acc7c63212c4b56ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b1993d2587d6d9acc7c63212c4b56ae">◆ </a></span>skip_to()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::TermIterator::skip_to </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>term</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Advance the iterator to term <em>term</em>. </p>
<p>If the iteration is over an unsorted list of terms, then 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>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">term</td><td>The term to advance to. If this term isn't in the stream being iterated, then the iterator is moved to the next term 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="termiterator_8h.html">termiterator.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.1</a>
</small></address>
</body>
</html>
|
