<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>Xapian: API Documentation: xapian-core: Xapian::TermIterator 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.2 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</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="nav"> <a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a></div> <h1>Xapian::TermIterator Class Reference</h1><!-- doxytag: class="Xapian::TermIterator" -->An iterator pointing to items in a list of terms. <a href="#_details">More...</a> <p> <a href="classXapian_1_1TermIterator-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">typedef std::input_iterator_tag </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#2e96a394a0b09a79141addc4d2f32d5d">iterator_category</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#2e96a394a0b09a79141addc4d2f32d5d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#e52d4b2c4cdb5f25941946947abb229c">value_type</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#e52d4b2c4cdb5f25941946947abb229c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="namespaceXapian.html#d2d5022b715dc424202f74eef3bdefc5">Xapian::termcount_diff</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#a26ac169041e051936dd708c9de33ec8">difference_type</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#a26ac169041e051936dd708c9de33ec8"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::string * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#7c2a5bdd8365cc5926e465a33357ebeb">pointer</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#7c2a5bdd8365cc5926e465a33357ebeb"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#6b7df85ea894a0756ad3ab443719316d">reference</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#6b7df85ea894a0756ad3ab443719316d"></a><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="1e8704809a8c9deb5e96ed2ce730289e"></a><!-- doxytag: member="Xapian::TermIterator::TermIterator" ref="1e8704809a8c9deb5e96ed2ce730289e" args="(Internal *internal_)" --> </td><td class="memItemRight" valign="bottom"><b>TermIterator</b> (Internal *internal_)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#4dd8537f0d40a92de8159b5c03f83ad7">TermIterator</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor - for declaring an uninitialised iterator. <a href="#4dd8537f0d40a92de8159b5c03f83ad7"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#ac4fa4043068b4655e05a50edddd5daa">~TermIterator</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac4fa4043068b4655e05a50edddd5daa"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#7317d1644272e0213af37aef8282a378">TermIterator</a> (const <a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> &other)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed. <a href="#7317d1644272e0213af37aef8282a378"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#5ee9fa4dfe45d69f0a110047e250a242">operator=</a> (const <a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> &other)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed. <a href="#5ee9fa4dfe45d69f0a110047e250a242"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#e533cf9c3a8cf1206d8411100f42a091">operator *</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current term. <a href="#e533cf9c3a8cf1206d8411100f42a091"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="88386d757741c6de6d99c427e5e011e2"></a><!-- doxytag: member="Xapian::TermIterator::operator++" ref="88386d757741c6de6d99c427e5e011e2" args="()" --> <a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> & </td><td class="memItemRight" valign="bottom"><b>operator++</b> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6890c46682994a153ab3e9830020988d"></a><!-- doxytag: member="Xapian::TermIterator::operator++" ref="6890c46682994a153ab3e9830020988d" args="(int)" --> TermNameWrapper </td><td class="memItemRight" valign="bottom"><b>operator++</b> (int)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#cca3d561fb53fffc89c52318dc55bd39">skip_to</a> (const std::string &tname)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Skip the iterator to term tname, or the first term after tname if tname isn't in the list of terms being iterated. <a href="#cca3d561fb53fffc89c52318dc55bd39"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#ac645aa8e0510cfff04fe70fe51a940d">get_wdf</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the wdf of the current term (if meaningful). <a href="#ac645aa8e0510cfff04fe70fe51a940d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#15c014c4f733e0595eeff176772c7fd5">get_termfreq</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the term frequency of the current term (if meaningful). <a href="#15c014c4f733e0595eeff176772c7fd5"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#ef1fe85a65dfe323a865ca5d8a8f5442">positionlist_count</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return length of positionlist for current term. <a href="#ef1fe85a65dfe323a865ca5d8a8f5442"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#6547db7da8ea6d45dd2e9a8ca62a1a10">positionlist_begin</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return <a class="el" href="classXapian_1_1PositionIterator.html" title="An iterator pointing to items in a list of positions.">PositionIterator</a> pointing to start of positionlist for current term. <a href="#6547db7da8ea6d45dd2e9a8ca62a1a10"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#8273565a0cba6a64108606ed7eedfe74">positionlist_end</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return <a class="el" href="classXapian_1_1PositionIterator.html" title="An iterator pointing to items in a list of positions.">PositionIterator</a> pointing to end of positionlist for current term. <a href="#8273565a0cba6a64108606ed7eedfe74"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#b5d7354d425085330eb0db46bee52275">get_description</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#b5d7354d425085330eb0db46bee52275"></a><br></td></tr> <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9385bafbf6d771dbdaaece98edcc553"></a><!-- doxytag: member="Xapian::TermIterator::internal" ref="a9385bafbf6d771dbdaaece98edcc553" args="" --> Xapian::Internal::RefCntPtr<<br> Internal > </td><td class="memItemRight" valign="bottom"><b>internal</b></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> An iterator pointing to items in a list of terms. <p> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="2e96a394a0b09a79141addc4d2f32d5d"></a><!-- doxytag: member="Xapian::TermIterator::iterator_category" ref="2e96a394a0b09a79141addc4d2f32d5d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef std::input_iterator_tag <a class="el" href="classXapian_1_1TermIterator.html#2e96a394a0b09a79141addc4d2f32d5d">Xapian::TermIterator::iterator_category</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Allow use as an STL iterator. <p> </div> </div><p> <a class="anchor" name="e52d4b2c4cdb5f25941946947abb229c"></a><!-- doxytag: member="Xapian::TermIterator::value_type" ref="e52d4b2c4cdb5f25941946947abb229c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef std::string <a class="el" href="classXapian_1_1TermIterator.html#e52d4b2c4cdb5f25941946947abb229c">Xapian::TermIterator::value_type</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Allow use as an STL iterator. <p> </div> </div><p> <a class="anchor" name="a26ac169041e051936dd708c9de33ec8"></a><!-- doxytag: member="Xapian::TermIterator::difference_type" ref="a26ac169041e051936dd708c9de33ec8" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="namespaceXapian.html#d2d5022b715dc424202f74eef3bdefc5">Xapian::termcount_diff</a> <a class="el" href="classXapian_1_1TermIterator.html#a26ac169041e051936dd708c9de33ec8">Xapian::TermIterator::difference_type</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Allow use as an STL iterator. <p> </div> </div><p> <a class="anchor" name="7c2a5bdd8365cc5926e465a33357ebeb"></a><!-- doxytag: member="Xapian::TermIterator::pointer" ref="7c2a5bdd8365cc5926e465a33357ebeb" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef std::string* <a class="el" href="classXapian_1_1TermIterator.html#7c2a5bdd8365cc5926e465a33357ebeb">Xapian::TermIterator::pointer</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Allow use as an STL iterator. <p> </div> </div><p> <a class="anchor" name="6b7df85ea894a0756ad3ab443719316d"></a><!-- doxytag: member="Xapian::TermIterator::reference" ref="6b7df85ea894a0756ad3ab443719316d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef std::string& <a class="el" href="classXapian_1_1TermIterator.html#6b7df85ea894a0756ad3ab443719316d">Xapian::TermIterator::reference</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Allow use as an STL iterator. <p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="4dd8537f0d40a92de8159b5c03f83ad7"></a><!-- doxytag: member="Xapian::TermIterator::TermIterator" ref="4dd8537f0d40a92de8159b5c03f83ad7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Xapian::TermIterator::TermIterator </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Default constructor - for declaring an uninitialised iterator. <p> </div> </div><p> <a class="anchor" name="ac4fa4043068b4655e05a50edddd5daa"></a><!-- doxytag: member="Xapian::TermIterator::~TermIterator" ref="ac4fa4043068b4655e05a50edddd5daa" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Xapian::TermIterator::~TermIterator </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Destructor. <p> </div> </div><p> <a class="anchor" name="7317d1644272e0213af37aef8282a378"></a><!-- doxytag: member="Xapian::TermIterator::TermIterator" ref="7317d1644272e0213af37aef8282a378" args="(const TermIterator &other)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Xapian::TermIterator::TermIterator </td> <td>(</td> <td class="paramtype">const <a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> & </td> <td class="paramname"> <em>other</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Copying is allowed. <p> The internals are reference counted, so copying is also cheap. </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="5ee9fa4dfe45d69f0a110047e250a242"></a><!-- doxytag: member="Xapian::TermIterator::operator=" ref="5ee9fa4dfe45d69f0a110047e250a242" args="(const TermIterator &other)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Xapian::TermIterator::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> & </td> <td class="paramname"> <em>other</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Assignment is allowed. <p> The internals are reference counted, so assignment is also cheap. </div> </div><p> <a class="anchor" name="e533cf9c3a8cf1206d8411100f42a091"></a><!-- doxytag: member="Xapian::TermIterator::operator *" ref="e533cf9c3a8cf1206d8411100f42a091" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string Xapian::TermIterator::operator * </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Return the current term. <p> </div> </div><p> <a class="anchor" name="cca3d561fb53fffc89c52318dc55bd39"></a><!-- doxytag: member="Xapian::TermIterator::skip_to" ref="cca3d561fb53fffc89c52318dc55bd39" args="(const std::string &tname)" --> <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>tname</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Skip the iterator to term tname, or the first term after tname if tname isn't in the list of terms being iterated. <p> </div> </div><p> <a class="anchor" name="ac645aa8e0510cfff04fe70fe51a940d"></a><!-- doxytag: member="Xapian::TermIterator::get_wdf" ref="ac645aa8e0510cfff04fe70fe51a940d" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> Xapian::TermIterator::get_wdf </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Return the wdf of the current term (if meaningful). <p> The wdf (within document frequency) is the number of occurences of a term in a particular document. </div> </div><p> <a class="anchor" name="15c014c4f733e0595eeff176772c7fd5"></a><!-- doxytag: member="Xapian::TermIterator::get_termfreq" ref="15c014c4f733e0595eeff176772c7fd5" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> Xapian::TermIterator::get_termfreq </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Return the term frequency of the current term (if meaningful). <p> The term frequency is the number of documents which a term indexes. </div> </div><p> <a class="anchor" name="ef1fe85a65dfe323a865ca5d8a8f5442"></a><!-- doxytag: member="Xapian::TermIterator::positionlist_count" ref="ef1fe85a65dfe323a865ca5d8a8f5442" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> Xapian::TermIterator::positionlist_count </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Return length of positionlist for current term. <p> </div> </div><p> <a class="anchor" name="6547db7da8ea6d45dd2e9a8ca62a1a10"></a><!-- doxytag: member="Xapian::TermIterator::positionlist_begin" ref="6547db7da8ea6d45dd2e9a8ca62a1a10" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> Xapian::TermIterator::positionlist_begin </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Return <a class="el" href="classXapian_1_1PositionIterator.html" title="An iterator pointing to items in a list of positions.">PositionIterator</a> pointing to start of positionlist for current term. <p> </div> </div><p> <a class="anchor" name="8273565a0cba6a64108606ed7eedfe74"></a><!-- doxytag: member="Xapian::TermIterator::positionlist_end" ref="8273565a0cba6a64108606ed7eedfe74" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> Xapian::TermIterator::positionlist_end </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Return <a class="el" href="classXapian_1_1PositionIterator.html" title="An iterator pointing to items in a list of positions.">PositionIterator</a> pointing to end of positionlist for current term. <p> </div> </div><p> <a class="anchor" name="b5d7354d425085330eb0db46bee52275"></a><!-- doxytag: member="Xapian::TermIterator::get_description" ref="b5d7354d425085330eb0db46bee52275" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string Xapian::TermIterator::get_description </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Return a string describing this object. <p> </div> </div><p> <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></ul> <hr> <address><small> Documentation for Xapian (version 1.0.21).<br> Generated on 18 Jun 2010 by <a href="http://www.doxygen.org/">Doxygen 1.5.2</a>. </small></address> </body> </html>