<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::FixedWeightPostingSource 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_1FixedWeightPostingSource.html">FixedWeightPostingSource</a>
</div>
</div>
<div class="contents">
<h1>Xapian::FixedWeightPostingSource Class Reference</h1><!-- doxytag: class="Xapian::FixedWeightPostingSource" --><!-- doxytag: inherits="Xapian::PostingSource" -->A posting source which returns a fixed weight for all documents.
<a href="#_details">More...</a>
<p>
<div class="dynheader">
Inheritance diagram for Xapian::FixedWeightPostingSource:</div>
<div class="dynsection">
<p><center><img src="classXapian_1_1FixedWeightPostingSource__inherit__graph.png" border="0" usemap="#Xapian_1_1FixedWeightPostingSource__inherit__map" alt="Inheritance graph"></center>
<map name="Xapian_1_1FixedWeightPostingSource__inherit__map">
<area shape="rect" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings." alt="" coords="43,7,205,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classXapian_1_1FixedWeightPostingSource-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 Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#f946b00ce498fa513a1f1a6781d70a61">FixedWeightPostingSource</a> (<a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> wt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1FixedWeightPostingSource.html" title="A posting source which returns a fixed weight for all documents.">FixedWeightPostingSource</a>. <a href="#f946b00ce498fa513a1f1a6781d70a61"></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_1FixedWeightPostingSource.html#42262ab06f7d9d2f3122bc3fb115b23e">get_termfreq_min</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A lower bound on the number of documents this object can return. <a href="#42262ab06f7d9d2f3122bc3fb115b23e"></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_1FixedWeightPostingSource.html#3296c3490733ac9f36e2dff0719746a5">get_termfreq_est</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An estimate of the number of documents this object can return. <a href="#3296c3490733ac9f36e2dff0719746a5"></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_1FixedWeightPostingSource.html#41f8f0e959f0d7daf5915b7507d4f5df">get_termfreq_max</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An upper bound on the number of documents this object can return. <a href="#41f8f0e959f0d7daf5915b7507d4f5df"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#8410aea1310c2fa7e5a078fe9429e6af">get_weight</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the weight contribution for the current document. <a href="#8410aea1310c2fa7e5a078fe9429e6af"></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_1FixedWeightPostingSource.html#77675d1d2175f8de6b10c363f0a73143">next</a> (<a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> min_wt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the current position to the next matching document. <a href="#77675d1d2175f8de6b10c363f0a73143"></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_1FixedWeightPostingSource.html#11598d752e5a8d2d3788430b120e665f">skip_to</a> (<a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> min_docid, <a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> min_wt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance to the specified docid. <a href="#11598d752e5a8d2d3788430b120e665f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#6b51fb24303528060e48df95ada3d989">check</a> (<a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> min_docid, <a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> min_wt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the specified docid occurs. <a href="#6b51fb24303528060e48df95ada3d989"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#c1913462adbcea9216b04180f62f41a0">at_end</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if the current position is past the last entry in this list. <a href="#c1913462adbcea9216b04180f62f41a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#f565f2685bec715d5cbd489f5acc50a3">get_docid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current docid. <a href="#f565f2685bec715d5cbd489f5acc50a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html">FixedWeightPostingSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#ad5669a2fa3d08bea18d0304823222d4">clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clone the posting source. <a href="#ad5669a2fa3d08bea18d0304823222d4"></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_1FixedWeightPostingSource.html#28fc3f906a9b56f8c4ebad2e82d3d531">name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name of the posting source class. <a href="#28fc3f906a9b56f8c4ebad2e82d3d531"></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_1FixedWeightPostingSource.html#b9f650935d97b18388dd112101336355">serialise</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Serialise object parameters into a string. <a href="#b9f650935d97b18388dd112101336355"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html">FixedWeightPostingSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#7d70385221859891b250e526c791ce67">unserialise</a> (const std::string &s) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create object given string serialisation returned by <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#b9f650935d97b18388dd112101336355" title="Serialise object parameters into a string.">serialise()</a>. <a href="#7d70385221859891b250e526c791ce67"></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_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077">init</a> (const <a class="el" href="classXapian_1_1Database.html">Database</a> &db_)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set this <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> to the start of the list of postings. <a href="#3c9698d1d0d4d47247bd19451e1e2077"></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_1FixedWeightPostingSource.html#eb48203eb1b35190d6bffe351bec38e5">get_description</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#eb48203eb1b35190d6bffe351bec38e5"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A posting source which returns a fixed weight for all documents.
<p>
This returns entries for all documents in the given database, with a fixed weight (specified by a parameter to the constructor). <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f946b00ce498fa513a1f1a6781d70a61"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::FixedWeightPostingSource" ref="f946b00ce498fa513a1f1a6781d70a61" args="(Xapian::weight wt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::FixedWeightPostingSource::FixedWeightPostingSource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td>
<td class="paramname"> <em>wt</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a <a class="el" href="classXapian_1_1FixedWeightPostingSource.html" title="A posting source which returns a fixed weight for all documents.">FixedWeightPostingSource</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>wt</em> </td><td>The fixed weight to return. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c1913462adbcea9216b04180f62f41a0"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::at_end" ref="c1913462adbcea9216b04180f62f41a0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Xapian::FixedWeightPostingSource::at_end </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return true if the current position is past the last entry in this list.
<p>
At least one of <em><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#77675d1d2175f8de6b10c363f0a73143" title="Advance the current position to the next matching document.">next()</a></em>, <em><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#11598d752e5a8d2d3788430b120e665f" title="Advance to the specified docid.">skip_to()</a></em> or <em><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#6b51fb24303528060e48df95ada3d989" title="Check if the specified docid occurs.">check()</a></em> will be called before this method is first called.
<p>Implements <a class="el" href="classXapian_1_1PostingSource.html#98831c9fdea1599f588cd9fef51bbeb5">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="6b51fb24303528060e48df95ada3d989"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::check" ref="6b51fb24303528060e48df95ada3d989" args="(Xapian::docid min_docid, Xapian::weight min_wt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Xapian::FixedWeightPostingSource::check </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> </td>
<td class="paramname"> <em>did</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td>
<td class="paramname"> <em>min_wt</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the specified docid occurs.
<p>
The caller is required to ensure that the specified document id <em>did</em> actually exists in the database. If it does, it must move to that document id, and return true. If it does not, it may either:<p>
<ul>
<li>return true, having moved to a definite position (including "at_end"), which must be the same position as <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#11598d752e5a8d2d3788430b120e665f" title="Advance to the specified docid.">skip_to()</a> would have moved to.</li></ul>
<p>
or<p>
<ul>
<li>return false, having moved to an "indeterminate" position, such that a subsequent call to <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#77675d1d2175f8de6b10c363f0a73143" title="Advance the current position to the next matching document.">next()</a> or <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#11598d752e5a8d2d3788430b120e665f" title="Advance to the specified docid.">skip_to()</a> will move to the next matching position after <em>did</em>.</li></ul>
<p>
Generally, this method should act like <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#11598d752e5a8d2d3788430b120e665f" title="Advance to the specified docid.">skip_to()</a> and return true if that can be done at little extra cost.<p>
Otherwise it should simply check if a particular docid is present, returning true if it is, and false if it isn't.<p>
The default implementation calls <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#11598d752e5a8d2d3788430b120e665f" title="Advance to the specified docid.">skip_to()</a> and always returns true.<p>
<a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will always call <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077" title="Set this PostingSource to the start of the list of postings.">init()</a> on a <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> before calling this for the first time.<p>
Note: in the case of a multi-database search, the docid specified is the docid in the single subdatabase relevant to this posting source. See the <em><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077" title="Set this PostingSource to the start of the list of postings.">init()</a></em> method for details.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>did</em> </td><td>The document id to check. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>min_wt</em> </td><td>The minimum weight contribution that is needed (this is just a hint which subclasses may ignore). </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#92098dee93d09781bb5ad48e86434873">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="ad5669a2fa3d08bea18d0304823222d4"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::clone" ref="ad5669a2fa3d08bea18d0304823222d4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html">FixedWeightPostingSource</a>* Xapian::FixedWeightPostingSource::clone </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clone the posting source.
<p>
The clone should inherit the configuration of the parent, but need not inherit the state. ie, the clone does not need to be in the same iteration position as the original: the matcher will always call <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077" title="Set this PostingSource to the start of the list of postings.">init()</a> on the clone before attempting to move the iterator, or read the information about the current position of the iterator.<p>
This may return NULL to indicate that cloning is not supported. In this case, the <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> may only be used with a single-database search.<p>
The default implementation returns NULL.<p>
Note that the returned object will be deallocated by <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> API for use from another language) then you can define a static <code>operator delete</code> method in your subclass as shown here: <a href="http://trac.xapian.org/ticket/554#comment:1">http://trac.xapian.org/ticket/554#comment:1</a>
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#ecd88a39155ec5e04c752360b657f315">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="eb48203eb1b35190d6bffe351bec38e5"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::get_description" ref="eb48203eb1b35190d6bffe351bec38e5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::FixedWeightPostingSource::get_description </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a string describing this object.
<p>
This default implementation returns a generic answer. This default it provided to avoid forcing those deriving their own <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> subclass from having to implement this (they may not care what <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#eb48203eb1b35190d6bffe351bec38e5" title="Return a string describing this object.">get_description()</a> gives for their subclass).
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#47d794241880cc691df1c3a3896d1050">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="f565f2685bec715d5cbd489f5acc50a3"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::get_docid" ref="f565f2685bec715d5cbd489f5acc50a3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> Xapian::FixedWeightPostingSource::get_docid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the current docid.
<p>
This method may assume that it will only be called when there is a "current document". See <em><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#8410aea1310c2fa7e5a078fe9429e6af" title="Return the weight contribution for the current document.">get_weight()</a></em> for details.<p>
Note: in the case of a multi-database search, the returned docid should be in the single subdatabase relevant to this posting source. See the <em><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077" title="Set this PostingSource to the start of the list of postings.">init()</a></em> method for details.
<p>Implements <a class="el" href="classXapian_1_1PostingSource.html#7b1bd1fcd07d69204f70155588ae544a">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="3296c3490733ac9f36e2dff0719746a5"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::get_termfreq_est" ref="3296c3490733ac9f36e2dff0719746a5" 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::FixedWeightPostingSource::get_termfreq_est </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An estimate of the number of documents this object can return.
<p>
It must always be true that:<p>
<a class="el" href="classXapian_1_1FixedWeightPostingSource.html#42262ab06f7d9d2f3122bc3fb115b23e" title="A lower bound on the number of documents this object can return.">get_termfreq_min()</a> <= <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3296c3490733ac9f36e2dff0719746a5" title="An estimate of the number of documents this object can return.">get_termfreq_est()</a> <= <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#41f8f0e959f0d7daf5915b7507d4f5df" title="An upper bound on the number of documents this object can return.">get_termfreq_max()</a><p>
<a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will always call <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077" title="Set this PostingSource to the start of the list of postings.">init()</a> on a <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> before calling this for the first time.
<p>Implements <a class="el" href="classXapian_1_1PostingSource.html#0d67eda5783f82951d6c56ad7ff4205b">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="41f8f0e959f0d7daf5915b7507d4f5df"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::get_termfreq_max" ref="41f8f0e959f0d7daf5915b7507d4f5df" 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::FixedWeightPostingSource::get_termfreq_max </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An upper bound on the number of documents this object can return.
<p>
<a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will always call <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077" title="Set this PostingSource to the start of the list of postings.">init()</a> on a <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> before calling this for the first time.
<p>Implements <a class="el" href="classXapian_1_1PostingSource.html#17de27c84a052c51d62ad498151a4cab">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="42262ab06f7d9d2f3122bc3fb115b23e"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::get_termfreq_min" ref="42262ab06f7d9d2f3122bc3fb115b23e" 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::FixedWeightPostingSource::get_termfreq_min </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A lower bound on the number of documents this object can return.
<p>
<a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will always call <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077" title="Set this PostingSource to the start of the list of postings.">init()</a> on a <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> before calling this for the first time.
<p>Implements <a class="el" href="classXapian_1_1PostingSource.html#5ecf450314e8b266eb9c8fae78e141d3">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="8410aea1310c2fa7e5a078fe9429e6af"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::get_weight" ref="8410aea1310c2fa7e5a078fe9429e6af" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> Xapian::FixedWeightPostingSource::get_weight </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the weight contribution for the current document.
<p>
This default implementation always returns 0, for convenience when implementing "weight-less" <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> subclasses.<p>
This method may assume that it will only be called when there is a "current document". In detail: <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will always call <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077" title="Set this PostingSource to the start of the list of postings.">init()</a> on a <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> before calling this for the first time. It will also only call this if the <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> reports that it is pointing to a valid document (ie, it will not call it before calling at least one of <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#77675d1d2175f8de6b10c363f0a73143" title="Advance the current position to the next matching document.">next()</a>, <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#11598d752e5a8d2d3788430b120e665f" title="Advance to the specified docid.">skip_to()</a> or <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#6b51fb24303528060e48df95ada3d989" title="Check if the specified docid occurs.">check()</a>, and will ensure that the <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> is not at the end by calling <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#c1913462adbcea9216b04180f62f41a0" title="Return true if the current position is past the last entry in this list.">at_end()</a>).
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#2e7637a323a90bea45f2dc68c916ea00">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="3c9698d1d0d4d47247bd19451e1e2077"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::init" ref="3c9698d1d0d4d47247bd19451e1e2077" args="(const Database &db_)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::FixedWeightPostingSource::init </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Database.html">Database</a> & </td>
<td class="paramname"> <em>db</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set this <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> to the start of the list of postings.
<p>
This is called automatically by the matcher prior to each query being processed.<p>
If a <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> is used for multiple searches, <em><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077" title="Set this PostingSource to the start of the list of postings.">init()</a></em> will therefore be called multiple times, and must handle this by using the database passed in the most recent call.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>The database which the <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> should iterate through.</td></tr>
</table>
</dl>
Note: the database supplied to this method must not be modified: in particular, the reopen() method should not be called on it.<p>
Note: in the case of a multi-database search, a separate <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> will be used for each database (the separate PostingSources will be obtained using <em><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#ad5669a2fa3d08bea18d0304823222d4" title="Clone the posting source.">clone()</a></em>), and each <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> will be passed one of the sub-databases as the <em>db</em> parameter here. The <em>db</em> parameter will therefore always refer to a single database. All docids passed to, or returned from, the <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> refer to docids in that single database, rather than in the multi-database.
<p>Implements <a class="el" href="classXapian_1_1PostingSource.html#81d793170b496022488c15c3508979b5">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="28fc3f906a9b56f8c4ebad2e82d3d531"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::name" ref="28fc3f906a9b56f8c4ebad2e82d3d531" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::FixedWeightPostingSource::name </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Name of the posting source class.
<p>
This is used when serialising and unserialising posting sources; for example, for performing remote searches.<p>
If the subclass is in a C++ namespace, the namespace should be included in the name, using "::" as a separator. For example, for a <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> subclass called "FooPostingSource" in the "Xapian" namespace the result of this call should be "Xapian::FooPostingSource".<p>
This should only be implemented if <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#b9f650935d97b18388dd112101336355" title="Serialise object parameters into a string.">serialise()</a> and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#7d70385221859891b250e526c791ce67" title="Create object given string serialisation returned by serialise().">unserialise()</a> are also implemented. The default implementation returns an empty string.<p>
If this returns an empty string, <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will assume that <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#b9f650935d97b18388dd112101336355" title="Serialise object parameters into a string.">serialise()</a> and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#7d70385221859891b250e526c791ce67" title="Create object given string serialisation returned by serialise().">unserialise()</a> are not implemented.
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#7b5c506178f996e59ed641ad62520734">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="77675d1d2175f8de6b10c363f0a73143"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::next" ref="77675d1d2175f8de6b10c363f0a73143" args="(Xapian::weight min_wt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::FixedWeightPostingSource::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td>
<td class="paramname"> <em>min_wt</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Advance the current position to the next matching document.
<p>
The <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> starts before the first entry in the list, so <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#77675d1d2175f8de6b10c363f0a73143" title="Advance the current position to the next matching document.">next()</a> must be called before any methods which need the context of the current position.<p>
<a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will always call <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077" title="Set this PostingSource to the start of the list of postings.">init()</a> on a <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> before calling this for the first time.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>min_wt</em> </td><td>The minimum weight contribution that is needed (this is just a hint which subclasses may ignore). </td></tr>
</table>
</dl>
<p>Implements <a class="el" href="classXapian_1_1PostingSource.html#fd0261e7b428c2a25245da07170e9635">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="b9f650935d97b18388dd112101336355"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::serialise" ref="b9f650935d97b18388dd112101336355" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::FixedWeightPostingSource::serialise </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Serialise object parameters into a string.
<p>
The serialised parameters should represent the configuration of the posting source, but need not (indeed, should not) represent the current iteration state.<p>
If you don't want to support the remote backend, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>.
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#6ad26dc173cf1ab175dea945ba2622e0">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="11598d752e5a8d2d3788430b120e665f"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::skip_to" ref="11598d752e5a8d2d3788430b120e665f" args="(Xapian::docid min_docid, Xapian::weight min_wt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::FixedWeightPostingSource::skip_to </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> </td>
<td class="paramname"> <em>did</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td>
<td class="paramname"> <em>min_wt</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Advance to the specified docid.
<p>
If the specified docid isn't in the list, position ourselves on the first document after it (or <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#c1913462adbcea9216b04180f62f41a0" title="Return true if the current position is past the last entry in this list.">at_end()</a> if no greater docids are present).<p>
If the current position is already the specified docid, this method will leave the position unmodified.<p>
If the specified docid is earlier than the current position, the behaviour is unspecified. A sensible behaviour would be to leave the current position unmodified, but it is also reasonable to move to the specified docid.<p>
The default implementation calls <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#77675d1d2175f8de6b10c363f0a73143" title="Advance the current position to the next matching document.">next()</a> repeatedly, which works but <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#11598d752e5a8d2d3788430b120e665f" title="Advance to the specified docid.">skip_to()</a> can often be implemented much more efficiently.<p>
<a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will always call <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077" title="Set this PostingSource to the start of the list of postings.">init()</a> on a <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> before calling this for the first time.<p>
Note: in the case of a multi-database search, the docid specified is the docid in the single subdatabase relevant to this posting source. See the <em><a class="el" href="classXapian_1_1FixedWeightPostingSource.html#3c9698d1d0d4d47247bd19451e1e2077" title="Set this PostingSource to the start of the list of postings.">init()</a></em> method for details.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>did</em> </td><td>The document id to advance to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>min_wt</em> </td><td>The minimum weight contribution that is needed (this is just a hint which subclasses may ignore). </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#02e3f5e29a0605d7f9e0a09decbdd9bf">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<a class="anchor" name="7d70385221859891b250e526c791ce67"></a><!-- doxytag: member="Xapian::FixedWeightPostingSource::unserialise" ref="7d70385221859891b250e526c791ce67" args="(const std::string &s) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html">FixedWeightPostingSource</a>* Xapian::FixedWeightPostingSource::unserialise </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>s</em> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create object given string serialisation returned by <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#b9f650935d97b18388dd112101336355" title="Serialise object parameters into a string.">serialise()</a>.
<p>
Note that the returned object will be deallocated by <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> API for use from another language) then you can define a static <code>operator delete</code> method in your subclass as shown here: <a href="http://trac.xapian.org/ticket/554#comment:1">http://trac.xapian.org/ticket/554#comment:1</a><p>
If you don't want to support the remote backend, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>A serialised instance of this <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> subclass. </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#b3312a9172b1881c354faf3d2d9b585d">Xapian::PostingSource</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="postingsource_8h.html">postingsource.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>
