# Xapian Namespace Reference

The Xapian library lives in the Xapian namespace. More...

## Classes

class | Database
| This class is used to access a database, or a group of databases. More...
class | WritableDatabase
| This class provides read/write access to a database. More...
class | Document
| A document in the database - holds data, values, terms, and postings. More...
class | MSet
| A match set (MSet). More...
class | MSetIterator
| An iterator pointing to items in an MSet. More...
class | ESet
| Class representing an ordered set of expand terms (an ESet). More...
class | ESetIterator
| Iterate through terms in the ESet. More...
class | RSet
| A relevance set (R-Set). More...
class | MatchDecider
| Base class for matcher decision functor. More...
class | ExpandDecider
| Base class for expand decision functor. More...
class | Enquire
| This class provides an interface to the information retrieval system for the purpose of searching. More...
class | Weight
| Abstract base class for weighting schemes. More...
class | BoolWeight
| Boolean weighting scheme (everything gets 0). More...
class | BM25Weight
| BM25 weighting scheme. More...
class | TradWeight
| Traditional probabilistic weighting scheme (as used by Muscat 3.6). More...
class | Error
| Base class for all Xapian-specific errors reported. More...
class | ErrorHandler
| Error handling class. More...
class | ExpandDeciderFilterTerms
| One useful expand decision functor, which provides a way of filtering out a fixed list of terms from the expand set. More...
class | ExpandDeciderAnd
| An expand decision functor which can be used to join two functors with an AND operation. More...
class | TermPosWrapper
| A wrapper class for a termpos which returns the termpos if dereferenced with *. More...
class | PositionIterator
| An iterator pointing to items in a list of positions. More...
class | DocIDWrapper
| A wrapper class for a docid which returns the docid if dereferenced with *. More...
class | PostingIterator
| An iterator pointing to items in a list of postings. More...
class | Query
| Class representing a query. More...
class | Stopper
| Base class for stop-word decision functor. More...
class | SimpleStopper
| Simple implementation of Stopper class - this will suit most users. More...
class | QueryParser
| Build a Xapian::Query object from a user query string. More...
class | Stem
| Class representing a stemming algorithm. More...
class | TermNameWrapper
| A wrapper class for a termname which returns the termname if dereferenced with *. More...
class | TermIterator
| An iterator pointing to items in a list of terms. More...
class | ValueIterator
| An iterator pointing to values associated with a document. More...

## Functions

bool | operator== (const MSetIterator &a, const MSetIterator &b)
bool | operator!= (const MSetIterator &a, const MSetIterator &b)
bool | operator== (const ESetIterator &a, const ESetIterator &b)
bool | operator!= (const ESetIterator &a, const ESetIterator &b)
bool | operator== (const PositionIterator &a, const PositionIterator &b)
| Test equality of two PositionIterators.
bool | operator!= (const PositionIterator &a, const PositionIterator &b)
| Test inequality of two PositionIterators.
bool | operator== (const PostingIterator &a, const PostingIterator &b)
| Test equality of two PostingIterators.
bool | operator!= (const PostingIterator &a, const PostingIterator &b)
| Test inequality of two PostingIterators.
bool | operator== (const TermIterator &a, const TermIterator &b)
bool | operator!= (const TermIterator &a, const TermIterator &b)
bool | operator== (const ValueIterator &a, const ValueIterator &b)
bool | operator!= (const ValueIterator &a, const ValueIterator &b)

## Variables

const int | DB_CREATE_OR_OPEN = 1
const int | DB_CREATE = 2
const int | DB_CREATE_OR_OVERWRITE = 3
const int | DB_OPEN = 4

## Detailed Description

The Xapian library lives in the Xapian namespace.

## Function Documentation

bool Xapian::operator!= | ( | const PostingIterator & | a,
|  | const PostingIterator & | b
| ) | `[inline]`

| Test inequality of two PostingIterators.

bool Xapian::operator!= | ( | const PositionIterator & | a,
|  | const PositionIterator & | b
| ) | `[inline]`

| Test inequality of two PositionIterators.

bool Xapian::operator== | ( | const PostingIterator & | a,
|  | const PostingIterator & | b
| ) | `[inline]`

| Test equality of two PostingIterators.

bool Xapian::operator== | ( | const PositionIterator & | a,
|  | const PositionIterator & | b
| ) | `[inline]`

| Test equality of two PositionIterators.