<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian Namespace Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.5.9 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
var num=this.id.replace(/[^[0-9]/g,'');
var button=this.firstChild;
var sectionDiv=document.getElementById('dynsection'+num);
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
sectionDiv.style.display='block';
button.src='open.gif';
}else{
sectionDiv.style.display='none';
button.src='closed.gif';
}
}
function initDynSections(){
var divs=document.getElementsByTagName('div');
var sectionCounter=1;
for(var i=0;i<divs.length-1;i++){
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
var header=divs[i];
var section=divs[i+1];
var button=header.firstChild;
if (button!='IMG'){
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
button=document.createElement('img');
divs[i].insertBefore(button,divs[i].firstChild);
}
header.style.cursor='pointer';
header.onclick=changeDisplayState;
header.id='dynheader'+sectionCounter;
button.src='closed.gif';
section.id='dynsection'+sectionCounter;
section.style.display='none';
section.style.marginLeft='14px';
sectionCounter++;
}
}
}
window.onload = initDynSections;
-->
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="namespaces.html"><span>Namespace List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Xapian Namespace Reference</h1>The <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> namespace contains public interfaces for the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> library.
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Auto.html">Auto</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> factory functions which determine the database type automatically. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Brass.html">Brass</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> factory functions for the brass backend. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Chert.html">Chert</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> factory functions for the chert backend. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Flint.html">Flint</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> factory functions for the flint backend. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1InMemory.html">InMemory</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> factory functions for the inmemory backend. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Remote.html">Remote</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> factory functions for the remote backend. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Unicode.html">Unicode</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Functions associated with handling <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> characters. <br></td></tr>
<p>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Error.html">Error</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">All exceptions thrown by <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> are subclasses of <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a>. <a href="classXapian_1_1Error.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LogicError.html">LogicError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The base class for exceptions indicating errors in the program logic. <a href="classXapian_1_1LogicError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RuntimeError.html">RuntimeError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The base class for exceptions indicating errors only detectable at runtime. <a href="classXapian_1_1RuntimeError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1AssertionError.html">AssertionError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1AssertionError.html" title="AssertionError is thrown if a logical assertion inside Xapian fails.">AssertionError</a> is thrown if a logical assertion inside <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> fails. <a href="classXapian_1_1AssertionError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1InvalidArgumentError.html">InvalidArgumentError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">InvalidArgumentError</a> indicates an invalid parameter value was passed to the API. <a href="classXapian_1_1InvalidArgumentError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1InvalidOperationError.html">InvalidOperationError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1InvalidOperationError.html" title="InvalidOperationError indicates the API was used in an invalid way.">InvalidOperationError</a> indicates the API was used in an invalid way. <a href="classXapian_1_1InvalidOperationError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1UnimplementedError.html">UnimplementedError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">UnimplementedError</a> indicates an attempt to use an unimplemented feature. <a href="classXapian_1_1UnimplementedError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DatabaseError.html">DatabaseError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1DatabaseError.html" title="DatabaseError indicates some sort of database related error.">DatabaseError</a> indicates some sort of database related error. <a href="classXapian_1_1DatabaseError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DatabaseCorruptError.html">DatabaseCorruptError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected.">DatabaseCorruptError</a> indicates database corruption was detected. <a href="classXapian_1_1DatabaseCorruptError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DatabaseCreateError.html">DatabaseCreateError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1DatabaseCreateError.html" title="DatabaseCreateError indicates a failure to create a database.">DatabaseCreateError</a> indicates a failure to create a database. <a href="classXapian_1_1DatabaseCreateError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DatabaseLockError.html">DatabaseLockError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1DatabaseLockError.html" title="DatabaseLockError indicates failure to lock a database.">DatabaseLockError</a> indicates failure to lock a database. <a href="classXapian_1_1DatabaseLockError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DatabaseModifiedError.html">DatabaseModifiedError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1DatabaseModifiedError.html" title="DatabaseModifiedError indicates a database was modified.">DatabaseModifiedError</a> indicates a database was modified. <a href="classXapian_1_1DatabaseModifiedError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DatabaseOpeningError.html">DatabaseOpeningError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1DatabaseOpeningError.html" title="DatabaseOpeningError indicates failure to open a database.">DatabaseOpeningError</a> indicates failure to open a database. <a href="classXapian_1_1DatabaseOpeningError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DatabaseVersionError.html">DatabaseVersionError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1DatabaseVersionError.html" title="DatabaseVersionError indicates that a database is in an unsupported format.">DatabaseVersionError</a> indicates that a database is in an unsupported format. <a href="classXapian_1_1DatabaseVersionError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DocNotFoundError.html">DocNotFoundError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates an attempt to access a document not present in the database. <a href="classXapian_1_1DocNotFoundError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1FeatureUnavailableError.html">FeatureUnavailableError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates an attempt to use a feature which is unavailable. <a href="classXapian_1_1FeatureUnavailableError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1InternalError.html">InternalError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1InternalError.html" title="InternalError indicates a runtime problem of some sort.">InternalError</a> indicates a runtime problem of some sort. <a href="classXapian_1_1InternalError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1NetworkError.html">NetworkError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates a problem communicating with a remote database. <a href="classXapian_1_1NetworkError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1NetworkTimeoutError.html">NetworkTimeoutError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates a timeout expired while communicating with a remote database. <a href="classXapian_1_1NetworkTimeoutError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1QueryParserError.html">QueryParserError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates a query string can't be parsed. <a href="classXapian_1_1QueryParserError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1SerialisationError.html">SerialisationError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates an error in the std::string serialisation of an object. <a href="classXapian_1_1SerialisationError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RangeError.html">RangeError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1RangeError.html" title="RangeError indicates an attempt to access outside the bounds of a container.">RangeError</a> indicates an attempt to access outside the bounds of a container. <a href="classXapian_1_1RangeError.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Compactor.html">Compactor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compact a database, or merge and compact several. <a href="classXapian_1_1Compactor.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html">Database</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This class is used to access a database, or a group of databases. <a href="classXapian_1_1Database.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This class provides read/write access to a database. <a href="classXapian_1_1WritableDatabase.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Document.html">Document</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A handle representing a document in a <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> database. <a href="classXapian_1_1Document.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html">MSet</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A match set (<a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>). <a href="classXapian_1_1MSet.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An iterator pointing to items in an <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="classXapian_1_1MSetIterator.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html">ESet</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class representing an ordered set of expand terms (an <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a>). <a href="classXapian_1_1ESet.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate through terms in the <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a>. <a href="classXapian_1_1ESetIterator.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html">RSet</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A relevance set (R-Set). <a href="classXapian_1_1RSet.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchDecider.html">MatchDecider</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base class for matcher decision functor. <a href="classXapian_1_1MatchDecider.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html">Enquire</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This class provides an interface to the information retrieval system for the purpose of searching. <a href="classXapian_1_1Enquire.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ErrorHandler.html">ErrorHandler</a></td></tr>
<tr><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. <a href="classXapian_1_1ErrorHandler.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ExpandDecider.html">ExpandDecider</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual base class for expand decider functor. <a href="classXapian_1_1ExpandDecider.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ExpandDeciderAnd.html">ExpandDeciderAnd</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1ExpandDecider.html" title="Virtual base class for expand decider functor.">ExpandDecider</a> subclass which rejects terms using two ExpandDeciders. <a href="classXapian_1_1ExpandDeciderAnd.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ExpandDeciderFilterTerms.html">ExpandDeciderFilterTerms</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1ExpandDecider.html" title="Virtual base class for expand decider functor.">ExpandDecider</a> subclass which rejects terms in a specified list. <a href="classXapian_1_1ExpandDeciderFilterTerms.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1KeyMaker.html">KeyMaker</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual base class for key making functors. <a href="classXapian_1_1KeyMaker.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MultiValueKeyMaker.html">MultiValueKeyMaker</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1KeyMaker.html" title="Virtual base class for key making functors.">KeyMaker</a> subclass which combines several values. <a href="classXapian_1_1MultiValueKeyMaker.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Sorter.html">Sorter</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual base class for sorter functor. <a href="classXapian_1_1Sorter.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MultiValueSorter.html">MultiValueSorter</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Sorter.html" title="Virtual base class for sorter functor.">Sorter</a> subclass which sorts by a several values. <a href="classXapian_1_1MultiValueSorter.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Abstract base class for match spies. <a href="classXapian_1_1MatchSpy.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueCountMatchSpy.html">ValueCountMatchSpy</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class for counting the frequencies of values in the matching documents. <a href="classXapian_1_1ValueCountMatchSpy.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An iterator pointing to items in a list of positions. <a href="classXapian_1_1PositionIterator.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An iterator pointing to items in a list of postings. <a href="classXapian_1_1PostingIterator.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html">PostingSource</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base class which provides an "external" source of postings. <a href="classXapian_1_1PostingSource.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html">ValuePostingSource</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A posting source which generates weights from a value slot. <a href="classXapian_1_1ValuePostingSource.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueWeightPostingSource.html">ValueWeightPostingSource</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A posting source which reads weights from a value slot. <a href="classXapian_1_1ValueWeightPostingSource.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DecreasingValueWeightPostingSource.html">DecreasingValueWeightPostingSource</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read weights from a value which is known to decrease as docid increases. <a href="classXapian_1_1DecreasingValueWeightPostingSource.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueMapPostingSource.html">ValueMapPostingSource</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A posting source which looks up weights in a map using values as the key. <a href="classXapian_1_1ValueMapPostingSource.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1FixedWeightPostingSource.html">FixedWeightPostingSource</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A posting source which returns a fixed weight for all documents. <a href="classXapian_1_1FixedWeightPostingSource.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Query.html">Query</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class representing a query. <a href="classXapian_1_1Query.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stopper.html">Stopper</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base class for stop-word decision functor. <a href="classXapian_1_1Stopper.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1SimpleStopper.html">SimpleStopper</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Simple implementation of <a class="el" href="classXapian_1_1Stopper.html" title="Base class for stop-word decision functor.">Stopper</a> class - this will suit most users. <a href="classXapian_1_1SimpleStopper.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structXapian_1_1ValueRangeProcessor.html">ValueRangeProcessor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base class for value range processors. <a href="structXapian_1_1ValueRangeProcessor.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1StringValueRangeProcessor.html">StringValueRangeProcessor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a string range. <a href="classXapian_1_1StringValueRangeProcessor.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DateValueRangeProcessor.html">DateValueRangeProcessor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a date range. <a href="classXapian_1_1DateValueRangeProcessor.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1NumberValueRangeProcessor.html">NumberValueRangeProcessor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a number range. <a href="classXapian_1_1NumberValueRangeProcessor.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1QueryParser.html">QueryParser</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Build a <a class="el" href="classXapian_1_1Query.html" title="Class representing a query.">Xapian::Query</a> object from a user query string. <a href="classXapian_1_1QueryParser.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Registry.html">Registry</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Registry.html" title="Registry for user subclasses.">Registry</a> for user subclasses. <a href="classXapian_1_1Registry.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structXapian_1_1StemImplementation.html">StemImplementation</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class representing a stemming algorithm implementation. <a href="structXapian_1_1StemImplementation.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html">Stem</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class representing a stemming algorithm. <a href="classXapian_1_1Stem.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a piece of text and generate terms. <a href="classXapian_1_1TermGenerator.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An iterator pointing to items in a list of terms. <a href="classXapian_1_1TermIterator.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html">Utf8Iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An iterator which returns <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character values from a UTF-8 encoded string. <a href="classXapian_1_1Utf8Iterator.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class for iterating over document values. <a href="classXapian_1_1ValueIterator.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueSetMatchDecider.html">ValueSetMatchDecider</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1MatchDecider.html" title="Base class for matcher decision functor.">MatchDecider</a> filtering results based on whether document values are in a user-defined set. <a href="classXapian_1_1ValueSetMatchDecider.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Weight.html">Weight</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Abstract base class for weighting schemes. <a href="classXapian_1_1Weight.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1BoolWeight.html">BoolWeight</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class implementing a "boolean" weighting scheme. <a href="classXapian_1_1BoolWeight.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1BM25Weight.html">BM25Weight</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Weight.html" title="Abstract base class for weighting schemes.">Xapian::Weight</a> subclass implementing the BM25 probabilistic formula. <a href="classXapian_1_1BM25Weight.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TradWeight.html">TradWeight</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Weight.html" title="Abstract base class for weighting schemes.">Xapian::Weight</a> subclass implementing the traditional probabilistic formula. <a href="classXapian_1_1TradWeight.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">doccount</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A count of documents. <a href="#7f30aa95f0c42b117dafaf66ba24241d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#958ff32fd7a85f2b8a4784ac18397f2b">doccount_diff</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A signed difference between two counts of documents. <a href="#958ff32fd7a85f2b8a4784ac18397f2b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">docid</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A unique identifier for a document. <a href="#8fa9094bebe1256a7be935a5ede87a64"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef double </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#63b13d3a36fcab9975658e32643d86b5">doclength</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A normalised document length. <a href="#63b13d3a36fcab9975658e32643d86b5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#22ea0a80c58a2047dd929621b75ed9a2">percent</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The percentage score for a document in an <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="#22ea0a80c58a2047dd929621b75ed9a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">termcount</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A counts of terms. <a href="#72b5a76dd8cfb7b251fe7986e86390cb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#886bd8fd46134d4b488091cfd8a658ed">termcount_diff</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A signed difference between two counts of terms. <a href="#886bd8fd46134d4b488091cfd8a658ed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e5a16f073d0c8ed54085a9de07248d45"></a><!-- doxytag: member="Xapian::termpos" ref="e5a16f073d0c8ed54085a9de07248d45" args="" -->
typedef unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#e5a16f073d0c8ed54085a9de07248d45">termpos</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A term position within a document or query. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#bc9d5170114fede39c85ee03086e373b">termpos_diff</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A signed difference between two term positions. <a href="#bc9d5170114fede39c85ee03086e373b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#da10bc23c3467246f078179fce2d762d">timeout</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A timeout value in milliseconds. <a href="#da10bc23c3467246f078179fce2d762d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#94a899651fa920c72ffa9635bde630ea">valueno</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number for a value slot in a document. <a href="#94a899651fa920c72ffa9635bde630ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#dd1b3ce8b08d23e4665b097f785c6a96">valueno_diff</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A signed difference between two value slot numbers. <a href="#dd1b3ce8b08d23e4665b097f785c6a96"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef double </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">weight</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The weight of a document or term. <a href="#cac12803afc9e24ee5141c119acb8884"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5d6ed5a88ec3d4471e45b1598691dab4"></a><!-- doxytag: member="Xapian::operator==" ref="5d6ed5a88ec3d4471e45b1598691dab4" args="(const MSetIterator &a, const MSetIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#5d6ed5a88ec3d4471e45b1598691dab4">operator==</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &a, const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality test for <a class="el" href="classXapian_1_1MSetIterator.html" title="An iterator pointing to items in an MSet.">MSetIterator</a> objects. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="245fbc9f00ff6dac8724c65926495585"></a><!-- doxytag: member="Xapian::operator!=" ref="245fbc9f00ff6dac8724c65926495585" args="(const MSetIterator &a, const MSetIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#245fbc9f00ff6dac8724c65926495585">operator!=</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &a, const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inequality test for <a class="el" href="classXapian_1_1MSetIterator.html" title="An iterator pointing to items in an MSet.">MSetIterator</a> objects. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bb14b86f144db20662592575911ca308"></a><!-- doxytag: member="Xapian::operator==" ref="bb14b86f144db20662592575911ca308" args="(const ESetIterator &a, const ESetIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#bb14b86f144db20662592575911ca308">operator==</a> (const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &a, const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality test for <a class="el" href="classXapian_1_1ESetIterator.html" title="Iterate through terms in the ESet.">ESetIterator</a> objects. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c2c2c0ec620503d10c024f076db2bde4"></a><!-- doxytag: member="Xapian::operator!=" ref="c2c2c0ec620503d10c024f076db2bde4" args="(const ESetIterator &a, const ESetIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#c2c2c0ec620503d10c024f076db2bde4">operator!=</a> (const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &a, const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inequality test for <a class="el" href="classXapian_1_1ESetIterator.html" title="Iterate through terms in the ESet.">ESetIterator</a> objects. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd6a36fe0327deef4f720416036d48cc"></a><!-- doxytag: member="Xapian::operator==" ref="cd6a36fe0327deef4f720416036d48cc" args="(const PositionIterator &a, const PositionIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#cd6a36fe0327deef4f720416036d48cc">operator==</a> (const <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> &a, const <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test equality of two PositionIterators. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="84bfb06d1ced43e6602f81c17d5e8e77"></a><!-- doxytag: member="Xapian::operator!=" ref="84bfb06d1ced43e6602f81c17d5e8e77" args="(const PositionIterator &a, const PositionIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#84bfb06d1ced43e6602f81c17d5e8e77">operator!=</a> (const <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> &a, const <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test inequality of two PositionIterators. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b36ad8f69a1e7884ee9a8c171df440f7"></a><!-- doxytag: member="Xapian::operator==" ref="b36ad8f69a1e7884ee9a8c171df440f7" args="(const PostingIterator &a, const PostingIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#b36ad8f69a1e7884ee9a8c171df440f7">operator==</a> (const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &a, const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test equality of two PostingIterators. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cdbc3d8d04f687c094a693e3f2133985"></a><!-- doxytag: member="Xapian::operator!=" ref="cdbc3d8d04f687c094a693e3f2133985" args="(const PostingIterator &a, const PostingIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#cdbc3d8d04f687c094a693e3f2133985">operator!=</a> (const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &a, const <a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test inequality of two PostingIterators. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#29a741b4cda98e10ed5f2fc784039065">sortable_serialise</a> (double value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a floating point number to a string, preserving sort order. <a href="#29a741b4cda98e10ed5f2fc784039065"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#326fe2d6b0ee59ac9536f3960e8fd99b">sortable_unserialise</a> (const std::string &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a string encoded using <em>sortable_serialise</em> back to a floating point number. <a href="#326fe2d6b0ee59ac9536f3960e8fd99b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6d2676890d652fd785d729d4a8da565"></a><!-- doxytag: member="Xapian::operator==" ref="e6d2676890d652fd785d729d4a8da565" args="(const TermIterator &a, const TermIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#e6d2676890d652fd785d729d4a8da565">operator==</a> (const <a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> &a, const <a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality test for <a class="el" href="classXapian_1_1TermIterator.html" title="An iterator pointing to items in a list of terms.">TermIterator</a> objects. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ecb406384b5cd18232f1a64008658ed"></a><!-- doxytag: member="Xapian::operator!=" ref="3ecb406384b5cd18232f1a64008658ed" args="(const TermIterator &a, const TermIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#3ecb406384b5cd18232f1a64008658ed">operator!=</a> (const <a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> &a, const <a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inequality test for <a class="el" href="classXapian_1_1TermIterator.html" title="An iterator pointing to items in a list of terms.">TermIterator</a> objects. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="407d9c7248816d5ccb9678c4c32066de"></a><!-- doxytag: member="Xapian::operator==" ref="407d9c7248816d5ccb9678c4c32066de" args="(const ValueIterator &a, const ValueIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#407d9c7248816d5ccb9678c4c32066de">operator==</a> (const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> &a, const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality test for <a class="el" href="classXapian_1_1ValueIterator.html" title="Class for iterating over document values.">ValueIterator</a> objects. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="53593fdefa90aa979a236020328990da"></a><!-- doxytag: member="Xapian::operator!=" ref="53593fdefa90aa979a236020328990da" args="(const ValueIterator &a, const ValueIterator &b)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#53593fdefa90aa979a236020328990da">operator!=</a> (const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> &a, const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inequality test for <a class="el" href="classXapian_1_1ValueIterator.html" title="Class for iterating over document values.">ValueIterator</a> objects. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#adb3ea72641cec03826dcd4215f02d55">version_string</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report the version string of the library which the program is linked with. <a href="#adb3ea72641cec03826dcd4215f02d55"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#170fe705bd7a4b465791e76312072046">major_version</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report the major version of the library which the program is linked with. <a href="#170fe705bd7a4b465791e76312072046"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#d995af7e143deb0eb7f9a1e03f477b47">minor_version</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report the minor version of the library which the program is linked with. <a href="#d995af7e143deb0eb7f9a1e03f477b47"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#21cc6b665ac32a43724d9f20673dfc45">revision</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Report the revision of the library which the program is linked with. <a href="#21cc6b665ac32a43724d9f20673dfc45"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#3d32111900603ce02b8c8467b9c5bacb">DB_CREATE_OR_OPEN</a> = 1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open for read/write; create if no db exists. <a href="#3d32111900603ce02b8c8467b9c5bacb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#1236aaa6a3d7a37a4c6b95439e449f7a">DB_CREATE</a> = 2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new database; fail if db exists. <a href="#1236aaa6a3d7a37a4c6b95439e449f7a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#fbc13e6712a12dcfd0c048242fc313ed">DB_CREATE_OR_OVERWRITE</a> = 3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Overwrite existing db; create if none exists. <a href="#fbc13e6712a12dcfd0c048242fc313ed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#54521467b649894bdc411f4c35e56ac3">DB_OPEN</a> = 4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open for read/write; fail if no db exists. <a href="#54521467b649894bdc411f4c35e56ac3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="namespaceXapian.html#94a899651fa920c72ffa9635bde630ea">valueno</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html#0a75ef120e641c77f703e60f595ffda2">BAD_VALUENO</a> = static_cast<<a class="el" href="namespaceXapian.html#94a899651fa920c72ffa9635bde630ea">valueno</a>>(-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reserved value to indicate "no valueno". <a href="#0a75ef120e641c77f703e60f595ffda2"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> namespace contains public interfaces for the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> library.
<p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="7f30aa95f0c42b117dafaf66ba24241d"></a><!-- doxytag: member="Xapian::doccount" ref="7f30aa95f0c42b117dafaf66ba24241d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned <a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A count of documents.
<p>
This is used to hold values such as the number of documents in a database and the frequency of a term in the database.
</div>
</div><p>
<a class="anchor" name="958ff32fd7a85f2b8a4784ac18397f2b"></a><!-- doxytag: member="Xapian::doccount_diff" ref="958ff32fd7a85f2b8a4784ac18397f2b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="namespaceXapian.html#958ff32fd7a85f2b8a4784ac18397f2b">Xapian::doccount_diff</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A signed difference between two counts of documents.
<p>
This is used by the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> classes which are STL containers of documents for "difference_type".
</div>
</div><p>
<a class="anchor" name="8fa9094bebe1256a7be935a5ede87a64"></a><!-- doxytag: member="Xapian::docid" ref="8fa9094bebe1256a7be935a5ede87a64" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned <a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A unique identifier for a document.
<p>
Docid 0 is invalid, providing an "out of range" value which can be used to mean "not a valid document".
</div>
</div><p>
<a class="anchor" name="63b13d3a36fcab9975658e32643d86b5"></a><!-- doxytag: member="Xapian::doclength" ref="63b13d3a36fcab9975658e32643d86b5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef double <a class="el" href="namespaceXapian.html#63b13d3a36fcab9975658e32643d86b5">Xapian::doclength</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A normalised document length.
<p>
The normalised document length is the document length divided by the average document length in the database.
</div>
</div><p>
<a class="anchor" name="22ea0a80c58a2047dd929621b75ed9a2"></a><!-- doxytag: member="Xapian::percent" ref="22ea0a80c58a2047dd929621b75ed9a2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="namespaceXapian.html#22ea0a80c58a2047dd929621b75ed9a2">Xapian::percent</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The percentage score for a document in an <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<p>
</div>
</div><p>
<a class="anchor" name="72b5a76dd8cfb7b251fe7986e86390cb"></a><!-- doxytag: member="Xapian::termcount" ref="72b5a76dd8cfb7b251fe7986e86390cb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned <a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A counts of terms.
<p>
This is used to hold values such as the Within <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database.">Document</a> Frequency (wdf).
</div>
</div><p>
<a class="anchor" name="886bd8fd46134d4b488091cfd8a658ed"></a><!-- doxytag: member="Xapian::termcount_diff" ref="886bd8fd46134d4b488091cfd8a658ed" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="namespaceXapian.html#886bd8fd46134d4b488091cfd8a658ed">Xapian::termcount_diff</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A signed difference between two counts of terms.
<p>
This is used by the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> classes which are STL containers of terms for "difference_type".
</div>
</div><p>
<a class="anchor" name="bc9d5170114fede39c85ee03086e373b"></a><!-- doxytag: member="Xapian::termpos_diff" ref="bc9d5170114fede39c85ee03086e373b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="namespaceXapian.html#bc9d5170114fede39c85ee03086e373b">Xapian::termpos_diff</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A signed difference between two term positions.
<p>
This is used by the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> classes which are STL containers of positions for "difference_type".
</div>
</div><p>
<a class="anchor" name="da10bc23c3467246f078179fce2d762d"></a><!-- doxytag: member="Xapian::timeout" ref="da10bc23c3467246f078179fce2d762d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned <a class="el" href="namespaceXapian.html#da10bc23c3467246f078179fce2d762d">Xapian::timeout</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A timeout value in milliseconds.
<p>
There are 1000 milliseconds in a second, so for example, to set a timeout of 5 seconds use 5000.
</div>
</div><p>
<a class="anchor" name="94a899651fa920c72ffa9635bde630ea"></a><!-- doxytag: member="Xapian::valueno" ref="94a899651fa920c72ffa9635bde630ea" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned <a class="el" href="namespaceXapian.html#94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The number for a value slot in a document.
<p>
Value slot numbers are unsigned and (currently) a 32-bit quantity, with <a class="el" href="namespaceXapian.html#0a75ef120e641c77f703e60f595ffda2" title="Reserved value to indicate "no valueno".">Xapian::BAD_VALUENO</a> being represented by the largest possible value. Therefore value slots 0 to 0xFFFFFFFE are available for use.
</div>
</div><p>
<a class="anchor" name="dd1b3ce8b08d23e4665b097f785c6a96"></a><!-- doxytag: member="Xapian::valueno_diff" ref="dd1b3ce8b08d23e4665b097f785c6a96" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="namespaceXapian.html#dd1b3ce8b08d23e4665b097f785c6a96">Xapian::valueno_diff</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A signed difference between two value slot numbers.
<p>
This is used by the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> classes which are STL containers of values for "difference_type".
</div>
</div><p>
<a class="anchor" name="cac12803afc9e24ee5141c119acb8884"></a><!-- doxytag: member="Xapian::weight" ref="cac12803afc9e24ee5141c119acb8884" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef double <a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The weight of a document or term.
<p>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="170fe705bd7a4b465791e76312072046"></a><!-- doxytag: member="Xapian::major_version" ref="170fe705bd7a4b465791e76312072046" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Xapian::major_version </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Report the major version of the library which the program is linked with.
<p>
This may be different to the version compiled against (given by XAPIAN_MAJOR_VERSION) if shared libraries are being used.
</div>
</div><p>
<a class="anchor" name="d995af7e143deb0eb7f9a1e03f477b47"></a><!-- doxytag: member="Xapian::minor_version" ref="d995af7e143deb0eb7f9a1e03f477b47" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Xapian::minor_version </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Report the minor version of the library which the program is linked with.
<p>
This may be different to the version compiled against (given by XAPIAN_MINOR_VERSION) if shared libraries are being used.
</div>
</div><p>
<a class="anchor" name="21cc6b665ac32a43724d9f20673dfc45"></a><!-- doxytag: member="Xapian::revision" ref="21cc6b665ac32a43724d9f20673dfc45" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Xapian::revision </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Report the revision of the library which the program is linked with.
<p>
This may be different to the version compiled against (given by XAPIAN_REVISION) if shared libraries are being used.
</div>
</div><p>
<a class="anchor" name="29a741b4cda98e10ed5f2fc784039065"></a><!-- doxytag: member="Xapian::sortable_serialise" ref="29a741b4cda98e10ed5f2fc784039065" args="(double value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::sortable_serialise </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert a floating point number to a string, preserving sort order.
<p>
This method converts a floating point number to a string, suitable for using as a value for numeric range restriction, or for use as a sort key.<p>
The conversion is platform independent.<p>
The conversion attempts to ensure that, for any pair of values supplied to the conversion algorithm, the result of comparing the original values (with a numeric comparison operator) will be the same as the result of comparing the resulting values (with a string comparison operator). On platforms which represent doubles with the precisions specified by IEEE_754, this will be the case: if the representation of doubles is more precise, it is possible that two very close doubles will be mapped to the same string, so will compare equal.<p>
Note also that both zero and -zero will be converted to the same representation: since these compare equal, this satisfies the comparison constraint, but it's worth knowing this if you wish to use the encoding in some situation where this distinction matters.<p>
Handling of NaN isn't (currently) guaranteed to be sensible.<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>value</em> </td><td>The number to serialise. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="326fe2d6b0ee59ac9536f3960e8fd99b"></a><!-- doxytag: member="Xapian::sortable_unserialise" ref="326fe2d6b0ee59ac9536f3960e8fd99b" args="(const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Xapian::sortable_unserialise </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert a string encoded using <em>sortable_serialise</em> back to a floating point number.
<p>
This expects the input to be a string produced by <em><a class="el" href="namespaceXapian.html#29a741b4cda98e10ed5f2fc784039065" title="Convert a floating point number to a string, preserving sort order.">sortable_serialise()</a></em>. If the input is not such a string, the value returned is undefined (but no error will be thrown).<p>
The result of the conversion will be exactly the value which was supplied to <em><a class="el" href="namespaceXapian.html#29a741b4cda98e10ed5f2fc784039065" title="Convert a floating point number to a string, preserving sort order.">sortable_serialise()</a></em> when making the string on platforms which represent doubles with the precisions specified by IEEE_754, but may be a different (nearby) value on other platforms.<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>value</em> </td><td>The serialised string to decode. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="adb3ea72641cec03826dcd4215f02d55"></a><!-- doxytag: member="Xapian::version_string" ref="adb3ea72641cec03826dcd4215f02d55" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* Xapian::version_string </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Report the version string of the library which the program is linked with.
<p>
This may be different to the version compiled against (given by XAPIAN_VERSION) if shared libraries are being used.
</div>
</div><p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="0a75ef120e641c77f703e60f595ffda2"></a><!-- doxytag: member="Xapian::BAD_VALUENO" ref="0a75ef120e641c77f703e60f595ffda2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespaceXapian.html#94a899651fa920c72ffa9635bde630ea">valueno</a> <a class="el" href="namespaceXapian.html#0a75ef120e641c77f703e60f595ffda2">Xapian::BAD_VALUENO</a> = static_cast<<a class="el" href="namespaceXapian.html#94a899651fa920c72ffa9635bde630ea">valueno</a>>(-1) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reserved value to indicate "no valueno".
<p>
</div>
</div><p>
<a class="anchor" name="1236aaa6a3d7a37a4c6b95439e449f7a"></a><!-- doxytag: member="Xapian::DB_CREATE" ref="1236aaa6a3d7a37a4c6b95439e449f7a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="namespaceXapian.html#1236aaa6a3d7a37a4c6b95439e449f7a">Xapian::DB_CREATE</a> = 2 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a new database; fail if db exists.
<p>
</div>
</div><p>
<a class="anchor" name="3d32111900603ce02b8c8467b9c5bacb"></a><!-- doxytag: member="Xapian::DB_CREATE_OR_OPEN" ref="3d32111900603ce02b8c8467b9c5bacb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="namespaceXapian.html#3d32111900603ce02b8c8467b9c5bacb">Xapian::DB_CREATE_OR_OPEN</a> = 1 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Open for read/write; create if no db exists.
<p>
</div>
</div><p>
<a class="anchor" name="fbc13e6712a12dcfd0c048242fc313ed"></a><!-- doxytag: member="Xapian::DB_CREATE_OR_OVERWRITE" ref="fbc13e6712a12dcfd0c048242fc313ed" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="namespaceXapian.html#fbc13e6712a12dcfd0c048242fc313ed">Xapian::DB_CREATE_OR_OVERWRITE</a> = 3 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Overwrite existing db; create if none exists.
<p>
</div>
</div><p>
<a class="anchor" name="54521467b649894bdc411f4c35e56ac3"></a><!-- doxytag: member="Xapian::DB_OPEN" ref="54521467b649894bdc411f4c35e56ac3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="namespaceXapian.html#54521467b649894bdc411f4c35e56ac3">Xapian::DB_OPEN</a> = 4 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Open for read/write; fail if no db exists.
<p>
</div>
</div><p>
</div>
<hr>
<address><small>
Documentation for Xapian (version 1.2.12).<br>
Generated on 27 Jun 2012 by
<a href="http://www.doxygen.org/">Doxygen 1.5.9</a>.
</small></address>
</body>
</html>
