Sophie

Sophie

distrib > Fedora > 13 > x86_64 > by-pkgid > 2dc7ae7102ce788eb8a15dec0caf7708 > files > 136

xapian-core-devel-1.0.21-1.fc13.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::PostingIterator 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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<div class="nav">
<a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a></div>
<h1>Xapian::PostingIterator Class Reference</h1><!-- doxytag: class="Xapian::PostingIterator" -->An iterator pointing to items in a list of postings.  
<a href="#_details">More...</a>
<p>
<a href="classXapian_1_1PostingIterator-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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#9636fabaaf2aafe53360f9aa1761df63">iterator_category</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow use as an STL iterator.  <a href="#9636fabaaf2aafe53360f9aa1761df63"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#60981a31a4ba5671366aa809627b76d9">value_type</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow use as an STL iterator.  <a href="#60981a31a4ba5671366aa809627b76d9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="namespaceXapian.html#c0b722c47eee1eeef923379778e3ae5e">Xapian::doccount_diff</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#faa90b392dff540feee4e0d9d92d8f91">difference_type</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow use as an STL iterator.  <a href="#faa90b392dff540feee4e0d9d92d8f91"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#59828da586c32ab68945bcef939866ab">pointer</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow use as an STL iterator.  <a href="#59828da586c32ab68945bcef939866ab"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#81a3c3008c086650de2bac5ed8288e36">reference</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow use as an STL iterator.  <a href="#81a3c3008c086650de2bac5ed8288e36"></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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#476215e10caf32f1ca8a8eea3d8fd062">PostingIterator</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor - for declaring an uninitialised iterator.  <a href="#476215e10caf32f1ca8a8eea3d8fd062"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#c2df684770f57d9937368ad5b0eeac73">~PostingIterator</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#c2df684770f57d9937368ad5b0eeac73"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#4263f51239426840b71fb401d56fd0b9">PostingIterator</a> (const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &amp;other)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copying is allowed.  <a href="#4263f51239426840b71fb401d56fd0b9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#b93aec222d741b9813e837ad79415683">operator=</a> (const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &amp;other)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment is allowed.  <a href="#b93aec222d741b9813e837ad79415683"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4065fc68667c02e8a30637217433e26b"></a><!-- doxytag: member="Xapian::PostingIterator::operator++" ref="4065fc68667c02e8a30637217433e26b" args="()" -->
<a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator++</b> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="73ba3f7118718c9f6a1b59fd8527ba75"></a><!-- doxytag: member="Xapian::PostingIterator::operator++" ref="73ba3f7118718c9f6a1b59fd8527ba75" args="(int)" -->
DocIDWrapper&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator++</b> (int)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#48899d4bdf2c12e00ad433cf43d0c5ea">skip_to</a> (<a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a> did)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Skip the iterator to document did, or the first document after did if did isn't in the list of documents being iterated.  <a href="#48899d4bdf2c12e00ad433cf43d0c5ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#f365a9bd2886df40b6aabe27b7ad4d22">operator *</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the document id at the current position in the postlist.  <a href="#f365a9bd2886df40b6aabe27b7ad4d22"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#6c1c4bfd0b540caccbb5179976ebf792">Xapian::doclength</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#023b59d65dc154f406c3d342f714c6fa">get_doclength</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the length of the document at the current position in the postlist.  <a href="#023b59d65dc154f406c3d342f714c6fa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#755361182d062a92ecf17cbfd6f80c9b">get_wdf</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the within document frequency of the document at the current position in the postlist.  <a href="#755361182d062a92ecf17cbfd6f80c9b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#45d20eef15c1a383ad3a3e3f4d9378bf">positionlist_begin</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</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 document.  <a href="#45d20eef15c1a383ad3a3e3f4d9378bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#1359d7861e6d3179af51bbc4df28f4bd">positionlist_end</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</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 document.  <a href="#1359d7861e6d3179af51bbc4df28f4bd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#7c111a44142304bf6c287c3c9c1315cc">get_description</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a string describing this object.  <a href="#7c111a44142304bf6c287c3c9c1315cc"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html#789bdd29e5f87b9f32768b8b4e85b66b">operator==</a> (const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &amp;a, const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &amp;b)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test equality of two PostingIterators.  <a href="#789bdd29e5f87b9f32768b8b4e85b66b"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An iterator pointing to items in a list of postings. 
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="9636fabaaf2aafe53360f9aa1761df63"></a><!-- doxytag: member="Xapian::PostingIterator::iterator_category" ref="9636fabaaf2aafe53360f9aa1761df63" 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_1PostingIterator.html#9636fabaaf2aafe53360f9aa1761df63">Xapian::PostingIterator::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="60981a31a4ba5671366aa809627b76d9"></a><!-- doxytag: member="Xapian::PostingIterator::value_type" ref="60981a31a4ba5671366aa809627b76d9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a> <a class="el" href="classXapian_1_1PostingIterator.html#60981a31a4ba5671366aa809627b76d9">Xapian::PostingIterator::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="faa90b392dff540feee4e0d9d92d8f91"></a><!-- doxytag: member="Xapian::PostingIterator::difference_type" ref="faa90b392dff540feee4e0d9d92d8f91" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="namespaceXapian.html#c0b722c47eee1eeef923379778e3ae5e">Xapian::doccount_diff</a> <a class="el" href="classXapian_1_1PostingIterator.html#faa90b392dff540feee4e0d9d92d8f91">Xapian::PostingIterator::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="59828da586c32ab68945bcef939866ab"></a><!-- doxytag: member="Xapian::PostingIterator::pointer" ref="59828da586c32ab68945bcef939866ab" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a>* <a class="el" href="classXapian_1_1PostingIterator.html#59828da586c32ab68945bcef939866ab">Xapian::PostingIterator::pointer</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Allow use as an STL iterator. 
<p>

