Sophie

Sophie

distrib > Fedora > 13 > i386 > by-pkgid > 2dc7ae7102ce788eb8a15dec0caf7708 > files > 181

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::Weight 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_1Weight.html">Weight</a></div>
<h1>Xapian::Weight Class Reference</h1><!-- doxytag: class="Xapian::Weight" -->Abstract base class for weighting schemes.  
<a href="#_details">More...</a>
<p>
Inheritance diagram for Xapian::Weight:<p><center><img src="classXapian_1_1Weight__inherit__graph.png" border="0" usemap="#Xapian_1_1Weight__inherit__map" alt="Inheritance graph"></center>
<map name="Xapian_1_1Weight__inherit__map">
<area shape="rect" href="classXapian_1_1BM25Weight.html" title="BM25 weighting scheme." alt="" coords="5,84,155,111"><area shape="rect" href="classXapian_1_1BoolWeight.html" title="Boolean weighting scheme (everything gets 0)." alt="" coords="179,84,320,111"><area shape="rect" href="classXapian_1_1TradWeight.html" title="Traditional probabilistic weighting scheme." alt="" coords="344,84,483,111"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXapian_1_1Weight-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"><a class="el" href="classXapian_1_1Weight.html">Weight</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#6e656fe52c182b1f3d4c87db5d617855">create</a> (const Internal *internal_, <a class="el" href="namespaceXapian.html#6c1c4bfd0b540caccbb5179976ebf792">Xapian::doclength</a> querysize_, <a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> wqf_, const std::string &amp;tname_) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new weight object of the same type as this and initialise it with the specified statistics.  <a href="#6e656fe52c182b1f3d4c87db5d617855"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#b0a873c16f02bcf9ea54b632b7c8600a">name</a> () const=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of the weighting scheme.  <a href="#b0a873c16f02bcf9ea54b632b7c8600a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#b2ff0584c32e9db9f52dafed9e4e2bcf">serialise</a> () const=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Serialise object parameters into a string.  <a href="#b2ff0584c32e9db9f52dafed9e4e2bcf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXapian_1_1Weight.html">Weight</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#c6948bf58e52443ca6c8d5547bf14d14">unserialise</a> (const std::string &amp;s) const=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create object given string serialisation returned by <a class="el" href="classXapian_1_1Weight.html#b2ff0584c32e9db9f52dafed9e4e2bcf" title="Serialise object parameters into a string.">serialise()</a>.  <a href="#c6948bf58e52443ca6c8d5547bf14d14"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#35ac7463961ccfcfa7ff6abc170135f8">get_sumpart</a> (<a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> wdf, <a class="el" href="namespaceXapian.html#6c1c4bfd0b540caccbb5179976ebf792">Xapian::doclength</a> len) const=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a weight which is part of the sum over terms being performed.  <a href="#35ac7463961ccfcfa7ff6abc170135f8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#029bd952184c78f75126227de336f3f6">get_maxpart</a> () const=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the maximum value that <a class="el" href="classXapian_1_1Weight.html#35ac7463961ccfcfa7ff6abc170135f8" title="Get a weight which is part of the sum over terms being performed.">get_sumpart()</a> may return.  <a href="#029bd952184c78f75126227de336f3f6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#9fec5777ea998c2925b0960e3d9ca31c">get_sumextra</a> (<a class="el" href="namespaceXapian.html#6c1c4bfd0b540caccbb5179976ebf792">Xapian::doclength</a> len) const=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get an extra weight for a document to add to the sum calculated over the query terms.  <a href="#9fec5777ea998c2925b0960e3d9ca31c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#158796278206334879e4861d7ebc1040">get_maxextra</a> () const=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the maximum value that <a class="el" href="classXapian_1_1Weight.html#9fec5777ea998c2925b0960e3d9ca31c" title="Get an extra weight for a document to add to the sum calculated over the query terms...">get_sumextra()</a> may return.  <a href="#158796278206334879e4861d7ebc1040"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#057ce24c2d3a54dc6a6b3127d064ce9f">get_sumpart_needs_doclength</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return false if the weight object doesn't need doclength  <a href="#057ce24c2d3a54dc6a6b3127d064ce9f"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5586a3e276983d04512d2c2ef1b310c1"></a><!-- doxytag: member="Xapian::Weight::Weight" ref="5586a3e276983d04512d2c2ef1b310c1" args="(const Weight &amp;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Weight</b> (const <a class="el" href="classXapian_1_1Weight.html">Weight</a> &amp;)</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08253cb9d9933cfabe1438bb7e151160"></a><!-- doxytag: member="Xapian::Weight::internal" ref="08253cb9d9933cfabe1438bb7e151160" args="" -->
const Internal *&nbsp;</td><td class="memItemRight" valign="bottom"><b>internal</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0eae9eabe256961709fd3ad863c4b84f"></a><!-- doxytag: member="Xapian::Weight::querysize" ref="0eae9eabe256961709fd3ad863c4b84f" args="" -->
<a class="el" href="namespaceXapian.html#6c1c4bfd0b540caccbb5179976ebf792">Xapian::doclength</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>querysize</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4cc0e2a81c64e181d31fc1dc4dafa19"></a><!-- doxytag: member="Xapian::Weight::wqf" ref="b4cc0e2a81c64e181d31fc1dc4dafa19" args="" -->
<a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>wqf</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2023e496c198c8115f7d2747d3533fbf"></a><!-- doxytag: member="Xapian::Weight::tname" ref="2023e496c198c8115f7d2747d3533fbf" args="" -->
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>tname</b></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract base class for weighting schemes. 
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6e656fe52c182b1f3d4c87db5d617855"></a><!-- doxytag: member="Xapian::Weight::create" ref="6e656fe52c182b1f3d4c87db5d617855" args="(const Internal *internal_, Xapian::doclength querysize_, Xapian::termcount wqf_, const std::string &amp;tname_) const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classXapian_1_1Weight.html">Weight</a>* Xapian::Weight::create           </td>
          <td>(</td>
          <td class="paramtype">const Internal *&nbsp;</td>
          <td class="paramname"> <em>internal_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceXapian.html#6c1c4bfd0b540caccbb5179976ebf792">Xapian::doclength</a>&nbsp;</td>
          <td class="paramname"> <em>querysize_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a>&nbsp;</td>
          <td class="paramname"> <em>wqf_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>tname_</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a new weight object of the same type as this and initialise it with the specified statistics. 
<p>
You shouldn't call this method yourself - it's called by <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose...">Enquire</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>internal_</em>&nbsp;</td><td>Object to ask for collection statistics. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>querysize_</em>&nbsp;</td><td><a class="el" href="classXapian_1_1Query.html" title="Class representing a query.">Query</a> size. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>wqf_</em>&nbsp;</td><td>Within query frequency of term this object is associated with. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>tname_</em>&nbsp;</td><td>Term which this object is associated with. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="b0a873c16f02bcf9ea54b632b7c8600a"></a><!-- doxytag: member="Xapian::Weight::name" ref="b0a873c16f02bcf9ea54b632b7c8600a" args="() const=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string Xapian::Weight::name           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Name of the weighting scheme. 
<p>
If the subclass is called FooWeight, this should return "Foo". 
<p>
Implemented in <a class="el" href="classXapian_1_1BoolWeight.html#f6afab51d1849ebdbd429c7094e047f8">Xapian::BoolWeight</a>, <a class="el" href="classXapian_1_1BM25Weight.html#97584d9336aecc0316978aafdf463a3b">Xapian::BM25Weight</a>, and <a class="el" href="classXapian_1_1TradWeight.html#63160e95079b2b84e41b3b34bef6badd">Xapian::TradWeight</a>.
</div>
</div><p>
<a class="anchor" name="b2ff0584c32e9db9f52dafed9e4e2bcf"></a><!-- doxytag: member="Xapian::Weight::serialise" ref="b2ff0584c32e9db9f52dafed9e4e2bcf" args="() const=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string Xapian::Weight::serialise           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Serialise object parameters into a string. 
<p>

<p>
Implemented in <a class="el" href="classXapian_1_1BoolWeight.html#ecaa9899faaf1dc228abf8f086d7498a">Xapian::BoolWeight</a>, <a class="el" href="classXapian_1_1BM25Weight.html#98394bf1ed0024762c88b22d3dcf7b40">Xapian::BM25Weight</a>, and <a class="el" href="classXapian_1_1TradWeight.html#d6b38776d8e6f2b09e53aef2397b7198">Xapian::TradWeight</a>.
</div>
</div><p>
<a class="anchor" name="c6948bf58e52443ca6c8d5547bf14d14"></a><!-- doxytag: member="Xapian::Weight::unserialise" ref="c6948bf58e52443ca6c8d5547bf14d14" args="(const std::string &amp;s) const=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classXapian_1_1Weight.html">Weight</a>* Xapian::Weight::unserialise           </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>s</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create object given string serialisation returned by <a class="el" href="classXapian_1_1Weight.html#b2ff0584c32e9db9f52dafed9e4e2bcf" title="Serialise object parameters into a string.">serialise()</a>. 
<p>

<p>
Implemented in <a class="el" href="classXapian_1_1BoolWeight.html#e7eed49260e94c0f479b59c109bc744d">Xapian::BoolWeight</a>, <a class="el" href="classXapian_1_1BM25Weight.html#0f550b0f4d27348fb69aa198af7b4770">Xapian::BM25Weight</a>, and <a class="el" href="classXapian_1_1TradWeight.html#ee8a8d85ef74ebf75b40ad2adea8ab23">Xapian::TradWeight</a>.
</div>
</div><p>
<a class="anchor" name="35ac7463961ccfcfa7ff6abc170135f8"></a><!-- doxytag: member="Xapian::Weight::get_sumpart" ref="35ac7463961ccfcfa7ff6abc170135f8" args="(Xapian::termcount wdf, Xapian::doclength len) const=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> Xapian::Weight::get_sumpart           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a>&nbsp;</td>
          <td class="paramname"> <em>wdf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceXapian.html#6c1c4bfd0b540caccbb5179976ebf792">Xapian::doclength</a>&nbsp;</td>
          <td class="paramname"> <em>len</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a weight which is part of the sum over terms being performed. 
<p>
This returns a weight for a given term and document. These weights are summed to give a total weight for the document.<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>wdf</em>&nbsp;</td><td>the within document frequency of the term. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>the (unnormalised) document length. </td></tr>
  </table>
</dl>

<p>
Implemented in <a class="el" href="classXapian_1_1BoolWeight.html#d4f5043cab9fabb83e91fb66b2a3995f">Xapian::BoolWeight</a>, <a class="el" href="classXapian_1_1BM25Weight.html#20644c0662caec5ff4fe65b039cb1386">Xapian::BM25Weight</a>, and <a class="el" href="classXapian_1_1TradWeight.html#9a377b20d0a9b4347fe1aeed550e20b3">Xapian::TradWeight</a>.
</div>
</div><p>
<a class="anchor" name="029bd952184c78f75126227de336f3f6"></a><!-- doxytag: member="Xapian::Weight::get_maxpart" ref="029bd952184c78f75126227de336f3f6" args="() const=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> Xapian::Weight::get_maxpart           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Gets the maximum value that <a class="el" href="classXapian_1_1Weight.html#35ac7463961ccfcfa7ff6abc170135f8" title="Get a weight which is part of the sum over terms being performed.">get_sumpart()</a> may return. 
<p>
This is used in optimising searches, by having the postlist tree decay appropriately when parts of it can have limited, or no, further effect. 
<p>
Implemented in <a class="el" href="classXapian_1_1BoolWeight.html#f209ecd61f299feabcb1d996c2b6df28">Xapian::BoolWeight</a>, <a class="el" href="classXapian_1_1BM25Weight.html#c2055deab9c2532949ec229fa11c1ee2">Xapian::BM25Weight</a>, and <a class="el" href="classXapian_1_1TradWeight.html#f122c48a410974d24a408acccf2a6100">Xapian::TradWeight</a>.
</div>
</div><p>
<a class="anchor" name="9fec5777ea998c2925b0960e3d9ca31c"></a><!-- doxytag: member="Xapian::Weight::get_sumextra" ref="9fec5777ea998c2925b0960e3d9ca31c" args="(Xapian::doclength len) const=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> Xapian::Weight::get_sumextra           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceXapian.html#6c1c4bfd0b540caccbb5179976ebf792">Xapian::doclength</a>&nbsp;</td>
          <td class="paramname"> <em>len</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get an extra weight for a document to add to the sum calculated over the query terms. 
<p>
This returns a weight for a given document, and is used by some weighting schemes to account for influence such as document length.<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>len</em>&nbsp;</td><td>the (unnormalised) document length. </td></tr>
  </table>
</dl>

<p>
Implemented in <a class="el" href="classXapian_1_1BoolWeight.html#7713c9aee47dd4fb1f97f3cb9c0011e4">Xapian::BoolWeight</a>, <a class="el" href="classXapian_1_1BM25Weight.html#989abcfbed9b5406583297c705b51888">Xapian::BM25Weight</a>, and <a class="el" href="classXapian_1_1TradWeight.html#5f7a6a15698e5da5113e47774f3e4d32">Xapian::TradWeight</a>.
</div>
</div><p>
<a class="anchor" name="158796278206334879e4861d7ebc1040"></a><!-- doxytag: member="Xapian::Weight::get_maxextra" ref="158796278206334879e4861d7ebc1040" args="() const=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> Xapian::Weight::get_maxextra           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Gets the maximum value that <a class="el" href="classXapian_1_1Weight.html#9fec5777ea998c2925b0960e3d9ca31c" title="Get an extra weight for a document to add to the sum calculated over the query terms...">get_sumextra()</a> may return. 
<p>
This is used in optimising searches. 
<p>
Implemented in <a class="el" href="classXapian_1_1BoolWeight.html#6ad1e00c24065a9cab0a70dd56fcf7d4">Xapian::BoolWeight</a>, <a class="el" href="classXapian_1_1BM25Weight.html#c8b41f2715e49d6a8ef52e3373396073">Xapian::BM25Weight</a>, and <a class="el" href="classXapian_1_1TradWeight.html#98b79b4b899551b337978a9ec0d3e76e">Xapian::TradWeight</a>.
</div>
</div><p>
<a class="anchor" name="057ce24c2d3a54dc6a6b3127d064ce9f"></a><!-- doxytag: member="Xapian::Weight::get_sumpart_needs_doclength" ref="057ce24c2d3a54dc6a6b3127d064ce9f" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Xapian::Weight::get_sumpart_needs_doclength           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
return false if the weight object doesn't need doclength 
<p>

<p>
Reimplemented in <a class="el" href="classXapian_1_1BoolWeight.html#4a791e5299d29a71f5cac62bbf7ecad1">Xapian::BoolWeight</a>, <a class="el" href="classXapian_1_1BM25Weight.html#0f37ccfe48b94457303896803e621090">Xapian::BM25Weight</a>, and <a class="el" href="classXapian_1_1TradWeight.html#82a32a5da1b45342d2089027b97ea79b">Xapian::TradWeight</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="enquire_8h.html">enquire.h</a></ul>
<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>