| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 |
<meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 6 |
<meta name="generator" content="Doxygen 1.15.0"/> |
| 7 |
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 |
<title>Xapian: API Documentation: Xapian::PL2PlusWeight Class Reference</title> |
| 9 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 |
<script type="text/javascript" src="jquery.js"></script> |
| 11 |
<script type="text/javascript" src="dynsections.js"></script> |
| 12 |
<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 13 |
</head> |
| 14 |
<body> |
| 15 |
<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 16 |
<div id="titlearea"> |
| 17 |
<table cellspacing="0" cellpadding="0"> |
| 18 |
<tbody> |
| 19 |
<tr style="height: 56px;"> |
| 20 |
<td id="projectalign" style="padding-left: 0.5em;"> |
| 21 |
<div id="projectname">xapian-core |
| 22 |
 <span id="projectnumber">1.4.31</span> |
| 23 |
</div> |
| 24 |
</td> |
| 25 |
</tr> |
| 26 |
</tbody> |
| 27 |
</table> |
| 28 |
</div> |
| 29 |
<!-- end header part --> |
| 30 |
<!-- Generated by Doxygen 1.15.0 --> |
| 31 |
<script type="text/javascript"> |
| 32 |
$(function() { codefold.init(); }); |
| 33 |
</script> |
| 34 |
<script type="text/javascript" src="menudata.js"></script> |
| 35 |
<script type="text/javascript" src="menu.js"></script> |
| 36 |
<script type="text/javascript"> |
| 37 |
$(function() { |
| 38 |
initMenu('',false,false,'search.php','Search',false); |
| 39 |
}); |
| 40 |
</script> |
| 41 |
<div id="main-nav"></div> |
| 42 |
<div id="nav-path" class="navpath"> |
| 43 |
<ul> |
| 44 |
<li class="navelem"><a href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a href="classXapian_1_1PL2PlusWeight.html">PL2PlusWeight</a></li> </ul> |
| 45 |
</div> |
| 46 |
</div><!-- top --> |
| 47 |
<div id="doc-content"> |
| 48 |
<div class="header"> |
| 49 |
<div class="summary"> |
| 50 |
<a href="#pub-methods">Public Member Functions</a> | |
| 51 |
<a href="classXapian_1_1PL2PlusWeight-members.html">List of all members</a> </div> |
| 52 |
<div class="headertitle"><div class="title">Xapian::PL2PlusWeight Class Reference</div></div> |
| 53 |
</div><!--header--> |
| 54 |
<div class="contents"> |
| 55 |
|
| 56 |
<p><a class="el" href="classXapian_1_1Weight.html" title="Abstract base class for weighting schemes.">Xapian::Weight</a> subclass implementing the PL2+ probabilistic formula. |
| 57 |
<a href="#details">More...</a></p> |
| 58 |
|
| 59 |
<p><code>#include <weight.h></code></p> |
| 60 |
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Inheritance diagram for Xapian::PL2PlusWeight:</div> |
| 61 |
<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> |
| 62 |
</div> |
| 63 |
<div id="dynsection-0-content" class="dyncontent" style="display:none;"> |
| 64 |
<div class="center"><img src="classXapian_1_1PL2PlusWeight__inherit__graph.png" border="0" usemap="#aXapian_1_1PL2PlusWeight_inherit__map" loading="lazy" alt="Inheritance graph"/></div> |
| 65 |
<map name="aXapian_1_1PL2PlusWeight_inherit__map" id="aXapian_1_1PL2PlusWeight_inherit__map"> |
| 66 |
<area shape="rect" title="Xapian::Weight subclass implementing the PL2+ probabilistic formula." alt="" coords="5,81,176,109"/> |
| 67 |
<area shape="rect" href="classXapian_1_1Weight.html" title="Abstract base class for weighting schemes." alt="" coords="30,5,151,33"/> |
| 68 |
<area shape="poly" title=" " alt="" coords="92,47,93,82,88,80,89,51"/> |
| 69 |
</map> |
| 70 |
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> |
| 71 |
<table class="memberdecls"> |
| 72 |
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| 73 |
Public Member Functions</h2></td></tr> |
| 74 |
<tr class="memitem:a7a72ac48020341a691d5e8da5fe8a10c" id="r_a7a72ac48020341a691d5e8da5fe8a10c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7a72ac48020341a691d5e8da5fe8a10c">PL2PlusWeight</a> (double c, double delta)</td></tr> |
| 75 |
<tr class="memdesc:a7a72ac48020341a691d5e8da5fe8a10c"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1PL2PlusWeight.html" title="Xapian::Weight subclass implementing the PL2+ probabilistic formula.">PL2PlusWeight</a>. <br /></td></tr> |
| 76 |
<tr class="memitem:ac86eb422d8b88370f1bb1be811d5819b" id="r_ac86eb422d8b88370f1bb1be811d5819b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac86eb422d8b88370f1bb1be811d5819b">name</a> () const</td></tr> |
| 77 |
<tr class="memdesc:ac86eb422d8b88370f1bb1be811d5819b"><td class="mdescLeft"> </td><td class="mdescRight">Return the name of this weighting scheme. <br /></td></tr> |
| 78 |
<tr class="memitem:ad898cc39b2e53afde6eacf229cfaa707" id="r_ad898cc39b2e53afde6eacf229cfaa707"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad898cc39b2e53afde6eacf229cfaa707">serialise</a> () const</td></tr> |
| 79 |
<tr class="memdesc:ad898cc39b2e53afde6eacf229cfaa707"><td class="mdescLeft"> </td><td class="mdescRight">Return this object's parameters serialised as a single string. <br /></td></tr> |
| 80 |
<tr class="memitem:afa3b071e291a1a3e8052d83a6e935c0a" id="r_afa3b071e291a1a3e8052d83a6e935c0a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a7a72ac48020341a691d5e8da5fe8a10c">PL2PlusWeight</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#afa3b071e291a1a3e8052d83a6e935c0a">unserialise</a> (const std::string &serialised) const</td></tr> |
| 81 |
<tr class="memdesc:afa3b071e291a1a3e8052d83a6e935c0a"><td class="mdescLeft"> </td><td class="mdescRight">Unserialise parameters. <br /></td></tr> |
| 82 |
<tr class="memitem:a9c26ec6866d3878d5f408bc9627799d8" id="r_a9c26ec6866d3878d5f408bc9627799d8"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9c26ec6866d3878d5f408bc9627799d8">get_sumpart</a> (<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> wdf, <a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> doclen, <a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> uniqterms) const</td></tr> |
| 83 |
<tr class="memdesc:a9c26ec6866d3878d5f408bc9627799d8"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the weight contribution for this object's term to a document. <br /></td></tr> |
| 84 |
<tr class="memitem:a35409d11a6f882f12255ba335e9c4261" id="r_a35409d11a6f882f12255ba335e9c4261"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#a35409d11a6f882f12255ba335e9c4261">get_maxpart</a> () const</td></tr> |
| 85 |
<tr class="memdesc:a35409d11a6f882f12255ba335e9c4261"><td class="mdescLeft"> </td><td class="mdescRight">Return an upper bound on what <a class="el" href="#a9c26ec6866d3878d5f408bc9627799d8" title="Calculate the weight contribution for this object's term to a document.">get_sumpart()</a> can return for any document. <br /></td></tr> |
| 86 |
<tr class="memitem:aacd38b642ea498b44310c8ac8d4cb3cf" id="r_aacd38b642ea498b44310c8ac8d4cb3cf"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#aacd38b642ea498b44310c8ac8d4cb3cf">get_sumextra</a> (<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> doclen, <a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> uniqterms) const</td></tr> |
| 87 |
<tr class="memdesc:aacd38b642ea498b44310c8ac8d4cb3cf"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the term-independent weight component for a document. <br /></td></tr> |
| 88 |
<tr class="memitem:abdac1ec6592ba025c3636410757f2747" id="r_abdac1ec6592ba025c3636410757f2747"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="#abdac1ec6592ba025c3636410757f2747">get_maxextra</a> () const</td></tr> |
| 89 |
<tr class="memdesc:abdac1ec6592ba025c3636410757f2747"><td class="mdescLeft"> </td><td class="mdescRight">Return an upper bound on what <a class="el" href="#aacd38b642ea498b44310c8ac8d4cb3cf" title="Calculate the term-independent weight component for a document.">get_sumextra()</a> can return for any document. <br /></td></tr> |
| 90 |
<tr class="inherit_header pub_methods_classXapian_1_1Weight"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classXapian_1_1Weight')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="classXapian_1_1Weight.html">Xapian::Weight</a></td></tr> |
| 91 |
<tr class="memitem:a48e8f4d351f2a090bcec111513833e0f inherit pub_methods_classXapian_1_1Weight" id="r_a48e8f4d351f2a090bcec111513833e0f"><td class="memItemLeft" align="right" valign="top"> |
| 92 |
 </td><td class="memItemRight" valign="bottom"><b>Weight</b> ()</td></tr> |
