File: classXapian_1_1RSet.html

package info (click to toggle)
xapian-core 1.4.29-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 22,840 kB
  • sloc: cpp: 92,356; ansic: 9,948; sh: 5,026; perl: 850; makefile: 509; javascript: 360; tcl: 319; python: 40
file content (126 lines) | stat: -rw-r--r-- 11,524 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::RSet Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">xapian-core
   &#160;<span id="projectnumber">1.4.29</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="classXapian_1_1RSet.html">RSet</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classXapian_1_1RSet-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Xapian::RSet Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>A relevance set (R-Set).  
 <a href="classXapian_1_1RSet.html#details">More...</a></p>

<p><code>#include &lt;enquire.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a50ed96a2396032db1297bdb3bef3fbc5" id="r_a50ed96a2396032db1297bdb3bef3fbc5"><td class="memItemLeft" align="right" valign="top"><a id="a50ed96a2396032db1297bdb3bef3fbc5" name="a50ed96a2396032db1297bdb3bef3fbc5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>RSet</b> (const <a class="el" href="classXapian_1_1RSet.html">RSet</a> &amp;rset)</td></tr>
<tr class="memdesc:a50ed96a2396032db1297bdb3bef3fbc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:a50ed96a2396032db1297bdb3bef3fbc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a105bf6917dffc68fb551e775fd67202a" id="r_a105bf6917dffc68fb551e775fd67202a"><td class="memItemLeft" align="right" valign="top"><a id="a105bf6917dffc68fb551e775fd67202a" name="a105bf6917dffc68fb551e775fd67202a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classXapian_1_1RSet.html">RSet</a> &amp;rset)</td></tr>
<tr class="memdesc:a105bf6917dffc68fb551e775fd67202a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <br /></td></tr>
<tr class="separator:a105bf6917dffc68fb551e775fd67202a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a142298edba05bbdc1d1dd11fdbc88020" id="r_a142298edba05bbdc1d1dd11fdbc88020"><td class="memItemLeft" align="right" valign="top"><a id="a142298edba05bbdc1d1dd11fdbc88020" name="a142298edba05bbdc1d1dd11fdbc88020"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>RSet</b> ()</td></tr>
<tr class="memdesc:a142298edba05bbdc1d1dd11fdbc88020"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a142298edba05bbdc1d1dd11fdbc88020"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5571c4c3bbeeca8e051f36037c62b70f" id="r_a5571c4c3bbeeca8e051f36037c62b70f"><td class="memItemLeft" align="right" valign="top"><a id="a5571c4c3bbeeca8e051f36037c62b70f" name="a5571c4c3bbeeca8e051f36037c62b70f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>~RSet</b> ()</td></tr>
<tr class="memdesc:a5571c4c3bbeeca8e051f36037c62b70f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a5571c4c3bbeeca8e051f36037c62b70f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9435e73fe422eb74b5685eee34ae96ae" id="r_a9435e73fe422eb74b5685eee34ae96ae"><td class="memItemLeft" align="right" valign="top"><a id="a9435e73fe422eb74b5685eee34ae96ae" name="a9435e73fe422eb74b5685eee34ae96ae"></a>
<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a>&#160;</td><td class="memItemRight" valign="bottom"><b>size</b> () const</td></tr>
<tr class="memdesc:a9435e73fe422eb74b5685eee34ae96ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of documents in this R-Set. <br /></td></tr>
<tr class="separator:a9435e73fe422eb74b5685eee34ae96ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1cbe5df7e50776a47a6fb90ebc0092f" id="r_ab1cbe5df7e50776a47a6fb90ebc0092f"><td class="memItemLeft" align="right" valign="top"><a id="ab1cbe5df7e50776a47a6fb90ebc0092f" name="ab1cbe5df7e50776a47a6fb90ebc0092f"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>empty</b> () const</td></tr>
<tr class="memdesc:ab1cbe5df7e50776a47a6fb90ebc0092f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if this R-Set is empty. <br /></td></tr>
<tr class="separator:ab1cbe5df7e50776a47a6fb90ebc0092f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4eec40ff21b85b939ebab9a710df747f" id="r_a4eec40ff21b85b939ebab9a710df747f"><td class="memItemLeft" align="right" valign="top"><a id="a4eec40ff21b85b939ebab9a710df747f" name="a4eec40ff21b85b939ebab9a710df747f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>add_document</b> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did)</td></tr>
<tr class="memdesc:a4eec40ff21b85b939ebab9a710df747f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a document to the relevance set. <br /></td></tr>
<tr class="separator:a4eec40ff21b85b939ebab9a710df747f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadc23b11f6ca60415a3fa595325af5eb" id="r_aadc23b11f6ca60415a3fa595325af5eb"><td class="memItemLeft" align="right" valign="top"><a id="aadc23b11f6ca60415a3fa595325af5eb" name="aadc23b11f6ca60415a3fa595325af5eb"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>add_document</b> (const <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSetIterator</a> &amp;i)</td></tr>
<tr class="memdesc:aadc23b11f6ca60415a3fa595325af5eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a document to the relevance set. <br /></td></tr>
<tr class="separator:aadc23b11f6ca60415a3fa595325af5eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58ae59e71967d119296231c6ac905dbb" id="r_a58ae59e71967d119296231c6ac905dbb"><td class="memItemLeft" align="right" valign="top"><a id="a58ae59e71967d119296231c6ac905dbb" name="a58ae59e71967d119296231c6ac905dbb"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>remove_document</b> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did)</td></tr>
<tr class="memdesc:a58ae59e71967d119296231c6ac905dbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a document from the relevance set. <br /></td></tr>
<tr class="separator:a58ae59e71967d119296231c6ac905dbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a459ec695ed5ab2e10b56aa56c2e453be" id="r_a459ec695ed5ab2e10b56aa56c2e453be"><td class="memItemLeft" align="right" valign="top"><a id="a459ec695ed5ab2e10b56aa56c2e453be" name="a459ec695ed5ab2e10b56aa56c2e453be"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>remove_document</b> (const <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSetIterator</a> &amp;i)</td></tr>
<tr class="memdesc:a459ec695ed5ab2e10b56aa56c2e453be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a document from the relevance set. <br /></td></tr>
<tr class="separator:a459ec695ed5ab2e10b56aa56c2e453be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf1e62006615efffadd12031470be66d" id="r_aaf1e62006615efffadd12031470be66d"><td class="memItemLeft" align="right" valign="top"><a id="aaf1e62006615efffadd12031470be66d" name="aaf1e62006615efffadd12031470be66d"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>contains</b> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did) const</td></tr>
<tr class="memdesc:aaf1e62006615efffadd12031470be66d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if a given document in the relevance set. <br /></td></tr>
<tr class="separator:aaf1e62006615efffadd12031470be66d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a861dfca0ea7130aff77d8d75187a3a2f" id="r_a861dfca0ea7130aff77d8d75187a3a2f"><td class="memItemLeft" align="right" valign="top"><a id="a861dfca0ea7130aff77d8d75187a3a2f" name="a861dfca0ea7130aff77d8d75187a3a2f"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>contains</b> (const <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSetIterator</a> &amp;i) const</td></tr>
<tr class="memdesc:a861dfca0ea7130aff77d8d75187a3a2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if a given document in the relevance set. <br /></td></tr>
<tr class="separator:a861dfca0ea7130aff77d8d75187a3a2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a206d9ec588a791d3715f250d8350af68" id="r_a206d9ec588a791d3715f250d8350af68"><td class="memItemLeft" align="right" valign="top"><a id="a206d9ec588a791d3715f250d8350af68" name="a206d9ec588a791d3715f250d8350af68"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>get_description</b> () const</td></tr>
<tr class="memdesc:a206d9ec588a791d3715f250d8350af68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:a206d9ec588a791d3715f250d8350af68"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A relevance set (R-Set). </p>
<p>This is the set of documents which are marked as relevant, for use in modifying the term weights, and in performing query expansion. </p>
</div><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></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.8</a>
</small></address>
</body>
</html>