<!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.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_1TermIterator.html">TermIterator</a>
</div>
</div>
<div class="contents">
<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>
<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"><a class="anchor" name="feab33f745f72c8e9c24a58fe1e25800"></a><!-- doxytag: member="Xapian::TermIterator::iterator_category" ref="feab33f745f72c8e9c24a58fe1e25800" args="" -->
typedef std::input_iterator_tag </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#feab33f745f72c8e9c24a58fe1e25800">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="1f80825c29a2d6e16f3d4008cedb7833"></a><!-- doxytag: member="Xapian::TermIterator::value_type" ref="1f80825c29a2d6e16f3d4008cedb7833" args="" -->
typedef std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#1f80825c29a2d6e16f3d4008cedb7833">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="2caca0d976af5309003b95e66cbebe73"></a><!-- doxytag: member="Xapian::TermIterator::difference_type" ref="2caca0d976af5309003b95e66cbebe73" 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_1TermIterator.html#2caca0d976af5309003b95e66cbebe73">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="c674b6f574ee46bb6725c0fd41d06fc2"></a><!-- doxytag: member="Xapian::TermIterator::pointer" ref="c674b6f574ee46bb6725c0fd41d06fc2" args="" -->
typedef std::string * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#c674b6f574ee46bb6725c0fd41d06fc2">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="32f947d758ed204f39f099487412a878"></a><!-- doxytag: member="Xapian::TermIterator::reference" ref="32f947d758ed204f39f099487412a878" args="" -->
typedef std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#32f947d758ed204f39f099487412a878">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="fd50fb35c84e433fc3762447e28b4bab"></a><!-- doxytag: member="Xapian::TermIterator::TermIterator" ref="fd50fb35c84e433fc3762447e28b4bab" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#fd50fb35c84e433fc3762447e28b4bab">TermIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor - for declaring an uninitialised iterator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="914de6019011c9c25b00e84f556af681"></a><!-- doxytag: member="Xapian::TermIterator::~TermIterator" ref="914de6019011c9c25b00e84f556af681" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#914de6019011c9c25b00e84f556af681">~TermIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <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#25c1623d9275a88c8a061d1f19b36296">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="#25c1623d9275a88c8a061d1f19b36296"></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#feb284448d65b6e86914c552808938df">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="#feb284448d65b6e86914c552808938df"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd766c721040fbca391aa13506be9e31"></a><!-- doxytag: member="Xapian::TermIterator::operator*" ref="dd766c721040fbca391aa13506be9e31" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#dd766c721040fbca391aa13506be9e31">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current term. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="04d4db66b44b0e948f8cd925130aacb0"></a><!-- doxytag: member="Xapian::TermIterator::operator++" ref="04d4db66b44b0e948f8cd925130aacb0" args="()" -->
<a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#04d4db66b44b0e948f8cd925130aacb0">operator++</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the next position. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a425243a43291345eef2659fb1d085f"></a><!-- doxytag: member="Xapian::TermIterator::operator++" ref="2a425243a43291345eef2659fb1d085f" args="(int)" -->
DerefWrapper_< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#2a425243a43291345eef2659fb1d085f">operator++</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the next position (postfix version). <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#3b0a7bdae1ac63ee187fa2063d7aeb35">skip_to</a> (const std::string &tname)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the specified term. <a href="#3b0a7bdae1ac63ee187fa2063d7aeb35"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#aad6e6fcfc9ffb513cef923b65adf6e8">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="#aad6e6fcfc9ffb513cef923b65adf6e8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#68adffacecf143bdafafdb35ecac8511">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="#68adffacecf143bdafafdb35ecac8511"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6ecd77a64b324ddffaa25e9901e362be"></a><!-- doxytag: member="Xapian::TermIterator::positionlist_count" ref="6ecd77a64b324ddffaa25e9901e362be" args="() const " -->
<a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#6ecd77a64b324ddffaa25e9901e362be">positionlist_count</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return length of positionlist for current term. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5cae68c58a8f405721732529d2144d6"></a><!-- doxytag: member="Xapian::TermIterator::positionlist_begin" ref="c5cae68c58a8f405721732529d2144d6" args="() const " -->
<a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#c5cae68c58a8f405721732529d2144d6">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68a6157a501e51b7043ba86676be026f"></a><!-- doxytag: member="Xapian::TermIterator::positionlist_end" ref="68a6157a501e51b7043ba86676be026f" args="() const " -->
<a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#68a6157a501e51b7043ba86676be026f">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a7aeca02e3c4dc43d7553f6a0c19abf"></a><!-- doxytag: member="Xapian::TermIterator::get_description" ref="9a7aeca02e3c4dc43d7553f6a0c19abf" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html#9a7aeca02e3c4dc43d7553f6a0c19abf">get_description</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An iterator pointing to items in a list of terms. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="25c1623d9275a88c8a061d1f19b36296"></a><!-- doxytag: member="Xapian::TermIterator::TermIterator" ref="25c1623d9275a88c8a061d1f19b36296" 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></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="68adffacecf143bdafafdb35ecac8511"></a><!-- doxytag: member="Xapian::TermIterator::get_termfreq" ref="68adffacecf143bdafafdb35ecac8511" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> Xapian::TermIterator::get_termfreq </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> 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="aad6e6fcfc9ffb513cef923b65adf6e8"></a><!-- doxytag: member="Xapian::TermIterator::get_wdf" ref="aad6e6fcfc9ffb513cef923b65adf6e8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> Xapian::TermIterator::get_wdf </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> 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 occurrences of a term in a particular document.
</div>
</div><p>
<a class="anchor" name="feb284448d65b6e86914c552808938df"></a><!-- doxytag: member="Xapian::TermIterator::operator=" ref="feb284448d65b6e86914c552808938df" 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></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="3b0a7bdae1ac63ee187fa2063d7aeb35"></a><!-- doxytag: member="Xapian::TermIterator::skip_to" ref="3b0a7bdae1ac63ee187fa2063d7aeb35" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Advance the iterator to the specified term.
<p>
If the specified term isn't in the list, position ourselves on the first term after it (or at_end() if no greater terms are present).
</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>
</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>
