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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: 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.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_1ESetIterator.html">ESetIterator</a>
</div>
</div>
<div class="contents">
<h1>Xapian::ESetIterator Class Reference</h1><!-- doxytag: class="Xapian::ESetIterator" -->Iterate through terms in the <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a>.
<a href="#_details">More...</a>
<p>
<p>
<a href="classXapian_1_1ESetIterator-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="8b9d7694b4030e995c921050855fdd5c"></a><!-- doxytag: member="Xapian::ESetIterator::iterator_category" ref="8b9d7694b4030e995c921050855fdd5c" args="" -->
typedef <br class="typebreak">
std::bidirectional_iterator_tag </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#8b9d7694b4030e995c921050855fdd5c">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="e8f83b2d74b7d6df225200d4f5535457"></a><!-- doxytag: member="Xapian::ESetIterator::value_type" ref="e8f83b2d74b7d6df225200d4f5535457" args="" -->
typedef std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#e8f83b2d74b7d6df225200d4f5535457">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="2f7a416cb1933a156e7a451c0ce24862"></a><!-- doxytag: member="Xapian::ESetIterator::difference_type" ref="2f7a416cb1933a156e7a451c0ce24862" args="" -->
typedef <a class="el" href="namespaceXapian.html#886bd8fd46134d4b488091cfd8a658ed">Xapian::termcount_diff</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#2f7a416cb1933a156e7a451c0ce24862">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="d3dd2f7ac77acea71189c6b2f92660d3"></a><!-- doxytag: member="Xapian::ESetIterator::pointer" ref="d3dd2f7ac77acea71189c6b2f92660d3" args="" -->
typedef std::string * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#d3dd2f7ac77acea71189c6b2f92660d3">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="a3a9801bb57c8d49be13633904951d29"></a><!-- doxytag: member="Xapian::ESetIterator::reference" ref="a3a9801bb57c8d49be13633904951d29" args="" -->
typedef std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#a3a9801bb57c8d49be13633904951d29">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="c61be6aa36fc2f6ebe5c4cc4865de473"></a><!-- doxytag: member="Xapian::ESetIterator::ESetIterator" ref="c61be6aa36fc2f6ebe5c4cc4865de473" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#c61be6aa36fc2f6ebe5c4cc4865de473">ESetIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an uninitialised iterator; this cannot be used, but is convenient syntactically. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e9da71f680547c22406d2268b5ff1fe"></a><!-- doxytag: member="Xapian::ESetIterator::ESetIterator" ref="2e9da71f680547c22406d2268b5ff1fe" args="(const ESetIterator &other)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#2e9da71f680547c22406d2268b5ff1fe">ESetIterator</a> (const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed (and is cheap). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="48dab179f2b57c1b5e25f83598588331"></a><!-- doxytag: member="Xapian::ESetIterator::operator=" ref="48dab179f2b57c1b5e25f83598588331" args="(const ESetIterator &other)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#48dab179f2b57c1b5e25f83598588331">operator=</a> (const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed (and is cheap). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="14d2d57a48f2e7aed1580a6f782bed41"></a><!-- doxytag: member="Xapian::ESetIterator::operator++" ref="14d2d57a48f2e7aed1580a6f782bed41" args="()" -->
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#14d2d57a48f2e7aed1580a6f782bed41">operator++</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dad0209772938f1d5c495ad722fb0dad"></a><!-- doxytag: member="Xapian::ESetIterator::operator++" ref="dad0209772938f1d5c495ad722fb0dad" args="(int)" -->
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#dad0209772938f1d5c495ad722fb0dad">operator++</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator (postfix variant). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1e2d498af7508403153a45ba813e439"></a><!-- doxytag: member="Xapian::ESetIterator::operator--" ref="e1e2d498af7508403153a45ba813e439" args="()" -->
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#e1e2d498af7508403153a45ba813e439">operator--</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrement the iterator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a11724a059a1590e45c3a3b38cb43dc"></a><!-- doxytag: member="Xapian::ESetIterator::operator--" ref="3a11724a059a1590e45c3a3b38cb43dc" args="(int)" -->
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#3a11724a059a1590e45c3a3b38cb43dc">operator--</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrement the iterator (postfix variant). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca6b55e068f22f1d4c5066f5087eb858"></a><!-- doxytag: member="Xapian::ESetIterator::operator*" ref="ca6b55e068f22f1d4c5066f5087eb858" args="() const " -->
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#ca6b55e068f22f1d4c5066f5087eb858">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the term for the current position. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c3294162c194e248b4a5346414b7a6c"></a><!-- doxytag: member="Xapian::ESetIterator::get_weight" ref="7c3294162c194e248b4a5346414b7a6c" args="() const " -->
<a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#7c3294162c194e248b4a5346414b7a6c">get_weight</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the weight of the term at the current position. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6c2c1af1820e488bd2f8f53b67ad2dec"></a><!-- doxytag: member="Xapian::ESetIterator::get_description" ref="6c2c1af1820e488bd2f8f53b67ad2dec" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#6c2c1af1820e488bd2f8f53b67ad2dec">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="2ca621ecf6f96ce65281a2b03eb70c7d"></a><!-- doxytag: member="Xapian::ESetIterator::operator==" ref="2ca621ecf6f96ce65281a2b03eb70c7d" args="(const ESetIterator &a, const ESetIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#2ca621ecf6f96ce65281a2b03eb70c7d">operator==</a> (const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &a, const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality test for <a class="el" href="classXapian_1_1ESetIterator.html" title="Iterate through terms in the ESet.">ESetIterator</a> objects. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9bdc971a181b8bfb8d920f01df389715"></a><!-- doxytag: member="Xapian::ESetIterator::operator!=" ref="9bdc971a181b8bfb8d920f01df389715" args="(const ESetIterator &a, const ESetIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#9bdc971a181b8bfb8d920f01df389715">operator!=</a> (const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &a, const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inequality test for <a class="el" href="classXapian_1_1ESetIterator.html" title="Iterate through terms in the ESet.">ESetIterator</a> objects. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Iterate through terms in the <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a>. <hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="enquire_8h.html">enquire.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>
|