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 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
|
<!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.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: xapian Directory 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
 <span id="projectnumber">1.4.22</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<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&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="dir_f63502d618711192f85ccb772536c6ae.html">xapian</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">xapian Directory Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="files" name="files"></a>
Files</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="compactor_8h.html">compactor.h</a></td></tr>
<tr class="memdesc:compactor_8h"><td class="mdescLeft"> </td><td class="mdescRight">Compact a database, or merge and compact several. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="constants_8h.html">constants.h</a></td></tr>
<tr class="memdesc:constants_8h"><td class="mdescLeft"> </td><td class="mdescRight">Constants in the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> namespace. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="constinfo_8h.html">constinfo.h</a></td></tr>
<tr class="memdesc:constinfo_8h"><td class="mdescLeft"> </td><td class="mdescRight">Mechanism for accessing a struct of constant information. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="database_8h.html">database.h</a></td></tr>
<tr class="memdesc:database_8h"><td class="mdescLeft"> </td><td class="mdescRight">API for working with <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> databases. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="dbfactory_8h.html">dbfactory.h</a></td></tr>
<tr class="memdesc:dbfactory_8h"><td class="mdescLeft"> </td><td class="mdescRight">Factory functions for constructing Database and WritableDatabase objects. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="document_8h.html">document.h</a></td></tr>
<tr class="memdesc:document_8h"><td class="mdescLeft"> </td><td class="mdescRight">API for working with documents. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="enquire_8h.html">enquire.h</a></td></tr>
<tr class="memdesc:enquire_8h"><td class="mdescLeft"> </td><td class="mdescRight">API for running queries. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html">error.h</a></td></tr>
<tr class="memdesc:error_8h"><td class="mdescLeft"> </td><td class="mdescRight">Hierarchy of classes which <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> can throw as exceptions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="errorhandler_8h.html">errorhandler.h</a></td></tr>
<tr class="memdesc:errorhandler_8h"><td class="mdescLeft"> </td><td class="mdescRight">Decide if a <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a> exception should be ignored. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="eset_8h.html">eset.h</a></td></tr>
<tr class="memdesc:eset_8h"><td class="mdescLeft"> </td><td class="mdescRight">Class representing a list of query expansion terms. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="expanddecider_8h.html">expanddecider.h</a></td></tr>
<tr class="memdesc:expanddecider_8h"><td class="mdescLeft"> </td><td class="mdescRight">Allow rejection of terms during ESet generation. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="geospatial_8h.html">geospatial.h</a></td></tr>
<tr class="memdesc:geospatial_8h"><td class="mdescLeft"> </td><td class="mdescRight">Geospatial search support routines. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="keymaker_8h.html">keymaker.h</a></td></tr>
<tr class="memdesc:keymaker_8h"><td class="mdescLeft"> </td><td class="mdescRight">Build key strings for MSet ordering or collapsing. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="matchspy_8h.html">matchspy.h</a></td></tr>
<tr class="memdesc:matchspy_8h"><td class="mdescLeft"> </td><td class="mdescRight">MatchSpy implementation. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="mset_8h.html">mset.h</a></td></tr>
<tr class="memdesc:mset_8h"><td class="mdescLeft"> </td><td class="mdescRight">Class representing a list of search results. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="positioniterator_8h.html">positioniterator.h</a></td></tr>
<tr class="memdesc:positioniterator_8h"><td class="mdescLeft"> </td><td class="mdescRight">Class for iterating over term positions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="postingiterator_8h.html">postingiterator.h</a></td></tr>
<tr class="memdesc:postingiterator_8h"><td class="mdescLeft"> </td><td class="mdescRight">Class for iterating over a list of document ids. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="postingsource_8h.html">postingsource.h</a></td></tr>
<tr class="memdesc:postingsource_8h"><td class="mdescLeft"> </td><td class="mdescRight">External sources of posting information. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="query_8h.html">query.h</a></td></tr>
<tr class="memdesc:query_8h"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Query.html" title="Class representing a query.">Xapian::Query</a> API class. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="queryparser_8h.html">queryparser.h</a></td></tr>
<tr class="memdesc:queryparser_8h"><td class="mdescLeft"> </td><td class="mdescRight">parsing a user query string to build a <a class="el" href="classXapian_1_1Query.html" title="Class representing a query.">Xapian::Query</a> object <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="registry_8h.html">registry.h</a></td></tr>
<tr class="memdesc:registry_8h"><td class="mdescLeft"> </td><td class="mdescRight">Class for looking up user subclasses during unserialisation. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="stem_8h.html">stem.h</a></td></tr>
<tr class="memdesc:stem_8h"><td class="mdescLeft"> </td><td class="mdescRight">stemming algorithms <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="termgenerator_8h.html">termgenerator.h</a></td></tr>
<tr class="memdesc:termgenerator_8h"><td class="mdescLeft"> </td><td class="mdescRight">parse free text and generate terms <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="termiterator_8h.html">termiterator.h</a></td></tr>
<tr class="memdesc:termiterator_8h"><td class="mdescLeft"> </td><td class="mdescRight">Class for iterating over a list of terms. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="types_8h.html">types.h</a></td></tr>
<tr class="memdesc:types_8h"><td class="mdescLeft"> </td><td class="mdescRight">typedefs for <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8h.html">unicode.h</a></td></tr>
<tr class="memdesc:unicode_8h"><td class="mdescLeft"> </td><td class="mdescRight">Unicode and UTF-8 related classes and functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="valueiterator_8h.html">valueiterator.h</a></td></tr>
<tr class="memdesc:valueiterator_8h"><td class="mdescLeft"> </td><td class="mdescRight">Class for iterating over document values. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="valuesetmatchdecider_8h.html">valuesetmatchdecider.h</a></td></tr>
<tr class="memdesc:valuesetmatchdecider_8h"><td class="mdescLeft"> </td><td class="mdescRight">MatchDecider subclass for filtering results by value. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html">version.h</a></td></tr>
<tr class="memdesc:version_8h"><td class="mdescLeft"> </td><td class="mdescRight">Define preprocessor symbols for the library version. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="weight_8h.html">weight.h</a></td></tr>
<tr class="memdesc:weight_8h"><td class="mdescLeft"> </td><td class="mdescRight">Weighting scheme API. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.4</a>
</small></address>
</body>
</html>
|