| 93 |
<tr class="memdesc:a48e8f4d351f2a090bcec111513833e0f inherit pub_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor, needed by subclass constructors. <br /></td></tr> |
| 94 |
<tr class="memitem:adcc0dd3e0c762597e89720043440a0bd inherit pub_methods_classXapian_1_1Weight" id="r_adcc0dd3e0c762597e89720043440a0bd"><td class="memItemLeft" align="right" valign="top"> |
| 95 |
virtual </td><td class="memItemRight" valign="bottom"><b>~Weight</b> ()</td></tr> |
| 96 |
<tr class="memdesc:adcc0dd3e0c762597e89720043440a0bd inherit pub_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor, because we have virtual methods. <br /></td></tr> |
| 97 |
</table><table class="memberdecls"> |
| 98 |
<tr class="heading"><td colspan="2"><h2 id="header-inherited" class="groupheader"><a id="inherited" name="inherited"></a> |
| 99 |
Additional Inherited Members</h2></td></tr> |
| 100 |
<tr class="inherit_header pub_types_classXapian_1_1Weight"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_classXapian_1_1Weight')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Types inherited from <a class="el" href="classXapian_1_1Weight.html">Xapian::Weight</a></td></tr> |
| 101 |
<tr class="memitem:a3181bb7619bd560a3a2c21ece3213ce0 inherit pub_types_classXapian_1_1Weight" id="r_a3181bb7619bd560a3a2c21ece3213ce0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#a3181bb7619bd560a3a2c21ece3213ce0">type_smoothing</a> { <br /> |
| 102 |
  <b>TWO_STAGE_SMOOTHING</b> = 1 |
| 103 |
, <b>DIRICHLET_SMOOTHING</b> = 2 |
| 104 |
, <b>ABSOLUTE_DISCOUNT_SMOOTHING</b> = 3 |
| 105 |
, <b>JELINEK_MERCER_SMOOTHING</b> = 4 |
| 106 |
, <br /> |
| 107 |
  <b>DIRICHLET_PLUS_SMOOTHING</b> = 5 |
| 108 |
<br /> |
| 109 |
}</td></tr> |
| 110 |
<tr class="memdesc:a3181bb7619bd560a3a2c21ece3213ce0"><td class="mdescLeft"> </td><td class="mdescRight">Type of smoothing to use with the Language Model Weighting scheme. <a href="classXapian_1_1Weight.html#a3181bb7619bd560a3a2c21ece3213ce0">More...</a><br /></td></tr> |
| 111 |
<tr class="inherit_header pro_types_classXapian_1_1Weight"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_types_classXapian_1_1Weight')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Protected Types inherited from <a class="el" href="classXapian_1_1Weight.html">Xapian::Weight</a></td></tr> |
| 112 |
<tr class="memitem:ae3c11f1d2d96a18e0eb9b9b31c5c5479 inherit pro_types_classXapian_1_1Weight" id="r_ae3c11f1d2d96a18e0eb9b9b31c5c5479"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479">stat_flags</a> { <br /> |
| 113 |
  <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479abce4fe48f6f680644bd352acc937856e">COLLECTION_SIZE</a> = 1 |
