Classes | |
class | Database |
class | WritableDatabase |
class | DerefStringWrapper_ |
class | Document |
A document in the database - holds data, values, terms, and postings. More... | |
class | MSet |
class | MSetIterator |
class | ESet |
class | ESetIterator |
class | RSet |
class | MatchDecider |
class | Enquire |
class | ErrorHandler |
class | ExpandDecider |
class | ExpandDeciderAnd |
class | ExpandDeciderFilterTerms |
class | TermPosWrapper |
class | PositionIterator |
class | DocIDWrapper |
class | PostingIterator |
class | PostingSource |
class | ValuePostingSource |
class | ValueWeightPostingSource |
class | ValueMapPostingSource |
class | FixedWeightPostingSource |
class | Query |
class | Stopper |
Base class for stop-word decision functor. More... | |
class | SimpleStopper |
Simple implementation of Stopper class - this will suit most users. More... | |
struct | ValueRangeProcessor |
Base class for value range processors. More... | |
class | StringValueRangeProcessor |
class | DateValueRangeProcessor |
class | NumberValueRangeProcessor |
class | QueryParser |
Build a Xapian::Query object from a user query string. More... | |
struct | ReplicationInfo |
class | DatabaseMaster |
class | DatabaseReplica |
class | SerialisationContext |
class | Sorter |
class | MultiValueSorter |
class | Stem |
Class representing a stemming algorithm. More... | |
class | TermGenerator |
class | TermIterator |
class | Utf8Iterator |
class | ValueIteratorEnd_ |
class | ValueIterator |
Class for iterating over document values. More... | |
class | ValueSetMatchDecider |
class | Weight |
class | BoolWeight |
class | BM25Weight |
Xapian::Weight subclass implementing the BM25 probabilistic formula. More... | |
class | TradWeight |
Typedefs | |
typedef unsigned | doccount |
typedef int | doccount_diff |
typedef unsigned | docid |
typedef double | doclength |
typedef int | percent |
typedef unsigned | termcount |
typedef int | termcount_diff |
typedef unsigned | termpos |
typedef int | termpos_diff |
typedef unsigned | timeout |
typedef unsigned | valueno |
typedef int | valueno_diff |
typedef double | weight |
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. | |
XAPIAN_VISIBILITY_DEFAULT std::string | sortable_serialise (double value) |
XAPIAN_VISIBILITY_DEFAULT double | sortable_unserialise (const std::string &value) |
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 ValueIteratorEnd_ &) |
bool | operator== (const ValueIteratorEnd_ &a, const ValueIterator &b) |
bool | operator== (const ValueIteratorEnd_ &, const ValueIteratorEnd_ &) |
bool | operator!= (const ValueIterator &a, const ValueIterator &b) |
bool | operator!= (const ValueIterator &a, const ValueIteratorEnd_ &b) |
bool | operator!= (const ValueIteratorEnd_ &a, const ValueIterator &b) |
bool | operator!= (const ValueIteratorEnd_ &a, const ValueIteratorEnd_ &b) |
XAPIAN_VISIBILITY_DEFAULT const char * | version_string () |
XAPIAN_VISIBILITY_DEFAULT int | major_version () |
XAPIAN_VISIBILITY_DEFAULT int | minor_version () |
XAPIAN_VISIBILITY_DEFAULT int | revision () |
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 |
const valueno | BAD_VALUENO = static_cast<valueno>(-1) |
typedef unsigned Xapian::doccount |
A count of documents.
This is used to hold values such as the number of documents in a database and the frequency of a term in the database.
typedef int Xapian::doccount_diff |
A signed difference between two counts of documents.
This is used by the Xapian classes which are STL containers of documents for "difference_type".
typedef unsigned Xapian::docid |
A unique identifier for a document.
Docid 0 is invalid, providing an "out of range" value which can be used to mean "not a valid document".
typedef double Xapian::doclength |
A normalised document length.
The normalised document length is the document length divided by the average document length in the database.
typedef int Xapian::percent |
The percentage score for a document in an MSet.
typedef unsigned Xapian::termcount |
A counts of terms.
This is used to hold values such as the Within Document Frequency (wdf).
typedef int Xapian::termcount_diff |
A signed difference between two counts of terms.
This is used by the Xapian classes which are STL containers of terms for "difference_type".
typedef unsigned Xapian::termpos |
A term position within a document or query.
typedef int Xapian::termpos_diff |
A signed difference between two term positions.
This is used by the Xapian classes which are STL containers of positions for "difference_type".
typedef unsigned Xapian::timeout |
A timeout value in microseconds.
There are 1 million microseconds in a second, so for example, to set a timeout of 5 seconds use 5000000.
typedef unsigned Xapian::valueno |
The number for a value slot in a document.
Any value slot number except Xapian::BAD_VALUENO is valid.
typedef int Xapian::valueno_diff |
A signed difference between two value slot numbers.
This is used by the Xapian classes which are STL containers of values for "difference_type".
typedef double Xapian::weight |
The weight of a document or term.
XAPIAN_VISIBILITY_DEFAULT int Xapian::major_version | ( | ) |
Report the major version of the library which the program is linked to.
This may be different to the version compiled against (given by XAPIAN_MAJOR_VERSION) if shared libraries are being used.
XAPIAN_VISIBILITY_DEFAULT int Xapian::minor_version | ( | ) |
Report the minor version of the library which the program is linked to.
This may be different to the version compiled against (given by XAPIAN_MINOR_VERSION) if shared libraries are being used.
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.
XAPIAN_VISIBILITY_DEFAULT int Xapian::revision | ( | ) |
Report the revision of the library which the program is linked to.
This may be different to the version compiled against (given by XAPIAN_REVISION) if shared libraries are being used.
XAPIAN_VISIBILITY_DEFAULT std::string Xapian::sortable_serialise | ( | double | value | ) |
Convert a floating point number to a string, preserving sort order.
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.
The conversion is platform independent.
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.
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.
Handling of NaN isn't (currently) guaranteed to be sensible.
XAPIAN_VISIBILITY_DEFAULT double Xapian::sortable_unserialise | ( | const std::string & | value | ) |
Convert a string encoded using sortable_serialise back to a floating point number.
This expects the input to be a string produced by sortable_serialise(). If the input is not such a string, the value returned is undefined (but no error will be thrown).
The result of the conversion will be exactly the value which was supplied to sortable_serialise() 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.
XAPIAN_VISIBILITY_DEFAULT const char* Xapian::version_string | ( | ) |
Report the version string of the library which the program is linked with.
This may be different to the version compiled against (given by XAPIAN_VERSION) if shared libraries are being used.
const valueno Xapian::BAD_VALUENO = static_cast<valueno>(-1) |
Reserved value to indicate "no valueno".
const int Xapian::DB_CREATE = 2 |
Create a new database; fail if db exists.
const int Xapian::DB_CREATE_OR_OPEN = 1 |
Open for read/write; create if no db exists.
const int Xapian::DB_CREATE_OR_OVERWRITE = 3 |
Overwrite existing db; create if none exists.
const int Xapian::DB_OPEN = 4 |
Open for read/write; fail if no db exists.