namespacexapian.tex

xapian 是一个“Xapian 是一个开源概率论信息检索库

\hypertarget{namespaceXapian}{
\section{Xapian Namespace Reference}
\label{namespaceXapian}\index{Xapian@{Xapian}}
}
The \hyperlink{namespaceXapian}{Xapian} library lives in the \hyperlink{namespaceXapian}{Xapian} namespace.  


\subsection*{Classes}
\begin{CompactItemize}
\item 
class \hyperlink{classXapian_1_1Database}{Database}
\begin{CompactList}\small\item\em This class is used to access a database, or a group of databases. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1WritableDatabase}{Writable\-Database}
\begin{CompactList}\small\item\em This class provides read/write access to a database. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1Document}{Document}
\begin{CompactList}\small\item\em A document in the database - holds data, values, terms, and postings. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1MSet}{MSet}
\begin{CompactList}\small\item\em A match set (\hyperlink{classXapian_1_1MSet}{MSet}). \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator}
\begin{CompactList}\small\item\em An iterator pointing to items in an \hyperlink{classXapian_1_1MSet}{MSet}. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1ESet}{ESet}
\begin{CompactList}\small\item\em Class representing an ordered set of expand terms (an \hyperlink{classXapian_1_1ESet}{ESet}). \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1ESetIterator}{ESet\-Iterator}
\begin{CompactList}\small\item\em Iterate through terms in the \hyperlink{classXapian_1_1ESet}{ESet}. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1RSet}{RSet}
\begin{CompactList}\small\item\em A relevance set (R-Set). \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1MatchDecider}{Match\-Decider}
\begin{CompactList}\small\item\em Base class for matcher decision functor. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1ExpandDecider}{Expand\-Decider}
\begin{CompactList}\small\item\em Base class for expand decision functor. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1Enquire}{Enquire}
\begin{CompactList}\small\item\em This class provides an interface to the information retrieval system for the purpose of searching. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1Weight}{Weight}
\begin{CompactList}\small\item\em Abstract base class for weighting schemes. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1BoolWeight}{Bool\-Weight}
\begin{CompactList}\small\item\em Boolean weighting scheme (everything gets 0). \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1BM25Weight}{BM25Weight}
\begin{CompactList}\small\item\em BM25 weighting scheme. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1TradWeight}{Trad\-Weight}
\begin{CompactList}\small\item\em Traditional probabilistic weighting scheme (as used by Muscat 3.6). \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1Error}{Error}
\begin{CompactList}\small\item\em Base class for all Xapian-specific errors reported. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1ErrorHandler}{Error\-Handler}
\begin{CompactList}\small\item\em \hyperlink{classXapian_1_1Error}{Error} handling class. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1ExpandDeciderFilterTerms}{Expand\-Decider\-Filter\-Terms}
\begin{CompactList}\small\item\em One useful expand decision functor, which provides a way of filtering out a fixed list of terms from the expand set. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1ExpandDeciderAnd}{Expand\-Decider\-And}
\begin{CompactList}\small\item\em An expand decision functor which can be used to join two functors with an AND operation. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1TermPosWrapper}{Term\-Pos\-Wrapper}
\begin{CompactList}\small\item\em A wrapper class for a termpos which returns the termpos if dereferenced with $\ast$. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator}
\begin{CompactList}\small\item\em An iterator pointing to items in a list of positions. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1DocIDWrapper}{Doc\-IDWrapper}
\begin{CompactList}\small\item\em A wrapper class for a docid which returns the docid if dereferenced with $\ast$. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1PostingIterator}{Posting\-Iterator}
\begin{CompactList}\small\item\em An iterator pointing to items in a list of postings. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1Query}{Query}
\begin{CompactList}\small\item\em Class representing a query. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1Stopper}{Stopper}
\begin{CompactList}\small\item\em Base class for stop-word decision functor. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1SimpleStopper}{Simple\-Stopper}
\begin{CompactList}\small\item\em Simple implementation of \hyperlink{classXapian_1_1Stopper}{Stopper} class - this will suit most users. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1QueryParser}{Query\-Parser}
\begin{CompactList}\small\item\em Build a \hyperlink{classXapian_1_1Query}{Xapian::Query} object from a user query string. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1Stem}{Stem}
\begin{CompactList}\small\item\em Class representing a stemming algorithm. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1TermNameWrapper}{Term\-Name\-Wrapper}
\begin{CompactList}\small\item\em A wrapper class for a termname which returns the termname if dereferenced with $\ast$. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1TermIterator}{Term\-Iterator}
\begin{CompactList}\small\item\em An iterator pointing to items in a list of terms. \item\end{CompactList}\item 
class \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator}
\begin{CompactList}\small\item\em An iterator pointing to values associated with a document. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
\hypertarget{namespaceXapian_5d6ed5a88ec3d4471e45b1598691dab4}{
bool {\bf operator==} (const \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \&a, const \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \&b)}
\label{namespaceXapian_5d6ed5a88ec3d4471e45b1598691dab4}