| 114 |
, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479a632727fa617eec2dfa9ad19e6adcb926">RSET_SIZE</a> = 2 |
| 115 |
, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479a5ce8ff7822abec06e0f5ac956d7b247e">AVERAGE_LENGTH</a> = 4 |
| 116 |
, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479ab2b087be2c0ffd8a2ea214298156f99b">TERMFREQ</a> = 8 |
| 117 |
, <br /> |
| 118 |
  <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479afd0979b74a0cf07991edc4af31ed55be">RELTERMFREQ</a> = 16 |
| 119 |
, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479a1a95530f6aa2ca909e4c1620aed8192b">QUERY_LENGTH</a> = 32 |
| 120 |
, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479ab383711f122cf1927e418dc94e8ed1a7">WQF</a> = 64 |
| 121 |
, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479afe84a106f8ec14c79acdfc29d9378aa2">WDF</a> = 128 |
| 122 |
, <br /> |
| 123 |
  <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479a92ac55fbe32f39c3b4cdcab135ac0722">DOC_LENGTH</a> = 256 |
| 124 |
, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479ac9f88f7ca707347bcce2c1ad0abdf531">DOC_LENGTH_MIN</a> = 512 |
| 125 |
, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479a8f07b317ab1fca84d17cab78aa412e37">DOC_LENGTH_MAX</a> = 1024 |
| 126 |
, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479abe608cc5dc83deef0f35c13a69aa15dc">WDF_MAX</a> = 2048 |
| 127 |
, <br /> |
| 128 |
  <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479ad923b48160007ce82f9db96f4f44c700">COLLECTION_FREQ</a> = 4096 |