</div>
</div><p>
<a class="anchor" name="81a3c3008c086650de2bac5ed8288e36"></a><!-- doxytag: member="Xapian::PostingIterator::reference" ref="81a3c3008c086650de2bac5ed8288e36" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a>&amp; <a class="el" href="classXapian_1_1PostingIterator.html#81a3c3008c086650de2bac5ed8288e36">Xapian::PostingIterator::reference</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Allow use as an STL iterator. 
<p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="476215e10caf32f1ca8a8eea3d8fd062"></a><!-- doxytag: member="Xapian::PostingIterator::PostingIterator" ref="476215e10caf32f1ca8a8eea3d8fd062" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Xapian::PostingIterator::PostingIterator           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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="c2df684770f57d9937368ad5b0eeac73"></a><!-- doxytag: member="Xapian::PostingIterator::~PostingIterator" ref="c2df684770f57d9937368ad5b0eeac73" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Xapian::PostingIterator::~PostingIterator           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destructor. 
<p>

</div>
</div><p>
<a class="anchor" name="4263f51239426840b71fb401d56fd0b9"></a><!-- doxytag: member="Xapian::PostingIterator::PostingIterator" ref="4263f51239426840b71fb401d56fd0b9" args="(const PostingIterator &amp;other)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Xapian::PostingIterator::PostingIterator           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>other</em>          </td>
          <td>&nbsp;)&nbsp;</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="b93aec222d741b9813e837ad79415683"></a><!-- doxytag: member="Xapian::PostingIterator::operator=" ref="b93aec222d741b9813e837ad79415683" args="(const PostingIterator &amp;other)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Xapian::PostingIterator::operator=           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>other</em>          </td>
          <td>&nbsp;)&nbsp;</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="48899d4bdf2c12e00ad433cf43d0c5ea"></a><!-- doxytag: member="Xapian::PostingIterator::skip_to" ref="48899d4bdf2c12e00ad433cf43d0c5ea" args="(Xapian::docid did)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Xapian::PostingIterator::skip_to           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a>&nbsp;</td>
          <td class="paramname"> <em>did</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Skip the iterator to document did, or the first document after did if did isn't in the list of documents being iterated. 
<p>

</div>
</div><p>
<a class="anchor" name="f365a9bd2886df40b6aabe27b7ad4d22"></a><!-- doxytag: member="Xapian::PostingIterator::operator *" ref="f365a9bd2886df40b6aabe27b7ad4d22" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a> Xapian::PostingIterator::operator *           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the document id at the current position in the postlist. 
<p>

</div>
</div><p>
<a class="anchor" name="023b59d65dc154f406c3d342f714c6fa"></a><!-- doxytag: member="Xapian::PostingIterator::get_doclength" ref="023b59d65dc154f406c3d342f714c6fa" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceXapian.html#6c1c4bfd0b540caccbb5179976ebf792">Xapian::doclength</a> Xapian::PostingIterator::get_doclength           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the length of the document at the current position in the postlist. 
<p>
This information may be stored in the postlist, in which case this lookup should be extremely fast (indeed, not require further disk access). If the information is not present in the postlist, it will be retrieved from the database, at a greater performance cost. 
</div>
</div><p>
<a class="anchor" name="755361182d062a92ecf17cbfd6f80c9b"></a><!-- doxytag: member="Xapian::PostingIterator::get_wdf" ref="755361182d062a92ecf17cbfd6f80c9b" 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::PostingIterator::get_wdf           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the within document frequency of the document at the current position in the postlist. 
<p>

</div>
</div><p>
<a class="anchor" name="45d20eef15c1a383ad3a3e3f4d9378bf"></a><!-- doxytag: member="Xapian::PostingIterator::positionlist_begin" ref="45d20eef15c1a383ad3a3e3f4d9378bf" 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::PostingIterator::positionlist_begin           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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 document. 
<p>

</div>
</div><p>
<a class="anchor" name="1359d7861e6d3179af51bbc4df28f4bd"></a><!-- doxytag: member="Xapian::PostingIterator::positionlist_end" ref="1359d7861e6d3179af51bbc4df28f4bd" 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::PostingIterator::positionlist_end           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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 document. 
<p>

</div>
</div><p>
<a class="anchor" name="7c111a44142304bf6c287c3c9c1315cc"></a><!-- doxytag: member="Xapian::PostingIterator::get_description" ref="7c111a44142304bf6c287c3c9c1315cc" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string Xapian::PostingIterator::get_description           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return a string describing this object. 
<p>

</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="789bdd29e5f87b9f32768b8b4e85b66b"></a><!-- doxytag: member="Xapian::PostingIterator::operator==" ref="789bdd29e5f87b9f32768b8b4e85b66b" args="(const PostingIterator &amp;a, const PostingIterator &amp;b)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool operator==           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>a</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>b</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Test equality of two PostingIterators. 
<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="postingiterator_8h.html">postingiterator.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>