\item 
\hypertarget{namespaceXapian_245fbc9f00ff6dac8724c65926495585}{
bool {\bf operator!=} (const \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \&a, const \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \&b)}
\label{namespaceXapian_245fbc9f00ff6dac8724c65926495585}

\item 
\hypertarget{namespaceXapian_bb14b86f144db20662592575911ca308}{
bool {\bf operator==} (const \hyperlink{classXapian_1_1ESetIterator}{ESet\-Iterator} \&a, const \hyperlink{classXapian_1_1ESetIterator}{ESet\-Iterator} \&b)}
\label{namespaceXapian_bb14b86f144db20662592575911ca308}

\item 
\hypertarget{namespaceXapian_c2c2c0ec620503d10c024f076db2bde4}{
bool {\bf operator!=} (const \hyperlink{classXapian_1_1ESetIterator}{ESet\-Iterator} \&a, const \hyperlink{classXapian_1_1ESetIterator}{ESet\-Iterator} \&b)}
\label{namespaceXapian_c2c2c0ec620503d10c024f076db2bde4}

\item 
bool \hyperlink{namespaceXapian_cd6a36fe0327deef4f720416036d48cc}{operator==} (const \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \&a, const \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \&b)
\begin{CompactList}\small\item\em Test equality of two Position\-Iterators. \item\end{CompactList}\item 
bool \hyperlink{namespaceXapian_84bfb06d1ced43e6602f81c17d5e8e77}{operator!=} (const \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \&a, const \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \&b)
\begin{CompactList}\small\item\em Test inequality of two Position\-Iterators. \item\end{CompactList}\item 
bool \hyperlink{namespaceXapian_b36ad8f69a1e7884ee9a8c171df440f7}{operator==} (const \hyperlink{classXapian_1_1PostingIterator}{Posting\-Iterator} \&a, const \hyperlink{classXapian_1_1PostingIterator}{Posting\-Iterator} \&b)
\begin{CompactList}\small\item\em Test equality of two Posting\-Iterators. \item\end{CompactList}\item 
bool \hyperlink{namespaceXapian_cdbc3d8d04f687c094a693e3f2133985}{operator!=} (const \hyperlink{classXapian_1_1PostingIterator}{Posting\-Iterator} \&a, const \hyperlink{classXapian_1_1PostingIterator}{Posting\-Iterator} \&b)
\begin{CompactList}\small\item\em Test inequality of two Posting\-Iterators. \item\end{CompactList}\item 
\hypertarget{namespaceXapian_e6d2676890d652fd785d729d4a8da565}{
bool {\bf operator==} (const \hyperlink{classXapian_1_1TermIterator}{Term\-Iterator} \&a, const \hyperlink{classXapian_1_1TermIterator}{Term\-Iterator} \&b)}
\label{namespaceXapian_e6d2676890d652fd785d729d4a8da565}

\item 
\hypertarget{namespaceXapian_3ecb406384b5cd18232f1a64008658ed}{
bool {\bf operator!=} (const \hyperlink{classXapian_1_1TermIterator}{Term\-Iterator} \&a, const \hyperlink{classXapian_1_1TermIterator}{Term\-Iterator} \&b)}
\label{namespaceXapian_3ecb406384b5cd18232f1a64008658ed}