| 129 |
, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479a429d945066f46ee1449e1be35f897bf2">UNIQUE_TERMS</a> = 8192 |
| 130 |
, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479a5c50665a837865406b7aff847d0a07d7">TOTAL_LENGTH</a> = COLLECTION_SIZE | AVERAGE_LENGTH |
| 131 |
<br /> |
| 132 |
}</td></tr> |
| 133 |
<tr class="memdesc:ae3c11f1d2d96a18e0eb9b9b31c5c5479"><td class="mdescLeft"> </td><td class="mdescRight">Stats which the weighting scheme can use (see <em class="arg"><a class="el" href="classXapian_1_1Weight.html#a77b1424d5f5a5b2d4848175979da6475" title="Tell Xapian that your subclass will want a particular statistic.">need_stat()</a></em>). <a href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479">More...</a><br /></td></tr> |
| 134 |
<tr class="inherit_header pro_methods_classXapian_1_1Weight"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_classXapian_1_1Weight')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Protected Member Functions inherited from <a class="el" href="classXapian_1_1Weight.html">Xapian::Weight</a></td></tr> |
| 135 |
<tr class="memitem:a77b1424d5f5a5b2d4848175979da6475 inherit pro_methods_classXapian_1_1Weight" id="r_a77b1424d5f5a5b2d4848175979da6475"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#a77b1424d5f5a5b2d4848175979da6475">need_stat</a> (<a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479">stat_flags</a> flag)</td></tr> |
| 136 |
<tr class="memdesc:a77b1424d5f5a5b2d4848175979da6475 inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">Tell <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> that your subclass will want a particular statistic. <br /></td></tr> |
| 137 |
<tr class="memitem:aa7acc105949dcb3b8b343a598dd01487 inherit pro_methods_classXapian_1_1Weight" id="r_aa7acc105949dcb3b8b343a598dd01487"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#aa7acc105949dcb3b8b343a598dd01487">Weight</a> (const Weight &)</td></tr> |
| 138 |
<tr class="memdesc:aa7acc105949dcb3b8b343a598dd01487 inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">Don't allow copying. <br /></td></tr> |
| 139 |
<tr class="memitem:aa0c27dd474ebbf95c8b3247c2a49686f inherit pro_methods_classXapian_1_1Weight" id="r_aa0c27dd474ebbf95c8b3247c2a49686f"><td class="memItemLeft" align="right" valign="top"> |
| 140 |
<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><b>get_collection_size</b> () const</td></tr> |
| 141 |
<tr class="memdesc:aa0c27dd474ebbf95c8b3247c2a49686f inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">The number of documents in the collection. <br /></td></tr> |
| 142 |
<tr class="memitem:a7d32c6eb63d262e27c8e06b6254dc2ae inherit pro_methods_classXapian_1_1Weight" id="r_a7d32c6eb63d262e27c8e06b6254dc2ae"><td class="memItemLeft" align="right" valign="top"> |
| 143 |
<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><b>get_rset_size</b> () const</td></tr> |
| 144 |
<tr class="memdesc:a7d32c6eb63d262e27c8e06b6254dc2ae inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">The number of documents marked as relevant. <br /></td></tr> |
| 145 |
<tr class="memitem:aac08743bb731357a46f58bc1c9dd8739 inherit pro_methods_classXapian_1_1Weight" id="r_aac08743bb731357a46f58bc1c9dd8739"><td class="memItemLeft" align="right" valign="top"> |
| 146 |
<a class="el" href="namespaceXapian.html#a63b13d3a36fcab9975658e32643d86b5">Xapian::doclength</a> </td><td class="memItemRight" valign="bottom"><b>get_average_length</b> () const</td></tr> |
| 147 |
<tr class="memdesc:aac08743bb731357a46f58bc1c9dd8739 inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">The average length of a document in the collection. <br /></td></tr> |
| 148 |
<tr class="memitem:a4e8361381e8111e5c0936bef91637d20 inherit pro_methods_classXapian_1_1Weight" id="r_a4e8361381e8111e5c0936bef91637d20"><td class="memItemLeft" align="right" valign="top"> |
| 149 |
<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><b>get_termfreq</b> () const</td></tr> |
| 150 |
<tr class="memdesc:a4e8361381e8111e5c0936bef91637d20 inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">The number of documents which this term indexes. <br /></td></tr> |
| 151 |
<tr class="memitem:a31d2eb808f1d13419c5148b334cdb702 inherit pro_methods_classXapian_1_1Weight" id="r_a31d2eb808f1d13419c5148b334cdb702"><td class="memItemLeft" align="right" valign="top"> |
| 152 |
<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><b>get_reltermfreq</b> () const</td></tr> |
| 153 |
<tr class="memdesc:a31d2eb808f1d13419c5148b334cdb702 inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">The number of relevant documents which this term indexes. <br /></td></tr> |
| 154 |
<tr class="memitem:a8b889fbca34923d6077b3d8e39d08cc9 inherit pro_methods_classXapian_1_1Weight" id="r_a8b889fbca34923d6077b3d8e39d08cc9"><td class="memItemLeft" align="right" valign="top"> |
| 155 |
<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><b>get_collection_freq</b> () const</td></tr> |
| 156 |
<tr class="memdesc:a8b889fbca34923d6077b3d8e39d08cc9 inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">The collection frequency of the term. <br /></td></tr> |
| 157 |
<tr class="memitem:a0b1a15b14be112f56d1fea7557b39484 inherit pro_methods_classXapian_1_1Weight" id="r_a0b1a15b14be112f56d1fea7557b39484"><td class="memItemLeft" align="right" valign="top"> |
| 158 |
<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><b>get_query_length</b> () const</td></tr> |
| 159 |
<tr class="memdesc:a0b1a15b14be112f56d1fea7557b39484 inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">The length of the query. <br /></td></tr> |
| 160 |
<tr class="memitem:a88dd563e37f13c30075159ad58682f88 inherit pro_methods_classXapian_1_1Weight" id="r_a88dd563e37f13c30075159ad58682f88"><td class="memItemLeft" align="right" valign="top"> |
| 161 |
<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><b>get_wqf</b> () const</td></tr> |
| 162 |
<tr class="memdesc:a88dd563e37f13c30075159ad58682f88 inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">The within-query-frequency of this term. <br /></td></tr> |
| 163 |
<tr class="memitem:ad26c71f5932cf020463a6566df03baa9 inherit pro_methods_classXapian_1_1Weight" id="r_ad26c71f5932cf020463a6566df03baa9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#ad26c71f5932cf020463a6566df03baa9">get_doclength_upper_bound</a> () const</td></tr> |
| 164 |
<tr class="memdesc:ad26c71f5932cf020463a6566df03baa9 inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">An upper bound on the maximum length of any document in the shard. <br /></td></tr> |
| 165 |
<tr class="memitem:a206b260ee9e90ebc5cc8de6f8fd6e2c5 inherit pro_methods_classXapian_1_1Weight" id="r_a206b260ee9e90ebc5cc8de6f8fd6e2c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#a206b260ee9e90ebc5cc8de6f8fd6e2c5">get_doclength_lower_bound</a> () const</td></tr> |
| 166 |
<tr class="memdesc:a206b260ee9e90ebc5cc8de6f8fd6e2c5 inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">A lower bound on the minimum length of any document in the shard. <br /></td></tr> |
| 167 |
<tr class="memitem:aff00a44dc04eae5864de75f319889433 inherit pro_methods_classXapian_1_1Weight" id="r_aff00a44dc04eae5864de75f319889433"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html#aff00a44dc04eae5864de75f319889433">get_wdf_upper_bound</a> () const</td></tr> |
| 168 |
<tr class="memdesc:aff00a44dc04eae5864de75f319889433 inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">An upper bound on the wdf of this term in the shard. <br /></td></tr> |
| 169 |
<tr class="memitem:a5e532ba58b2617e23f440a4a168a67a9 inherit pro_methods_classXapian_1_1Weight" id="r_a5e532ba58b2617e23f440a4a168a67a9"><td class="memItemLeft" align="right" valign="top"> |
| 170 |
<a class="el" href="namespaceXapian.html#ae3e1d1dd5c1307181b0bad1a689a5872">Xapian::totallength</a> </td><td class="memItemRight" valign="bottom"><b>get_total_length</b> () const</td></tr> |
| 171 |
<tr class="memdesc:a5e532ba58b2617e23f440a4a168a67a9 inherit pro_methods_classXapian_1_1Weight"><td class="mdescLeft"> </td><td class="mdescRight">Total length of all documents in the collection. <br /></td></tr> |
| 172 |
</table> |
| 173 |
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> |
| 174 |
<div class="textblock"><p><a class="el" href="classXapian_1_1Weight.html" title="Abstract base class for weighting schemes.">Xapian::Weight</a> subclass implementing the PL2+ probabilistic formula. </p> |
| 175 |
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor & Destructor Documentation</h2> |
| 176 |
<a id="a7a72ac48020341a691d5e8da5fe8a10c" name="a7a72ac48020341a691d5e8da5fe8a10c"></a> |
| 177 |
<h2 class="memtitle"><span class="permalink"><a href="#a7a72ac48020341a691d5e8da5fe8a10c">◆ </a></span>PL2PlusWeight()</h2> |
| 178 |
|
| 179 |
<div class="memitem"> |
| 180 |
<div class="memproto"> |
| 181 |
<table class="memname"> |
| 182 |
<tr> |
| 183 |
<td class="memname">Xapian::PL2PlusWeight::PL2PlusWeight </td> |
| 184 |
<td>(</td> |
| 185 |
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>c</em></span>, </td> |
| 186 |
</tr> |
| 187 |
<tr> |
| 188 |
<td class="paramkey"></td> |
| 189 |
<td></td> |
| 190 |
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>delta</em></span> )</td> |
| 191 |
</tr> |
| 192 |
</table> |
| 193 |
</div><div class="memdoc"> |
| 194 |
|
| 195 |
<p>Construct a <a class="el" href="classXapian_1_1PL2PlusWeight.html" title="Xapian::Weight subclass implementing the PL2+ probabilistic formula.">PL2PlusWeight</a>. </p> |
| 196 |
<dl class="params"><dt>Parameters</dt><dd> |
| 197 |
<table class="params"> |
| 198 |
<tr><td class="paramname">c</td><td>A strictly positive parameter controlling the extent of the normalization of the wdf to the document length. The default value of 1 is suitable for longer queries but it may need to be changed for shorter queries. For more information, please refer to Gianni Amati's PHD thesis titled Probabilistic Models for Information Retrieval based on Divergence from Randomness.</td></tr> |
| 199 |
<tr><td class="paramname">delta</td><td>A parameter for pseudo tf value to control the scale of the tf lower bound. Delta(δ) should be a positive real number. It can be tuned for example from 0.1 to 1.5 in increments of 0.1 or so. Experiments have shown that PL2+ works effectively across collections with a fixed δ = 0.8 (default 0.8) </td></tr> |
| 200 |
</table> |
| 201 |
</dd> |
| 202 |
</dl> |
| 203 |
|
| 204 |
<p class="reference">References <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479a5ce8ff7822abec06e0f5ac956d7b247e">Xapian::Weight::AVERAGE_LENGTH</a>, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479ad923b48160007ce82f9db96f4f44c700">Xapian::Weight::COLLECTION_FREQ</a>, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479abce4fe48f6f680644bd352acc937856e">Xapian::Weight::COLLECTION_SIZE</a>, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479a92ac55fbe32f39c3b4cdcab135ac0722">Xapian::Weight::DOC_LENGTH</a>, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479a8f07b317ab1fca84d17cab78aa412e37">Xapian::Weight::DOC_LENGTH_MAX</a>, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479ac9f88f7ca707347bcce2c1ad0abdf531">Xapian::Weight::DOC_LENGTH_MIN</a>, <a class="el" href="classXapian_1_1Weight.html#a77b1424d5f5a5b2d4848175979da6475">Xapian::Weight::need_stat()</a>, <a class="el" href="#a7a72ac48020341a691d5e8da5fe8a10c">PL2PlusWeight()</a>, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479afe84a106f8ec14c79acdfc29d9378aa2">Xapian::Weight::WDF</a>, <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479abe608cc5dc83deef0f35c13a69aa15dc">Xapian::Weight::WDF_MAX</a>, and <a class="el" href="classXapian_1_1Weight.html#ae3c11f1d2d96a18e0eb9b9b31c5c5479ab383711f122cf1927e418dc94e8ed1a7">Xapian::Weight::WQF</a>.</p> |
| 205 |
|
| 206 |
<p class="reference">Referenced by <a class="el" href="#a7a72ac48020341a691d5e8da5fe8a10c">PL2PlusWeight()</a>, and <a class="el" href="#afa3b071e291a1a3e8052d83a6e935c0a">unserialise()</a>.</p> |
| 207 |
|
| 208 |
</div> |
| 209 |
</div> |
| 210 |
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2> |
| 211 |
<a id="abdac1ec6592ba025c3636410757f2747" name="abdac1ec6592ba025c3636410757f2747"></a> |
| 212 |
<h2 class="memtitle"><span class="permalink"><a href="#abdac1ec6592ba025c3636410757f2747">◆ </a></span>get_maxextra()</h2> |
| 213 |
|
| 214 |
<div class="memitem"> |
| 215 |
<div class="memproto"> |
| 216 |
<table class="mlabels"> |
| 217 |
<tr> |
| 218 |
<td class="mlabels-left"> |
| 219 |
<table class="memname"> |
| 220 |
<tr> |
| 221 |
<td class="memname">double Xapian::PL2PlusWeight::get_maxextra </td> |
| 222 |
<td>(</td> |
| 223 |
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| 224 |
<td> const</td> |
| 225 |
</tr> |
| 226 |
</table> |
| 227 |
</td> |
| 228 |
<td class="mlabels-right"> |
| 229 |
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td> |
| 230 |
</tr> |
| 231 |
</table> |
| 232 |
</div><div class="memdoc"> |
| 233 |
|
| 234 |
<p>Return an upper bound on what <a class="el" href="#aacd38b642ea498b44310c8ac8d4cb3cf" title="Calculate the term-independent weight component for a document.">get_sumextra()</a> can return for any document. </p> |
| 235 |
<p>This information is used by the matcher to perform various optimisations, so strive to make the bound as tight as possible. </p> |
| 236 |
|
| 237 |
<p>Implements <a class="el" href="classXapian_1_1Weight.html#a019d010275b6e8130a4c5c746fdf32a1">Xapian::Weight</a>.</p> |
| 238 |
|
| 239 |
</div> |
| 240 |
</div> |
| 241 |
<a id="a35409d11a6f882f12255ba335e9c4261" name="a35409d11a6f882f12255ba335e9c4261"></a> |
| 242 |
<h2 class="memtitle"><span class="permalink"><a href="#a35409d11a6f882f12255ba335e9c4261">◆ </a></span>get_maxpart()</h2> |
| 243 |
|
| 244 |
<div class="memitem"> |
| 245 |
<div class="memproto"> |
| 246 |
<table class="mlabels"> |
| 247 |
<tr> |
| 248 |
<td class="mlabels-left"> |
| 249 |
<table class="memname"> |
| 250 |
<tr> |
| 251 |
<td class="memname">double Xapian::PL2PlusWeight::get_maxpart </td> |
| 252 |
<td>(</td> |
| 253 |
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| 254 |
<td> const</td> |
| 255 |
</tr> |
| 256 |
</table> |
| 257 |
</td> |
| 258 |
<td class="mlabels-right"> |
| 259 |
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td> |
| 260 |
</tr> |
| 261 |
</table> |
| 262 |
</div><div class="memdoc"> |
| 263 |
|
| 264 |
<p>Return an upper bound on what <a class="el" href="#a9c26ec6866d3878d5f408bc9627799d8" title="Calculate the weight contribution for this object's term to a document.">get_sumpart()</a> can return for any document. </p> |
| 265 |
<p>This information is used by the matcher to perform various optimisations, so strive to make the bound as tight as possible. </p> |
| 266 |
|
| 267 |
<p>Implements <a class="el" href="classXapian_1_1Weight.html#a791cd50a4ab7f2c4f1d9786433033d79">Xapian::Weight</a>.</p> |
| 268 |
|
| 269 |
</div> |
| 270 |
</div> |
| 271 |
<a id="aacd38b642ea498b44310c8ac8d4cb3cf" name="aacd38b642ea498b44310c8ac8d4cb3cf"></a> |
| 272 |
<h2 class="memtitle"><span class="permalink"><a href="#aacd38b642ea498b44310c8ac8d4cb3cf">◆ </a></span>get_sumextra()</h2> |
| 273 |
|
| 274 |
<div class="memitem"> |
| 275 |
<div class="memproto"> |
| 276 |
<table class="mlabels"> |
| 277 |
<tr> |
| 278 |
<td class="mlabels-left"> |
| 279 |
<table class="memname"> |
| 280 |
<tr> |
| 281 |
<td class="memname">double Xapian::PL2PlusWeight::get_sumextra </td> |
| 282 |
<td>(</td> |
| 283 |
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a></td> <td class="paramname"><span class="paramname"><em>doclen</em></span>, </td> |
| 284 |
</tr> |
| 285 |
<tr> |
| 286 |
<td class="paramkey"></td> |
| 287 |
<td></td> |
| 288 |
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a></td> <td class="paramname"><span class="paramname"><em>uniqterms</em></span> ) const</td> |
| 289 |
</tr> |
| 290 |
</table> |
| 291 |
</td> |
| 292 |
<td class="mlabels-right"> |
| 293 |
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td> |
| 294 |
</tr> |
| 295 |
</table> |
| 296 |
</div><div class="memdoc"> |
| 297 |
|
| 298 |
<p>Calculate the term-independent weight component for a document. </p> |
| 299 |
<p>The parameter gives information about the document which may be used in the calculations:</p> |
| 300 |
<dl class="params"><dt>Parameters</dt><dd> |
| 301 |
<table class="params"> |
| 302 |
<tr><td class="paramname">doclen</td><td>The document's length (unnormalised). </td></tr> |
| 303 |
<tr><td class="paramname">uniqterms</td><td>The number of unique terms in the document. </td></tr> |
| 304 |
</table> |
| 305 |
</dd> |
| 306 |
</dl> |
| 307 |
|
| 308 |
<p>Implements <a class="el" href="classXapian_1_1Weight.html#a77d87bf5be452399b7c9f72f3b41e5c0">Xapian::Weight</a>.</p> |
| 309 |
|
| 310 |
</div> |
| 311 |
</div> |
| 312 |
<a id="a9c26ec6866d3878d5f408bc9627799d8" name="a9c26ec6866d3878d5f408bc9627799d8"></a> |
| 313 |
<h2 class="memtitle"><span class="permalink"><a href="#a9c26ec6866d3878d5f408bc9627799d8">◆ </a></span>get_sumpart()</h2> |
| 314 |
|
| 315 |
<div class="memitem"> |
| 316 |
<div class="memproto"> |
| 317 |
<table class="mlabels"> |
| 318 |
<tr> |
| 319 |
<td class="mlabels-left"> |
| 320 |
<table class="memname"> |
| 321 |
<tr> |
| 322 |
<td class="memname">double Xapian::PL2PlusWeight::get_sumpart </td> |
| 323 |
<td>(</td> |
| 324 |
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a></td> <td class="paramname"><span class="paramname"><em>wdf</em></span>, </td> |
| 325 |
</tr> |
| 326 |
<tr> |
| 327 |
<td class="paramkey"></td> |
| 328 |
<td></td> |
| 329 |
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a></td> <td class="paramname"><span class="paramname"><em>doclen</em></span>, </td> |
| 330 |
</tr> |
| 331 |
<tr> |
| 332 |
<td class="paramkey"></td> |
| 333 |
<td></td> |
| 334 |
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a></td> <td class="paramname"><span class="paramname"><em>uniqterms</em></span> ) const</td> |
| 335 |
</tr> |
| 336 |
</table> |
| 337 |
</td> |
| 338 |
<td class="mlabels-right"> |
| 339 |
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td> |
| 340 |
</tr> |
| 341 |
</table> |
| 342 |
</div><div class="memdoc"> |
| 343 |
|
| 344 |
<p>Calculate the weight contribution for this object's term to a document. </p> |
| 345 |
<p>The parameters give information about the document which may be used in the calculations:</p> |
| 346 |
<dl class="params"><dt>Parameters</dt><dd> |
| 347 |
<table class="params"> |
| 348 |
<tr><td class="paramname">wdf</td><td>The within document frequency of the term in the document. </td></tr> |
| 349 |
<tr><td class="paramname">doclen</td><td>The document's length (unnormalised). </td></tr> |
| 350 |
<tr><td class="paramname">uniqterms</td><td>Number of unique terms in the document (used for absolute smoothing). </td></tr> |
| 351 |
</table> |
| 352 |
</dd> |
| 353 |
</dl> |
| 354 |
|
| 355 |
<p>Implements <a class="el" href="classXapian_1_1Weight.html#a6b60672542f4252fd000641a359107a1">Xapian::Weight</a>.</p> |
| 356 |
|
| 357 |
</div> |
| 358 |
</div> |
| 359 |
<a id="ac86eb422d8b88370f1bb1be811d5819b" name="ac86eb422d8b88370f1bb1be811d5819b"></a> |
| 360 |
<h2 class="memtitle"><span class="permalink"><a href="#ac86eb422d8b88370f1bb1be811d5819b">◆ </a></span>name()</h2> |
| 361 |
|
| 362 |
<div class="memitem"> |
| 363 |
<div class="memproto"> |
| 364 |
<table class="mlabels"> |
| 365 |
<tr> |
| 366 |
<td class="mlabels-left"> |
| 367 |
<table class="memname"> |
| 368 |
<tr> |
| 369 |
<td class="memname">std::string Xapian::PL2PlusWeight::name </td> |
| 370 |
<td>(</td> |
| 371 |
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| 372 |
<td> const</td> |
| 373 |
</tr> |
| 374 |
</table> |
| 375 |
</td> |
| 376 |
<td class="mlabels-right"> |
| 377 |
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td> |
| 378 |
</tr> |
| 379 |
</table> |
| 380 |
</div><div class="memdoc"> |
| 381 |
|
| 382 |
<p>Return the name of this weighting scheme. </p> |
| 383 |
<p>This name is used by the remote backend. It is passed along with the serialised parameters to the remote server so that it knows which class to create.</p> |
| 384 |
<p>Return the full namespace-qualified name of your class here - if your class is called FooWeight, return "FooWeight" from this method (<a class="el" href="classXapian_1_1BM25Weight.html" title="Xapian::Weight subclass implementing the BM25 probabilistic formula.">Xapian::BM25Weight</a> returns "Xapian::BM25Weight" here).</p> |
| 385 |
<p>If you don't want to support the remote backend, you can use the default implementation which simply returns an empty string. </p> |
| 386 |
|
| 387 |
<p>Reimplemented from <a class="el" href="classXapian_1_1Weight.html#a6106970d1a1e9600c9b32cc6ec96bf6b">Xapian::Weight</a>.</p> |
| 388 |
|
| 389 |
</div> |
| 390 |
</div> |
| 391 |
<a id="ad898cc39b2e53afde6eacf229cfaa707" name="ad898cc39b2e53afde6eacf229cfaa707"></a> |
| 392 |
<h2 class="memtitle"><span class="permalink"><a href="#ad898cc39b2e53afde6eacf229cfaa707">◆ </a></span>serialise()</h2> |
| 393 |
|
| 394 |
<div class="memitem"> |
| 395 |
<div class="memproto"> |
| 396 |
<table class="mlabels"> |
| 397 |
<tr> |
| 398 |
<td class="mlabels-left"> |
| 399 |
<table class="memname"> |
| 400 |
<tr> |
| 401 |
<td class="memname">std::string Xapian::PL2PlusWeight::serialise </td> |
| 402 |
<td>(</td> |
| 403 |
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| 404 |
<td> const</td> |
| 405 |
</tr> |
| 406 |
</table> |
| 407 |
</td> |
| 408 |
<td class="mlabels-right"> |
| 409 |
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td> |
| 410 |
</tr> |
| 411 |
</table> |
| 412 |
</div><div class="memdoc"> |
| 413 |
|
| 414 |
<p>Return this object's parameters serialised as a single string. </p> |
| 415 |
<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> |
| 416 |
|
| 417 |
<p>Reimplemented from <a class="el" href="classXapian_1_1Weight.html#a5162368a30a0fc10d69359665b5d8e0e">Xapian::Weight</a>.</p> |
| 418 |
|
| 419 |
</div> |
| 420 |
</div> |
| 421 |
<a id="afa3b071e291a1a3e8052d83a6e935c0a" name="afa3b071e291a1a3e8052d83a6e935c0a"></a> |
| 422 |
<h2 class="memtitle"><span class="permalink"><a href="#afa3b071e291a1a3e8052d83a6e935c0a">◆ </a></span>unserialise()</h2> |
| 423 |
|
| 424 |
<div class="memitem"> |
| 425 |
<div class="memproto"> |
| 426 |
<table class="mlabels"> |
| 427 |
<tr> |
| 428 |
<td class="mlabels-left"> |
| 429 |
<table class="memname"> |
| 430 |
<tr> |
| 431 |
<td class="memname"><a class="el" href="#a7a72ac48020341a691d5e8da5fe8a10c">PL2PlusWeight</a> * Xapian::PL2PlusWeight::unserialise </td> |
| 432 |
<td>(</td> |
| 433 |
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>serialised</em></span></td><td>)</td> |
| 434 |
<td> const</td> |
| 435 |
</tr> |
| 436 |
</table> |
| 437 |
</td> |
| 438 |
<td class="mlabels-right"> |
| 439 |
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td> |
| 440 |
</tr> |
| 441 |
</table> |
| 442 |
</div><div class="memdoc"> |
| 443 |
|
| 444 |
<p>Unserialise parameters. </p> |
| 445 |
<p>This method unserialises parameters serialised by the <em class="arg"><a class="el" href="#ad898cc39b2e53afde6eacf229cfaa707" title="Return this object's parameters serialised as a single string.">serialise()</a></em> method and allocates and returns a new object initialised with them.</p> |
| 446 |
<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> |
| 447 |
<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="https://trac.xapian.org/ticket/554#comment:1">https://trac.xapian.org/ticket/554#comment:1</a></p> |
| 448 |
<dl class="params"><dt>Parameters</dt><dd> |
| 449 |
<table class="params"> |
| 450 |
<tr><td class="paramname">serialised</td><td>A string containing the serialised parameters. </td></tr> |
| 451 |
</table> |
| 452 |
</dd> |
| 453 |
</dl> |
| 454 |
|
| 455 |
<p>Reimplemented from <a class="el" href="classXapian_1_1Weight.html#a023bfd724c7ee58666710e0d28639e41">Xapian::Weight</a>.</p> |
| 456 |
|
| 457 |
<p class="reference">References <a class="el" href="#a7a72ac48020341a691d5e8da5fe8a10c">PL2PlusWeight()</a>.</p> |
| 458 |
|
| 459 |
</div> |
| 460 |
</div> |
| 461 |
<hr/>The documentation for this class was generated from the following file:<ul> |
| 462 |
<li>xapian/<a class="el" href="weight_8h.html">weight.h</a></li> |
| 463 |
</ul> |
| 464 |
</div><!-- contents --> |
| 465 |
<!-- start footer part --> |
| 466 |
<hr class="footer"/><address class="footer"><small> |
| 467 |
Generated by <a href="https://www.doxygen.org/">Doxygen 1.15.0</a> |
| 468 |
</small></address> |
| 469 |
</body> |
| 470 |
</html> |