\item 
\hypertarget{namespaceXapian_407d9c7248816d5ccb9678c4c32066de}{
bool {\bf operator==} (const \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \&a, const \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \&b)}
\label{namespaceXapian_407d9c7248816d5ccb9678c4c32066de}

\item 
\hypertarget{namespaceXapian_53593fdefa90aa979a236020328990da}{
bool {\bf operator!=} (const \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \&a, const \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \&b)}
\label{namespaceXapian_53593fdefa90aa979a236020328990da}

\end{CompactItemize}
\subsection*{Variables}
\begin{CompactItemize}
\item 
\hypertarget{namespaceXapian_3d32111900603ce02b8c8467b9c5bacb}{
const int {\bf DB\_\-CREATE\_\-OR\_\-OPEN} = 1}
\label{namespaceXapian_3d32111900603ce02b8c8467b9c5bacb}

\item 
\hypertarget{namespaceXapian_1236aaa6a3d7a37a4c6b95439e449f7a}{
const int {\bf DB\_\-CREATE} = 2}
\label{namespaceXapian_1236aaa6a3d7a37a4c6b95439e449f7a}

\item 
\hypertarget{namespaceXapian_fbc13e6712a12dcfd0c048242fc313ed}{
const int {\bf DB\_\-CREATE\_\-OR\_\-OVERWRITE} = 3}
\label{namespaceXapian_fbc13e6712a12dcfd0c048242fc313ed}

\item 
\hypertarget{namespaceXapian_54521467b649894bdc411f4c35e56ac3}{
const int {\bf DB\_\-OPEN} = 4}
\label{namespaceXapian_54521467b649894bdc411f4c35e56ac3}

\end{CompactItemize}


\subsection{Detailed Description}
The \hyperlink{namespaceXapian}{Xapian} library lives in the \hyperlink{namespaceXapian}{Xapian} namespace. 

\subsection{Function Documentation}
\hypertarget{namespaceXapian_cdbc3d8d04f687c094a693e3f2133985}{
\index{Xapian@{Xapian}!operator"!=@{operator"!=}}
\index{operator"!=@{operator"!=}!Xapian@{Xapian}}
\subsubsection[operator"!=]{\setlength{\rightskip}{0pt plus 5cm}bool Xapian::operator!= (const Posting\-Iterator \& {\em a}, const Posting\-Iterator \& {\em b})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{namespaceXapian_cdbc3d8d04f687c094a693e3f2133985}


Test inequality of two Posting\-Iterators. 

\hypertarget{namespaceXapian_84bfb06d1ced43e6602f81c17d5e8e77}{
\index{Xapian@{Xapian}!operator"!=@{operator"!=}}
\index{operator"!=@{operator"!=}!Xapian@{Xapian}}
\subsubsection[operator"!=]{\setlength{\rightskip}{0pt plus 5cm}bool Xapian::operator!= (const Position\-Iterator \& {\em a}, const Position\-Iterator \& {\em b})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{namespaceXapian_84bfb06d1ced43e6602f81c17d5e8e77}


Test inequality of two Position\-Iterators. 

\hypertarget{namespaceXapian_b36ad8f69a1e7884ee9a8c171df440f7}{
\index{Xapian@{Xapian}!operator==@{operator==}}
\index{operator==@{operator==}!Xapian@{Xapian}}
\subsubsection[operator==]{\setlength{\rightskip}{0pt plus 5cm}bool Xapian::operator== (const Posting\-Iterator \& {\em a}, const Posting\-Iterator \& {\em b})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{namespaceXapian_b36ad8f69a1e7884ee9a8c171df440f7}


Test equality of two Posting\-Iterators. 

\hypertarget{namespaceXapian_cd6a36fe0327deef4f720416036d48cc}{
\index{Xapian@{Xapian}!operator==@{operator==}}
\index{operator==@{operator==}!Xapian@{Xapian}}
\subsubsection[operator==]{\setlength{\rightskip}{0pt plus 5cm}bool Xapian::operator== (const Position\-Iterator \& {\em a}, const Position\-Iterator \& {\em b})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{namespaceXapian_cd6a36fe0327deef4f720416036d48cc}


Test equality of two Position\-Iterators.