Xapian: API Documentation: xapian.h File Reference

xapian-core 1.4.17

Namespaces | Macros | Functions
xapian.h File Reference

Public interfaces for the Xapian library. More...

## Namespaces
| Xapian
| The Xapian namespace contains public interfaces for the Xapian library.

## Functions
const char * | Xapian::version_string ()
| Report the version string of the library which the program is linked with. More...
int | Xapian::major_version ()
| Report the major version of the library which the program is linked with. More...
int | Xapian::minor_version ()
| Report the minor version of the library which the program is linked with. More...
int | Xapian::revision ()
| Report the revision of the library which the program is linked with. More...

## Detailed Description

Public interfaces for the Xapian library.

Xapian::FieldProcessor::release
const FieldProcessor * release() const
Start reference counting this object.
Definition: queryparser.h:763
Xapian::Weight::need_stat
void need_stat(stat_flags flag)
Tell Xapian that your subclass will want a particular statistic.
Definition: weight.h:83
Xapian::Stopper::get_description
virtual std::string get_description() const
Return a string describing this object.
Xapian::ExpandDeciderFilterPrefix::ExpandDeciderFilterPrefix
ExpandDeciderFilterPrefix(const std::string &prefix_)
The parameter specify the prefix of terms to be retained.
Definition: expanddecider.h:150
Xapian::TermIterator::~TermIterator
~TermIterator()
Destructor.
Definition: termiterator.h:84
Xapian::FixedWeightPostingSource::unserialise
FixedWeightPostingSource * unserialise(const std::string &serialised) const
Create object given string serialisation returned by serialise().
Xapian::Weight::get_query_length
Xapian::termcount get_query_length() const
The length of the query.
Definition: weight.h:359
Xapian::LatLongCoords::unserialise
void unserialise(const std::string &serialised)
Unserialise a string and set this object to the coordinates in it.
Xapian::DB_RETRY_LOCK
const int DB_RETRY_LOCK
If the database is already locked, retry the lock.
Definition: constants.h:145
Xapian::Registry
Registry for user subclasses.
Definition: registry.h:47
Xapian::InvalidArgumentError::InvalidArgumentError
InvalidArgumentError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:257
Xapian::Compactor::compact
void compact()
Perform the actual compaction/merging operation.
Xapian::TermGenerator::increase_termpos
void increase_termpos(Xapian::termpos delta=100)
Increase the term position used by index_text.
Xapian::Enquire::set_sort_by_relevance
void set_sort_by_relevance()
Set the sorting to be by relevance only.
Xapian::Enquire::set_docid_order
void set_docid_order(docid_order order)
Set sort order for document IDs.
Xapian::TradWeight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
Xapian::MatchSpy::serialise_results
virtual std::string serialise_results() const
Serialise the results of this match spy.
Xapian::Unicode::NON_SPACING_MARK
@ NON_SPACING_MARK
Mark, nonspacing (Mn)
Definition: unicode.h:227
Xapian::PL2PlusWeight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::ValueIterator::operator++
DerefWrapper_< std::string > operator++(int)
Advance the iterator to the next position (postfix version).
Definition: valueiterator.h:96
Xapian::DatabaseModifiedError
DatabaseModifiedError indicates a database was modified.
Definition: error.h:539
Xapian::ESet::operator[]
ESetIterator operator[](Xapian::doccount i) const
Return iterator pointing to the i-th object in this ESet.
Definition: eset.h:357
Xapian::Registry::register_posting_source
void register_posting_source(const Xapian::PostingSource &source)
Register a user-defined posting source class.
Xapian::MatchSpy
Abstract base class for match spies.
Definition: matchspy.h:50
Xapian::PostingIterator::get_wdf
Xapian::termcount get_wdf() const
Return the wdf for the document at the current position.
Xapian::FixedWeightPostingSource::get_termfreq_est
Xapian::doccount get_termfreq_est() const
An estimate of the number of documents this object can return.
Xapian::Database::allterms_end
TermIterator allterms_end(const std::string &=std::string()) const
Corresponding end iterator to allterms_begin(prefix).
Definition: database.h:265
Xapian::ESetIterator::get_description
std::string get_description() const
Return a string describing this object.
Xapian::Database::keep_alive
void keep_alive()
Send a "keep-alive" to remote databases to stop them timing out.
Xapian::BB2Weight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::Enquire::Enquire
Enquire(const Database &database, ErrorHandler *errorhandler_)
Create a Xapian::Enquire object.
Xapian::Unicode::INITIAL_QUOTE_PUNCTUATION
@ INITIAL_QUOTE_PUNCTUATION
Punctuation, initial quote (Pi)
Definition: unicode.h:244
Xapian::PostingIterator::positionlist_begin
PositionIterator positionlist_begin() const
Return a PositionIterator for the current document.
Xapian::LatLongDistancePostingSource::get_description
std::string get_description() const
Return a string describing this object.
Xapian::QueryParser::set_default_op
void set_default_op(Query::op default_op)
Set the default operator.
Xapian::BAD_VALUENO
const valueno BAD_VALUENO
Reserved value to indicate "no valueno".
Definition: types.h:125
Xapian::PostingSource::clone
virtual PostingSource * clone() const
Clone the posting source.
Xapian::TermGenerator::set_flags
flags set_flags(flags toggle, flags mask=flags(0))
Set flags.
Xapian::TermIterator::operator++
DerefWrapper_< std::string > operator++(int)
Advance the iterator to the next position (postfix version).
Definition: termiterator.h:112
Xapian::Database::operator=
void operator=(const Database &other)
Assignment is allowed.
Xapian::Registry::get_posting_source
const Xapian::PostingSource * get_posting_source(const std::string &name) const
Get a posting source given a name.
Xapian::StringValueRangeProcessor::prefix
bool prefix
Whether to look for str as a prefix or suffix.
Definition: queryparser.h:464
Xapian::BoolWeight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
Xapian::Query::operator|=
const Query operator|=(const Query &o)
Combine with another Xapian::Query object using OP_OR.
Definition: query.h:802
Xapian::Database::spellings_begin
Xapian::TermIterator spellings_begin() const
An iterator which returns all the spelling correction targets.
Xapian::TfIdfWeight::unserialise
TfIdfWeight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::DatabaseLockError::DatabaseLockError
DatabaseLockError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:509
Xapian::Enquire::set_sort_by_value
void set_sort_by_value(Xapian::valueno sort_key, bool reverse)
Set the sorting to be by value only.
Xapian::Unicode::TITLECASE_LETTER
@ TITLECASE_LETTER
Letter, titlecase (Lt)
Definition: unicode.h:224
Xapian::ValueCountMatchSpy::ValueCountMatchSpy
ValueCountMatchSpy(Xapian::valueno slot_)
Construct a MatchSpy which counts the values in a particular slot.
Definition: matchspy.h:237
Xapian::PL2Weight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::TfIdfWeight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::IneB2Weight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::LatLongCoord
A latitude-longitude coordinate.
Definition: geospatial.h:81
Xapian::ValueMapPostingSource::get_weight
double get_weight() const
Return the weight contribution for the current document.
Xapian::QueryParser::~QueryParser
~QueryParser()
Destructor.
Xapian::ErrorHandler::operator()
void operator()(Xapian::Error &error)
Handle a Xapian::Error object.
Xapian::Enquire::get_matching_terms_end
TermIterator get_matching_terms_end(Xapian::docid) const
End iterator corresponding to get_matching_terms_begin()
Definition: enquire.h:713
Xapian::LatLongMetric::clone
virtual LatLongMetric * clone() const =0
Clone the metric.
Xapian::Unicode::MATH_SYMBOL
@ MATH_SYMBOL
Symbol, math (Sm)
Definition: unicode.h:247
Xapian::BB2Weight
This class implements the BB2 weighting scheme.
Definition: weight.h:1032
Xapian::DateValueRangeProcessor
Handle a date range.
Definition: queryparser.h:512
Xapian::RangeError::RangeError
RangeError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:995
Xapian::Database::get_value_upper_bound
std::string get_value_upper_bound(Xapian::valueno slot) const
Get an upper bound on the values stored in the given value slot.
Xapian::Enquire::set_cutoff
void set_cutoff(int percent_cutoff, double weight_cutoff=0)
Set the percentage and/or weight cutoffs.
Xapian::NetworkError::NetworkError
NetworkError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:819
Xapian::Unicode::OTHER_PUNCTUATION
@ OTHER_PUNCTUATION
Punctuation, other (Po)
Definition: unicode.h:246
Xapian::Document::set_data
void set_data(const std::string &data)
Set data stored in the document.
Xapian::Weight::Weight
Weight()
Default constructor, needed by subclass constructors.
Definition: weight.h:141
Xapian::DatabaseVersionError::DatabaseVersionError
DatabaseVersionError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:648
Xapian::LatLongDistancePostingSource::get_weight
double get_weight() const
Return the weight contribution for the current document.
Xapian::ValueIterator::get_description
std::string get_description() const
Return a string describing this object.
Xapian::Unicode::FINAL_QUOTE_PUNCTUATION
@ FINAL_QUOTE_PUNCTUATION
Punctuation, final quote (Pf)
Definition: unicode.h:245
Xapian::Unicode::get_category
category get_category(unsigned ch)
Return the category which a given Unicode character falls into.
Definition: unicode.h:338
Xapian::PostingSource::unserialise_with_registry
virtual PostingSource * unserialise_with_registry(const std::string &serialised, const Registry &registry) const
Create object given string serialisation returned by serialise().
Xapian::StemImplementation::~StemImplementation
virtual ~StemImplementation()
Virtual destructor.
Xapian::DBCOMPACT_SINGLE_FILE
const int DBCOMPACT_SINGLE_FILE
Produce a single-file database.
Definition: constants.h:268
Xapian::Unicode::SURROGATE
@ SURROGATE
Other, surrogate (Cs)
Definition: unicode.h:239
Xapian::QueryParser::unstem_begin
TermIterator unstem_begin(const std::string &term) const
Begin iterator over unstemmed forms of the given stemmed query term.
Xapian::ValueRangeProcessor::~ValueRangeProcessor
virtual ~ValueRangeProcessor()
Destructor.
Xapian::MSetIterator::MSetIterator
MSetIterator()
Create an unpositioned MSetIterator.
Definition: mset.h:369
Xapian::MatchSpy::operator()
virtual void operator()(const Xapian::Document &doc, double wt)=0
Register a document with the match spy.
Xapian::LatLongDistancePostingSource::skip_to
void skip_to(Xapian::docid min_docid, double min_wt)
Advance to the specified docid.
Xapian::Enquire::set_expansion_scheme
void set_expansion_scheme(const std::string &eweightname_, double expand_k_=1.0) const
Set the weighting scheme to use for expansion.
Xapian::BM25PlusWeight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
Xapian::Document::clear_terms
void clear_terms()
Remove all terms (and postings) from the document.
Xapian::ValueIterator::~ValueIterator
~ValueIterator()
Destructor.
Definition: valueiterator.h:85
Xapian::Database::synonyms_end
Xapian::TermIterator synonyms_end(const std::string &) const
Corresponding end iterator to synonyms_begin(term).
Definition: database.h:443
Xapian::IneB2Weight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::MSet::operator[]
MSetIterator operator[](Xapian::doccount i) const
Return iterator pointing to the i-th object in this MSet.
Definition: mset.h:619
Xapian::RSet::RSet
RSet(const RSet &rset)
Copy constructor.
Xapian::Stopper::Stopper
Stopper()
Default constructor.
Definition: queryparser.h:56
Xapian::operator<
bool operator<(const ESetIterator &a, const ESetIterator &b)
Inequality test for ESetIterator objects.
Definition: eset.h:297
Xapian::WildcardError
WildcardError indicates an error expanding a wildcarded query.
Definition: error.h:1013
Xapian::Document::serialise
std::string serialise() const
Serialise document into a string.
Xapian::TermGenerator::get_description
std::string get_description() const
Return a string describing this object.
Xapian::QueryParser::add_boolean_prefix
void add_boolean_prefix(const std::string &field, const std::string &prefix, const std::string *grouping=NULL)
Add a boolean term prefix allowing the user to restrict a search with a boolean filter specified in t...
Xapian::Enquire::get_eset
ESet get_eset(Xapian::termcount maxitems, const RSet &omrset, const Xapian::ExpandDecider *edecider) const
Get the expand set for the given rset.
Definition: enquire.h:643
Xapian::Enquire::set_sort_by_value_then_relevance
void set_sort_by_value_then_relevance(Xapian::valueno sort_key, bool reverse)
Set the sorting to be by value, then by relevance for documents with the same value.
Xapian::Database::get_total_length
Xapian::totallength get_total_length() const
Get the total length of all the documents in the database.
Xapian::LatLongCoord::LatLongCoord
LatLongCoord()
Construct an uninitialised coordinate.
Definition: geospatial.h:102
Xapian::TradWeight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqueterms) const
Calculate the weight contribution for this object's term to a document.
Xapian::MSet::fetch
void fetch() const
Prefetch hint the whole MSet.
Definition: mset.h:277
Xapian::QueryParser::set_stopper
void set_stopper(const Stopper *stop=NULL)
Set the stopper.
Xapian::PostingSource::get_weight
virtual double get_weight() const
Return the weight contribution for the current document.
Xapian::Error::get_description
std::string get_description() const
Return a string describing this object.
Xapian::LatLongCoord::longitude
double longitude
A longitude, as decimal degrees.
Definition: geospatial.h:98
Xapian::miles_to_metres
double miles_to_metres(double miles)
Convert from miles to metres.
Definition: geospatial.h:54
Xapian::ExpandDeciderAnd::ExpandDeciderAnd
ExpandDeciderAnd(const ExpandDecider &first_, const ExpandDecider &second_)
Terms will be checked with first, and if accepted, then checked with second.
Definition: expanddecider.h:98
Xapian::Database::postlist_end
PostingIterator postlist_end(const std::string &) const
Corresponding end iterator to postlist_begin().
Definition: database.h:225
Xapian::LatLongCoordsIterator::LatLongCoordsIterator
LatLongCoordsIterator()
Default constructor. Produces an uninitialised iterator.
Definition: geospatial.h:178
Xapian::DatabaseCreateError::DatabaseCreateError
DatabaseCreateError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:467
Xapian::version_string
const char * version_string()
Report the version string of the library which the program is linked with.
Definition: xapian.h:115
Xapian::TermIterator::TermIterator
TermIterator(const TermIterator &o)
Copy constructor.
Xapian::RangeProcessor::flags
unsigned flags
Flags.
Definition: queryparser.h:161
Xapian::ValuePostingSource::get_termfreq_est
Xapian::doccount get_termfreq_est() const
An estimate of the number of documents this object can return.
Xapian::CoordWeight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::TermGenerator::get_document
const Xapian::Document & get_document() const
Get the current document.
Xapian::QueryParser::unstem_end
TermIterator unstem_end(const std::string &) const
End iterator over unstemmed forms of the given stemmed query term.
Definition: queryparser.h:1218
Xapian::TfIdfWeight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
types.h
typedefs for Xapian
Xapian::TradWeight
Xapian::Weight subclass implementing the traditional probabilistic formula.
Definition: weight.h:746
Xapian::ErrorHandler::ErrorHandler
ErrorHandler()
Default constructor.
Definition: errorhandler.h:81
Xapian::MultiValueKeyMaker::add_value
void add_value(Xapian::valueno slot, bool reverse=false, const std::string &defvalue=std::string())
Add a value slot to the list to build a key from.
Definition: keymaker.h:143
Xapian::ValueIterator::get_valueno
Xapian::valueno get_valueno() const
Return the value slot number for the current position.
Xapian::PostingIterator::PostingIterator
PostingIterator(const PostingIterator &o)
Copy constructor.
Xapian::Document::Document
Document()
Make a new empty Document.
Xapian::Database::get_uuid
std::string get_uuid() const
Get a UUID for the database.
Xapian::DB_CREATE_OR_OVERWRITE
const int DB_CREATE_OR_OVERWRITE
Create database if it doesn't already exist, or overwrite if it does.
Definition: constants.h:38
Xapian::MatchDecider::~MatchDecider
virtual ~MatchDecider()
Destructor.
Xapian::timeout
unsigned timeout
A timeout value in milliseconds.
Definition: types.h:100
keymaker.h
Build key strings for MSet ordering or collapsing.
Xapian::ValueMapPostingSource::get_description
std::string get_description() const
Return a string describing this object.
Xapian::Utf8Iterator::Utf8Iterator
Utf8Iterator()
Create an iterator which is at the end of its iteration.
Definition: unicode.h:132
Xapian::ValueIterator::skip_to
void skip_to(Xapian::docid docid_or_slot)
Advance the iterator to document id or value slot docid_or_slot.
Xapian::CoordWeight::get_sumextra
double get_sumextra(Xapian::termcount, Xapian::termcount) const
Calculate the term-independent weight component for a document.
Xapian::MSet::~MSet
~MSet()
Destructor.
Xapian::LatLongCoord::unserialise
void unserialise(const std::string &serialised)
Unserialise a string and set this object to its coordinate.
Xapian::ValueSetMatchDecider::operator()
bool operator()(const Xapian::Document &doc) const
Decide whether we want a particular document to be in the MSet.
Xapian::Document::operator=
void operator=(const Document &other)
Assignment is allowed.
Xapian::RangeProcessor::str
std::string str
The prefix (or suffix with RP_SUFFIX) string to look for.
Definition: queryparser.h:148
Xapian::LMWeight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::Registry::operator=
Registry & operator=(const Registry &other)
Assignment operator.
Xapian::NumberValueRangeProcessor::NumberValueRangeProcessor
NumberValueRangeProcessor(Xapian::valueno slot_, const std::string &str_, bool prefix_=true)
Constructor.
Definition: queryparser.h:695
Xapian::RangeProcessor::release
const RangeProcessor * release() const
Start reference counting this object.
Definition: queryparser.h:235
Xapian::Document::termlist_begin
TermIterator termlist_begin() const
Iterator for the terms in this document.
Xapian::ExpandDecider::ExpandDecider
ExpandDecider()
Default constructor.
Definition: expanddecider.h:47
valueiterator.h
Class for iterating over document values.
Xapian::Database::get_termfreq
Xapian::doccount get_termfreq(const std::string &tname) const
Get the number of documents in the database indexed by a given term.
Xapian::TermGenerator::TermGenerator
TermGenerator(const TermGenerator &o)
Copy constructor.
Xapian::Database::get_document
Xapian::Document get_document(Xapian::docid did, unsigned flags) const
Get a document from the database, given its document id.
Xapian::LatLongCoordsIterator::operator*
const LatLongCoord & operator*() const
Get the LatLongCoord for the current position.
Definition: geospatial.h:181
Xapian::rev
XAPIAN_REVISION_TYPE rev
Revision number of a database.
Definition: types.h:133
Xapian::CoordWeight::init
void init(double factor_)
Allow the subclass to perform any initialisation it needs to.
Xapian::Utf8Iterator::iterator_category
std::input_iterator_tag iterator_category
We implement the semantics of an STL input_iterator.
Definition: unicode.h:204
Xapian::Unicode::to_utf8
unsigned to_utf8(unsigned ch, char *buf)
Convert a single Unicode character to UTF-8.
Definition: unicode.h:321
queryparser.h
parsing a user query string to build a Xapian::Query object
Xapian::WritableDatabase::begin_transaction
void begin_transaction(bool flushed=true)
Begin a transaction.
Xapian::KeyMaker::release
const KeyMaker * release() const
Start reference counting this object.
Definition: keymaker.h:83
Xapian::ValueCountMatchSpy::merge_results
virtual void merge_results(const std::string &serialised)
Unserialise some results, and merge them into this matchspy.
Xapian::ValueCountMatchSpy::name
virtual std::string name() const
Return the name of this match spy.
Xapian::ValueWeightPostingSource::unserialise
ValueWeightPostingSource * unserialise(const std::string &serialised) const
Create object given string serialisation returned by serialise().
Xapian::weight
double weight
The weight of a document or term.
Definition: types.h:122
Xapian::BM25Weight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
dbfactory.h
Factory functions for constructing Database and WritableDatabase objects.
Xapian::MSet::MSet
MSet()
Default constructor.
Xapian::NetworkTimeoutError::NetworkTimeoutError
NetworkTimeoutError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:861
Xapian::TermGenerator::set_stopper
void set_stopper(const Xapian::Stopper *stop=NULL)
Set the Xapian::Stopper object to be used for identifying stopwords.
Xapian::DatabaseCreateError
DatabaseCreateError indicates a failure to create a database.
Definition: error.h:451
Xapian::Query::WILDCARD_LIMIT_FIRST
@ WILDCARD_LIMIT_FIRST
Stop expanding when OP_WILDCARD reaches its expansion limit.
Definition: query.h:288
Xapian::QueryParser::stem_strategy
stem_strategy
Stemming strategies, for use with set_stemming_strategy().
Definition: queryparser.h:891
Xapian::ValuePostingSource
A posting source which generates weights from a value slot.
Definition: postingsource.h:401
Xapian::DB_FULL_SYNC
const int DB_FULL_SYNC
Try to ensure changes are really written to disk.
Definition: constants.h:83
document.h
API for working with documents.
Xapian::ESet::empty
bool empty() const
Return true if this ESet object is empty.
Definition: eset.h:85
Xapian::Database::get_document
Xapian::Document get_document(Xapian::docid did) const
Get a document from the database, given its document id.
Xapian::Query::Query
Query(Query::op op_)
Construct with just an operator.
Definition: query.h:598
Xapian::ValueWeightPostingSource
A posting source which reads weights from a value slot.
Definition: postingsource.h:587
Xapian::TermIterator::operator=
TermIterator & operator=(const TermIterator &o)
Assignment.
Xapian::MatchSpy::name
virtual std::string name() const
Return the name of this match spy.
Xapian::Unicode::OPEN_PUNCTUATION
@ OPEN_PUNCTUATION
Punctuation, open (Ps)
Definition: unicode.h:242
Xapian::DecreasingValueWeightPostingSource::curr_weight
double curr_weight
Weight at current position.
Definition: postingsource.h:641
Xapian::GreatCircleMetric::GreatCircleMetric
GreatCircleMetric(double radius_)
Construct a GreatCircleMetric using a specified radius.
Xapian::Database::get_metadata
std::string get_metadata(const std::string &key) const
Get the user-specified metadata associated with a given key.
Xapian::Document::get_docid
docid get_docid() const
Get the document id which is associated with this document (if any).
weight.h
Weighting scheme API.
Xapian::Registry::get_match_spy
const Xapian::MatchSpy * get_match_spy(const std::string &name) const
Get a match spy given a name.
Xapian::MSetIterator::get_percent
int get_percent() const
Convert the weight of the current iterator position to a percentage.
Definition: mset.h:514
Xapian::Enquire::get_mset
MSet get_mset(Xapian::doccount first, Xapian::doccount maxitems, Xapian::doccount checkatleast=0, const RSet *omrset=0, const MatchDecider *mdecider=0) const
Get (a portion of) the match set for the current query.
Xapian::Utf8Iterator::Utf8Iterator
Utf8Iterator(const char *p_, size_t len)
Create an iterator given a pointer and a length.
Definition: unicode.h:114
XAPIAN_DOCID_BASE_TYPE
#define XAPIAN_DOCID_BASE_TYPE
Base (signed) type for Xapian::docid and related types.
Definition: version.h:71
Xapian::PostingSource::get_termfreq_est
virtual Xapian::doccount get_termfreq_est() const =0
An estimate of the number of documents this object can return.
Xapian::Unicode::toupper
unsigned toupper(unsigned ch)
Convert a Unicode character to uppercase.
Definition: unicode.h:384
Xapian::TermGenerator::set_stemmer
void set_stemmer(const Xapian::Stem &stemmer)
Set the Xapian::Stem object to be used for generating stemmed terms.
Xapian::Database::get_doclength_upper_bound
Xapian::termcount get_doclength_upper_bound() const
Get an upper bound on the length of a document in this DB.
Xapian::DocNotFoundError
Indicates an attempt to access a document not present in the database.
Definition: error.h:674
Xapian::minor_version
int minor_version()
Report the minor version of the library which the program is linked with.
Definition: xapian.h:133
Xapian::BoolWeight
Class implementing a "boolean" weighting scheme.
Definition: weight.h:400
Xapian::StringValueRangeProcessor::valno
Xapian::valueno valno
The value slot to process.
Definition: queryparser.h:461
Xapian::DateRangeProcessor::operator()
Xapian::Query operator()(const std::string &begin, const std::string &end)
Check for a valid date range.
Xapian::MSetIterator::get_collapse_key
std::string get_collapse_key() const
Return the collapse key for the current position.
Xapian::Database::metadata_keys_end
Xapian::TermIterator metadata_keys_end(const std::string &=std::string()) const
Corresponding end iterator to metadata_keys_begin().
Definition: database.h:506
Xapian::WritableDatabase::replace_document
void replace_document(Xapian::docid did, const Xapian::Document &document)
Replace a given document in the database.
Xapian::PL2Weight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::DecreasingValueWeightPostingSource::items_at_end
bool items_at_end
Flag, set to true if there are docs after the end of the range.
Definition: postingsource.h:644
Xapian::MSet::size
Xapian::doccount size() const
Return number of items in this MSet object.
Xapian::Registry::register_lat_long_metric
void register_lat_long_metric(const Xapian::LatLongMetric &metric)
Register a user-defined lat-long metric class.
Xapian::Unicode::PARAGRAPH_SEPARATOR
@ PARAGRAPH_SEPARATOR
Separator, paragraph (Zp)
Definition: unicode.h:235
Xapian::MSet::begin
MSetIterator begin() const
Return iterator pointing to the first item in this MSet.
Definition: mset.h:607
Xapian::DPHWeight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::Document::get_description
std::string get_description() const
Return a string describing this object.
Xapian::termcount
unsigned XAPIAN_TERMCOUNT_BASE_TYPE termcount
A counts of terms.
Definition: types.h:72
Xapian::FixedWeightPostingSource::next
void next(double min_wt)
Advance the current position to the next matching document.
Xapian::ValueMapPostingSource::clone
ValueMapPostingSource * clone() const
Clone the posting source.
Xapian::Utf8Iterator::Utf8Iterator
Utf8Iterator(const std::string &s)
Create an iterator given a string.
Definition: unicode.h:125
Xapian::Weight::init
virtual void init(double factor)=0
Allow the subclass to perform any initialisation it needs to.
Xapian::DatabaseOpeningError::DatabaseOpeningError
DatabaseOpeningError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:605
Xapian::Utf8Iterator::assign
void assign(const char *p_, size_t len)
Assign a new string to the iterator.
Definition: unicode.h:72
Xapian::PositionIterator
Class for iterating over term positions.
Definition: positioniterator.h:40
Xapian::LatLongDistancePostingSource::init
void init(const Database &db_)
Set this PostingSource to the start of the list of postings.
Xapian::LatLongCoords::LatLongCoords
LatLongCoords(const LatLongCoord &coord)
Construct a container holding one coordinate.
Definition: geospatial.h:269
Xapian::MSetIterator::get_weight
double get_weight() const
Get the weight for the current position.
Xapian::MSetIterator::operator++
MSetIterator operator++(int)
Advance the iterator to the next position (postfix version).
Definition: mset.h:381
Xapian::IneB2Weight::unserialise
IneB2Weight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::PostingSource::unserialise
virtual PostingSource * unserialise(const std::string &serialised) const
Create object given string serialisation returned by serialise().
Xapian::operator>=
bool operator>=(const ESetIterator &a, const ESetIterator &b)
Inequality test for ESetIterator objects.
Definition: eset.h:317
Xapian::Database::positionlist_end
PositionIterator positionlist_end(Xapian::docid, const std::string &) const
Corresponding end iterator to positionlist_begin().
Definition: database.h:252
Xapian::Query::op
op
Query operators.
Definition: query.h:78
Xapian::LatLongCoord::serialise
std::string serialise() const
Return a serialised representation of the coordinate.
Xapian::InL2Weight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
Xapian::DatabaseVersionError::DatabaseVersionError
DatabaseVersionError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:656
Xapian::LatLongCoords::begin
LatLongCoordsIterator begin() const
Get a begin iterator for the coordinates.
Definition: geospatial.h:238
Xapian::Weight::get_total_length
Xapian::totallength get_total_length() const
Total length of all documents in the collection.
Definition: weight.h:391
Xapian::MSetIterator::operator-
difference_type operator-(const MSetIterator &o) const
Return the number of positions between o and this iterator.
Definition: mset.h:452
Xapian::Weight::get_maxextra
virtual double get_maxextra() const =0
Return an upper bound on what get_sumextra() can return for any document.
Xapian::Document::add_value
void add_value(Xapian::valueno slot, const std::string &value)
Add a new value.
Xapian::LatLongCoords::append
void append(const LatLongCoord &coord)
Append a coordinate to the end of the sequence.
Definition: geospatial.h:260
Xapian::IfB2Weight
This class implements the IfB2 weighting scheme.
Definition: weight.h:887
Xapian::PostingIterator::get_doclength
Xapian::termcount get_doclength() const
Return the length of the document at the current position.
Xapian::ESetIterator::operator-=
ESetIterator & operator-=(difference_type n)
Move the iterator back by n positions.
Definition: eset.h:239
Xapian::DOC_ASSUME_VALID
const int DOC_ASSUME_VALID
Assume document id is valid.
Definition: constants.h:280
Xapian::CoordWeight
Xapian::Weight subclass implementing Coordinate Matching.
Definition: weight.h:1487
Xapian::TermGenerator::operator=
TermGenerator & operator=(const TermGenerator &o)
Assignment.
Xapian::PostingSource::PostingSource
PostingSource()
Allow subclasses to be instantiated.
Definition: postingsource.h:67
Xapian::Document::remove_postings
Xapian::termpos remove_postings(const std::string &term, Xapian::termpos term_pos_first, Xapian::termpos term_pos_last, Xapian::termcount wdf_dec=1)
Remove a range of postings for a term.
Xapian::GreatCircleMetric::unserialise
LatLongMetric * unserialise(const std::string &serialised) const
Create object given string serialisation returned by serialise().
Xapian::QueryParser
Build a Xapian::Query object from a user query string.
Definition: queryparser.h:770
Xapian::MSetIterator::get_rank
Xapian::doccount get_rank() const
Return the MSet rank for the current position.
Definition: mset.h:460
Xapian::PostingSource::set_maxweight
void set_maxweight(double max_weight)
Specify an upper bound on what get_weight() will return from now on.
Xapian::WritableDatabase::flush
void flush()
Pre-1.1.0 name for commit().
Definition: database.h:925
Xapian::Registry::register_match_spy
void register_match_spy(const Xapian::MatchSpy &spy)
Register a user-defined match spy class.
Xapian::Database::check
static size_t check(const std::string &path, int opts=0, std::ostream *out=NULL)
Check the integrity of a database or database table.
Definition: database.h:560
Xapian::Database::check
static size_t check(int fd, int opts=0, std::ostream *out=NULL)
Check the integrity of a single file database.
Definition: database.h:575
Xapian::LMWeight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount) const
Calculate the term-independent weight component for a document.
Xapian::Unicode::CONNECTOR_PUNCTUATION
@ CONNECTOR_PUNCTUATION
Punctuation, connector (Pc)
Definition: unicode.h:240
Xapian::Unicode::CLOSE_PUNCTUATION
@ CLOSE_PUNCTUATION
Punctuation, close (Pe)
Definition: unicode.h:243
Xapian::PL2PlusWeight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::Stem::Stem
Stem(StemImplementation *p)
Construct a Xapian::Stem object with a user-provided stemming algorithm.
Xapian::LatLongCoordsIterator::operator++
LatLongCoordsIterator & operator++()
Advance the iterator to the next position.
Definition: geospatial.h:186
Xapian::DLHWeight
This class implements the DLH weighting scheme, which is a representative scheme of the Divergence fr...
Definition: weight.h:1108
Xapian::BM25PlusWeight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::DPHWeight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::TermIterator::get_wdf
Xapian::termcount get_wdf() const
Return the wdf for the term at the current position.
Xapian::Query::OP_OR
@ OP_OR
Match documents which at least one subquery matches.
Definition: query.h:92
Xapian::SimpleStopper::SimpleStopper
SimpleStopper()
Default constructor.
Definition: queryparser.h:101
Xapian::ValueMapPostingSource::unserialise
ValueMapPostingSource * unserialise(const std::string &serialised) const
Create object given string serialisation returned by serialise().
Xapian::CoordWeight::CoordWeight
CoordWeight()
Construct a CoordWeight.
Definition: weight.h:1497
Xapian::Unicode::MODIFIER_LETTER
@ MODIFIER_LETTER
Letter, modifier (Lm)
Definition: unicode.h:225
Xapian::Database::termlist_begin
TermIterator termlist_begin(Xapian::docid did) const
An iterator pointing to the start of the termlist for a given document.
Xapian::DB_CREATE
const int DB_CREATE
Create a new database.
Definition: constants.h:44
Xapian::IneB2Weight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the weight contribution for this object's term to a document.
Xapian::Database::valuestream_end
ValueIterator valuestream_end(Xapian::valueno) const
Return end iterator corresponding to valuestream_begin().
Definition: database.h:359
Xapian::Query::operator/=
const Query operator/=(double factor)
Inverse scale using OP_SCALE_WEIGHT.
Definition: query.h:587
Xapian::Registry::Registry
Registry()
Default constructor.
Xapian::BB2Weight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
expanddecider.h
Allow rejection of terms during ESet generation.
Xapian::InL2Weight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::TradWeight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::PositionIterator::operator*
Xapian::termpos operator*() const
Return the term position at the current iterator position.
Xapian::LatLongMetric::operator()
double operator()(const LatLongCoords &a, const LatLongCoords &b) const
Return the distance between two coordinate lists, in metres.
Xapian::Enquire::get_matching_terms_end
TermIterator get_matching_terms_end(const MSetIterator &) const
End iterator corresponding to get_matching_terms_begin()
Definition: enquire.h:742
Xapian::Weight::get_collection_size
Xapian::doccount get_collection_size() const
The number of documents in the collection.
Definition: weight.h:341
Xapian::DecreasingValueWeightPostingSource::check
bool check(Xapian::docid min_docid, double min_wt)
Check if the specified docid occurs.
Xapian::ESet::~ESet
~ESet()
Destructor.
Xapian::InvalidArgumentError
InvalidArgumentError indicates an invalid parameter value was passed to the API.
Definition: error.h:241
Xapian::Query::Query
Query(const std::string &term, Xapian::termcount wqf=1, Xapian::termpos pos=0)
Construct a Query object for a term.
Xapian::TermGenerator::set_termpos
void set_termpos(Xapian::termpos termpos)
Set the current term position.
Xapian::TfIdfWeight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::ValuePostingSource::get_termfreq_max
Xapian::doccount get_termfreq_max() const
An upper bound on the number of documents this object can return.
query.h
Xapian::Query API class.
Xapian::BM25PlusWeight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
stem.h
stemming algorithms
Xapian::Enquire::Enquire
Enquire(const Enquire &other)
Copying is allowed (and is cheap).
Xapian::WritableDatabase::delete_document
void delete_document(const std::string &unique_term)
Delete any documents indexed by a term from the database.
Xapian::Unicode::nonascii_to_utf8
unsigned nonascii_to_utf8(unsigned ch, char *buf)
Convert a single non-ASCII Unicode character to UTF-8.
version.h
Define preprocessor symbols for the library version.
Xapian::Query::get_num_subqueries
size_t get_num_subqueries() const
Get the number of subqueries of the top level query.
Xapian::DatabaseOpeningError
DatabaseOpeningError indicates failure to open a database.
Definition: error.h:581
Xapian::Database::Database
Database(const std::string &path, int flags=0)
Open a Database, automatically determining the database backend to use.
Xapian::ValueSetMatchDecider
MatchDecider filtering results based on whether document values are in a user-defined set.
Definition: valuesetmatchdecider.h:44
Xapian::DB_OPEN
const int DB_OPEN
Open an existing database.
Definition: constants.h:50
Xapian::BoolWeight::BoolWeight
BoolWeight()
Construct a BoolWeight.
Definition: weight.h:407
Xapian::IfB2Weight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::DB_CREATE_OR_OPEN
const int DB_CREATE_OR_OPEN
Create database if it doesn't already exist.
Definition: constants.h:35
Xapian::DecreasingValueWeightPostingSource::DecreasingValueWeightPostingSource
DecreasingValueWeightPostingSource(Xapian::valueno slot_, Xapian::docid range_start_=0, Xapian::docid range_end_=0)
Construct a DecreasingValueWeightPostingSource.
Xapian::valueno_diff
int valueno_diff
A signed difference between two value slot numbers.
Definition: types.h:115
Xapian::ESetIterator::operator++
ESetIterator & operator++()
Advance the iterator to the next position.
Definition: eset.h:184
Xapian::DatabaseNotFoundError
Indicates an attempt to access a database not present.
Definition: error.h:1055
Xapian::GreatCircleMetric::serialise
std::string serialise() const
Serialise object parameters into a string.
Xapian::TermIterator::positionlist_begin
PositionIterator positionlist_begin() const
Return a PositionIterator for the current term.
Xapian::Stem::Stem
Stem()
Construct a Xapian::Stem object which doesn't change terms.
Xapian::Database::close
virtual void close()
Close the database.
Xapian::Unicode::CONTROL
@ CONTROL
Other, control (Cc)
Definition: unicode.h:236
Xapian::ValueCountMatchSpy::ValueCountMatchSpy
ValueCountMatchSpy()
Construct an empty ValueCountMatchSpy.
Definition: matchspy.h:234
Xapian::ValueMapPostingSource::name
std::string name() const
Name of the posting source class.
Xapian::InternalError::InternalError
InternalError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:777
Xapian::MultiValueKeyMaker
KeyMaker subclass which combines several values.
Definition: keymaker.h:104
Xapian::LatLongMetric
Base class for calculating distances between two lat/long coordinates.
Definition: geospatial.h:303
Xapian::FixedWeightPostingSource
A posting source which returns a fixed weight for all documents.
Definition: postingsource.h:735
Xapian::ExpandDecider::release
ExpandDecider * release()
Start reference counting this object.
Definition: expanddecider.h:65
Xapian::Stopper
Base class for stop-word decision functor.
Definition: queryparser.h:47
Xapian::KeyMaker::operator()
virtual std::string operator()(const Xapian::Document &doc) const =0
Build a key string for a Document.
Xapian::Compactor::set_block_size
void set_block_size(size_t block_size)
Set the block size to use for tables in the output database.
Xapian::QueryParser::operator=
QueryParser & operator=(const QueryParser &o)
Assignment.
Xapian::Weight::serialise
virtual std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::Unicode::UNASSIGNED
@ UNASSIGNED
Other, not assigned (Cn)
Definition: unicode.h:221
Xapian::SerialisationError::SerialisationError
SerialisationError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:953
Xapian::Database::compact
void compact(const std::string &output, unsigned flags, int block_size, Xapian::Compactor &compactor)
Produce a compact version of this database.
Definition: database.h:719
Xapian::ValueWeightPostingSource::get_description
std::string get_description() const
Return a string describing this object.
Xapian::Unicode::COMBINING_SPACING_MARK
@ COMBINING_SPACING_MARK
Mark, spacing combining (Mc)
Definition: unicode.h:229
Xapian::Chert::open
Database open(const std::string &dir)
Construct a Database object for read-only access to a Chert database.
Definition: dbfactory.h:123
Xapian::LMWeight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::PL2PlusWeight::PL2PlusWeight
PL2PlusWeight(double c, double delta)
Construct a PL2PlusWeight.
Xapian::Document::~Document
~Document()
Destructor.
Xapian::operator&
const Query operator&(const Query &a, const Query &b)
Combine two Xapian::Query objects using OP_AND.
Definition: query.h:636
Xapian::TermGenerator::index_text
void index_text(const Xapian::Utf8Iterator &itor, Xapian::termcount wdf_inc=1, const std::string &prefix=std::string())
Index some text.
Xapian::FixedWeightPostingSource::clone
FixedWeightPostingSource * clone() const
Clone the posting source.
Xapian::WritableDatabase::WritableDatabase
WritableDatabase(const std::string &path, int flags=0, int block_size=0)
Open a database for update, automatically determining the database backend to use.
Xapian::SimpleStopper::add
void add(const std::string &word)
Add a single stop word.
Definition: queryparser.h:116
Xapian::FieldProcessor::operator()
virtual Xapian::Query operator()(const std::string &str)=0
Convert a field-prefixed string to a Query object.
Xapian::ESet::get_description
std::string get_description() const
Return a string describing this object.
Xapian::Stopper::release
const Stopper * release() const
Start reference counting this object.
Definition: queryparser.h:89
Xapian::MSetIterator::operator--
MSetIterator & operator--()
Move the iterator to the previous position.
Definition: mset.h:388
Xapian::CoordWeight::unserialise
CoordWeight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::ValueWeightPostingSource::serialise
std::string serialise() const
Serialise object parameters into a string.
Xapian::BB2Weight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the weight contribution for this object's term to a document.
Xapian::Database::synonym_keys_end
Xapian::TermIterator synonym_keys_end(const std::string &=std::string()) const
Corresponding end iterator to synonym_keys_begin(prefix).
Definition: database.h:455
Xapian::Error::get_error_string
const char * get_error_string() const
Returns any system error string associated with this exception.
Xapian::PostingIterator::operator=
PostingIterator & operator=(const PostingIterator &o)
Assignment.
Xapian::Enquire::get_eset
ESet get_eset(Xapian::termcount maxitems, const RSet &omrset, int flags=0, const Xapian::ExpandDecider *edecider=0, double min_wt=0.0) const
Get the expand set for the given rset.
Xapian::ValuePostingSource::get_database
Xapian::Database get_database() const
The database we're reading values from.
Definition: postingsource.h:502
Xapian::StringValueRangeProcessor
Handle a string range.
Definition: queryparser.h:458
Xapian::ValueCountMatchSpy::serialise_results
virtual std::string serialise_results() const
Serialise the results of this match spy.
Xapian::FixedWeightPostingSource::get_docid
Xapian::docid get_docid() const
Return the current docid.
Xapian::FixedWeightPostingSource::get_termfreq_min
Xapian::doccount get_termfreq_min() const
A lower bound on the number of documents this object can return.
Xapian::MatchDecider::MatchDecider
MatchDecider()
Default constructor.
Definition: enquire.h:127
Xapian::Weight::get_termfreq
Xapian::doccount get_termfreq() const
The number of documents which this term indexes.
Definition: weight.h:350
Xapian::TradWeight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::Database::get_lastdocid
Xapian::docid get_lastdocid() const
Get the highest document id which has been used in the database.
Xapian::ValueIterator::ValueIterator
ValueIterator(const ValueIterator &o)
Copy constructor.
Xapian::WritableDatabase::replace_document
Xapian::docid replace_document(const std::string &unique_term, const Xapian::Document &document)
Replace any documents matching a term.
Xapian::RangeProcessor::RangeProcessor
RangeProcessor(Xapian::valueno slot_, const std::string &str_=std::string(), unsigned flags_=0)
Constructor.
Definition: queryparser.h:183
eset.h
Class representing a list of query expansion terms.
Xapian::operator==
bool operator==(const ESetIterator &a, const ESetIterator &b)
Equality test for ESetIterator objects.
Definition: eset.h:277
Xapian::TfIdfWeight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::NumberValueRangeProcessor::NumberValueRangeProcessor
NumberValueRangeProcessor(Xapian::valueno slot_)
Constructor.
Definition: queryparser.h:660
Xapian::Query::operator=
Query & operator=(const Query &o)
Copying is allowed.
Definition: query.h:325
Xapian::Auto::open_stub
Database open_stub(const std::string &file)
Construct a Database object for a stub database file.
Definition: dbfactory.h:61
Xapian::SimpleStopper::operator()
virtual bool operator()(const std::string &term) const
Is term a stop-word?
Definition: queryparser.h:118
Xapian::DatabaseNotFoundError::DatabaseNotFoundError
DatabaseNotFoundError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:1079
Xapian::Database::get_value_lower_bound
std::string get_value_lower_bound(Xapian::valueno slot) const
Get a lower bound on the values stored in the given value slot.
Xapian::ESetIterator::operator-
difference_type operator-(const ESetIterator &o) const
Return the number of positions between o and this iterator.
Definition: eset.h:261
Xapian::GreatCircleMetric::pointwise_distance
double pointwise_distance(const LatLongCoord &a, const LatLongCoord &b) const
Return the great-circle distance between points on the sphere.
Xapian::FieldProcessor::~FieldProcessor
virtual ~FieldProcessor()
Destructor.
Xapian::Query::get_type
op get_type() const
Get the type of the top level of the query.
Xapian::Query::operator^=
const Query operator^=(const Query &o)
Combine with another Xapian::Query object using OP_XOR.
Definition: query.h:819
Xapian::KeyMaker
Virtual base class for key making functors.
Definition: keymaker.h:42
Xapian::Enquire::get_description
std::string get_description() const
Return a string describing this object.
Xapian::ExpandDeciderAnd::operator()
virtual bool operator()(const std::string &term) const
Do we want this term in the ESet?
Xapian::DecreasingValueWeightPostingSource::init
void init(const Xapian::Database &db_)
Set this PostingSource to the start of the list of postings.
Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker
LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoords &centre_, const LatLongMetric &metric_, double defdistance)
Construct a LatLongDistanceKeyMaker.
Definition: geospatial.h:574
Xapian::TermGenerator::index_text_without_positions
void index_text_without_positions(const Xapian::Utf8Iterator &itor, Xapian::termcount wdf_inc=1, const std::string &prefix=std::string())
Index some text without positional information.
Xapian::InternalError
InternalError indicates a runtime problem of some sort.
Definition: error.h:761
Xapian::ValueRangeProcessor::ValueRangeProcessor
ValueRangeProcessor()
Default constructor.
Definition: queryparser.h:406
Xapian::InL2Weight::unserialise
InL2Weight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::DBCOMPACT_NO_RENUMBER
const int DBCOMPACT_NO_RENUMBER
Use the same document ids in the output as in the input(s).
Definition: constants.h:256
Xapian::FixedWeightPostingSource::get_termfreq_max
Xapian::doccount get_termfreq_max() const
An upper bound on the number of documents this object can return.
Xapian::StringValueRangeProcessor::operator()
Xapian::valueno operator()(std::string &begin, std::string &end)
Check for a valid string range.
Xapian::ESet::size
Xapian::doccount size() const
Return number of items in this ESet object.
Xapian::DPHWeight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
Xapian::SimpleStopper::SimpleStopper
SimpleStopper(Iterator begin, Iterator end)
Initialise from a pair of iterators.
Definition: queryparser.h:113
Xapian::MSet::operator=
MSet & operator=(const MSet &o)
Copying is allowed.
Xapian::TradWeight::TradWeight
TradWeight(double k=1.0)
Construct a TradWeight.
Definition: weight.h:768
Xapian::Unicode::category
category
Each Unicode character is in exactly one of these categories.
Definition: unicode.h:220
Xapian::ValueSetMatchDecider::add_value
void add_value(const std::string &value)
Add a value to the test set.
Definition: valuesetmatchdecider.h:75
Xapian::TermIterator::get_termfreq
Xapian::doccount get_termfreq() const
Return the term frequency for the term at the current position.
Xapian::Stem::is_none
bool is_none() const
Return true if this is a no-op stemmer.
Definition: stem.h:166
Xapian::Database::reopen
bool reopen()
Re-open the database.
Xapian::Query::Query
Query(op op_, const Xapian::Query &a, const Xapian::Query &b)
Construct a Query object by combining two others.
Definition: query.h:375
Xapian::WritableDatabase::~WritableDatabase
virtual ~WritableDatabase()
Destroy this handle on the database.
Xapian::LMWeight::LMWeight
LMWeight(double param_log_=0.0, type_smoothing select_smoothing_=TWO_STAGE_SMOOTHING, double param_smoothing1_=-1.0, double param_smoothing2_=-1.0)
Construct a LMWeight.
Definition: weight.h:1439
Xapian::PostingSource::name
virtual std::string name() const
Name of the posting source class.
Xapian::Database::has_positions
bool has_positions() const
Does this database have any positional information?
Xapian::PostingSource::release
const PostingSource * release() const
Start reference counting this object.
Definition: postingsource.h:384
Xapian::Unicode::OTHER_NUMBER
@ OTHER_NUMBER
Number, other (No)
Definition: unicode.h:232
Xapian::Query::MatchAll
static const Xapian::Query MatchAll
A query matching all documents.
Definition: query.h:75
Xapian::ESet
Class representing a list of search results.
Definition: eset.h:43
Xapian::PostingIterator::PostingIterator
PostingIterator()
Default constructor.
Definition: postingiterator.h:80
Xapian::Enquire::Enquire
Enquire(const Database &database)
Create a Xapian::Enquire object.
Xapian::MSet::get_matches_lower_bound
Xapian::doccount get_matches_lower_bound() const
Lower bound on the total number of matching documents.
Xapian::Weight::get_wqf
Xapian::termcount get_wqf() const
The within-query-frequency of this term.
Definition: weight.h:362
Xapian::Enquire::get_matching_terms_begin
TermIterator get_matching_terms_begin(Xapian::docid did) const
Get terms which match a given document, by document id.
Xapian::FieldProcessor::release
FieldProcessor * release()
Start reference counting this object.
Definition: queryparser.h:751
Xapian::InvalidOperationError::InvalidOperationError
InvalidOperationError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:299
Xapian::ValueWeightPostingSource::name
std::string name() const
Name of the posting source class.
Xapian::Unicode::is_currency
bool is_currency(unsigned ch)
Test if a given Unicode character is a currency symbol.
Definition: unicode.h:371
Xapian::RSet::RSet
RSet()
Default constructor.
Xapian::MSet::get_matches_estimated
Xapian::doccount get_matches_estimated() const
Estimate of the total number of matching documents.
Xapian::Query::get_terms_end
const TermIterator get_terms_end() const
End iterator for terms in the query object.
Definition: query.h:493
Xapian::IfB2Weight::unserialise
IfB2Weight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::ExpandDeciderFilterTerms::operator()
virtual bool operator()(const std::string &term) const
Do we want this term in the ESet?
Xapian::WritableDatabase::set_metadata
void set_metadata(const std::string &key, const std::string &metadata)
Set the user-specified metadata associated with a given key.
Xapian::MSetIterator::operator+=
MSetIterator & operator+=(difference_type n)
Move the iterator forwards by n positions.
Definition: mset.h:424
Xapian::MSet::get_max_possible
double get_max_possible() const
The maximum possible weight any document could achieve.
Xapian::DecreasingValueWeightPostingSource::serialise
std::string serialise() const
Serialise object parameters into a string.
Xapian::BB2Weight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::Stopper::release
Stopper * release()
Start reference counting this object.
Definition: queryparser.h:77
Xapian::Compactor::set_compaction_level
void set_compaction_level(compaction_level compaction)
Set the compaction level.
Definition: compactor.h:116
Xapian::KeyMaker::release
KeyMaker * release()
Start reference counting this object.
Definition: keymaker.h:71
Xapian::Query::Query
Query(op op_, const Xapian::Query &subquery, double factor)
Scale using OP_SCALE_WEIGHT.
Xapian::Unicode::OTHER_LETTER
@ OTHER_LETTER
Letter, other (Lo)
Definition: unicode.h:226
Xapian::MSetIterator::get_sort_key
std::string get_sort_key() const
Return the sort key for the current position.
Xapian::TermIterator::positionlist_count
Xapian::termcount positionlist_count() const
Return the length of the position list for the current position.
Xapian::TermGenerator::set_stopper_strategy
void set_stopper_strategy(stop_strategy strategy)
Set the stopper strategy.
Xapian::DB_BACKEND_GLASS
const int DB_BACKEND_GLASS
Use the glass backend.
Definition: constants.h:158
Xapian::Query::OP_AND
@ OP_AND
Match only documents which all subqueries match.
Definition: query.h:84
Xapian::ExpandDeciderFilterTerms::ExpandDeciderFilterTerms
ExpandDeciderFilterTerms(Iterator reject_begin, Iterator reject_end)
The two iterators specify a list of terms to be rejected.
Definition: expanddecider.h:132
Xapian::WritableDatabase::clear_synonyms
void clear_synonyms(const std::string &term) const
Remove all synonyms for a term.
Xapian::PL2PlusWeight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::ESet::swap
void swap(ESet &o)
Efficiently swap this ESet object with another.
Definition: eset.h:95
Xapian::FixedWeightPostingSource::FixedWeightPostingSource
FixedWeightPostingSource(double wt)
Construct a FixedWeightPostingSource.
Xapian::ValueRangeProcessor::release
ValueRangeProcessor * release()
Start reference counting this object.
Definition: queryparser.h:434
Xapian::Remote::open
Database open(const std::string &host, unsigned int port, useconds_t timeout=10000, useconds_t connect_timeout=10000)
Construct a Database object for read-only access to a remote database accessed via a TCP connection.
Xapian::doccount_diff
XAPIAN_DOCID_BASE_TYPE doccount_diff
A signed difference between two counts of documents.
Definition: types.h:45
Xapian::Query::Query
Query()
Construct a query matching no documents.
Definition: query.h:310
Xapian::BoolWeight::unserialise
BoolWeight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::Utf8Iterator::raw
const char * raw() const
Return the raw const char* pointer for the current position.
Definition: unicode.h:54
Xapian::RSet::size
Xapian::doccount size() const
The number of documents in this R-Set.
Xapian::Document::get_value
std::string get_value(Xapian::valueno slot) const
Get value by number.
Xapian::InvalidOperationError::InvalidOperationError
InvalidOperationError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:307
Xapian::TermIterator::operator*
std::string operator*() const
Return the term at the current position.
Xapian::Database::allterms_begin
TermIterator allterms_begin(const std::string &prefix=std::string()) const
An iterator which runs across all terms with a given prefix.
Xapian::Enquire
This class provides an interface to the information retrieval system for the purpose of searching.
Definition: enquire.h:152
Xapian::DecreasingValueWeightPostingSource::range_end
Xapian::docid range_end
End of range of docids for which weights are known to be decreasing.
Definition: postingsource.h:638
Xapian::Database::termlist_end
TermIterator termlist_end(Xapian::docid) const
Corresponding end iterator to termlist_begin().
Definition: database.h:238
Xapian::Query::OP_INVALID
@ OP_INVALID
Construct an invalid query.
Definition: query.h:254
Xapian::Unicode::append_utf8
void append_utf8(std::string &s, unsigned ch)
Append the UTF-8 representation of a single Unicode character to a std::string.
Definition: unicode.h:332
Xapian::Document::remove_term
void remove_term(const std::string &tname)
Remove a term and all postings associated with it.
Xapian::CoordWeight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterm) const
Calculate the weight contribution for this object's term to a document.
Xapian::PL2Weight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::Stopper::operator()
virtual bool operator()(const std::string &term) const =0
Is term a stop-word?
Xapian::DLHWeight::unserialise
DLHWeight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::KeyMaker::~KeyMaker
virtual ~KeyMaker()
Virtual destructor, because we have virtual methods.
Xapian::totallength
XAPIAN_TOTALLENGTH_TYPE totallength
The total length of all documents in a database.
Definition: types.h:139
Xapian::ESet::end
ESetIterator end() const
Return iterator pointing to just after the last item in this ESet.
Definition: eset.h:350
Xapian::PostingSource::at_end
virtual bool at_end() const =0
Return true if the current position is past the last entry in this list.
Xapian::DecreasingValueWeightPostingSource::skip_to
void skip_to(Xapian::docid min_docid, double min_wt)
Advance to the specified docid.
Xapian::Registry::register_weighting_scheme
void register_weighting_scheme(const Xapian::Weight &wt)
Register a weighting scheme.
Xapian::Database::add_database
void add_database(const Database &database)
Add an existing database (or group of databases) to those accessed by this object.
Xapian::Query::OP_XOR
@ OP_XOR
Match documents which an odd number of subqueries match.
Definition: query.h:107
Xapian::ValueCountMatchSpy::top_values_begin
TermIterator top_values_begin(size_t maxvalues) const
Get an iterator over the most frequent values seen in the slot.
Xapian::ValueMapPostingSource::clear_mappings
void clear_mappings()
Clear all mappings.
Xapian::ValueSetMatchDecider::ValueSetMatchDecider
ValueSetMatchDecider(Xapian::valueno slot, bool inclusive_)
Construct a ValueSetMatchDecider.
Definition: valuesetmatchdecider.h:68
Xapian::termcount_diff
XAPIAN_TERMCOUNT_BASE_TYPE termcount_diff
A signed difference between two counts of terms.
Definition: types.h:79
Xapian::AssertionError
AssertionError is thrown if a logical assertion inside Xapian fails.
Definition: error.h:199
Xapian::Unicode::DECIMAL_DIGIT_NUMBER
@ DECIMAL_DIGIT_NUMBER
Number, decimal digit (Nd)
Definition: unicode.h:230
Xapian::termpos_diff
XAPIAN_TERMPOS_BASE_TYPE termpos_diff
A signed difference between two term positions.
Definition: types.h:90
Xapian::Unicode::LOWERCASE_LETTER
@ LOWERCASE_LETTER
Letter, lowercase (Ll)
Definition: unicode.h:223
Xapian::TermGenerator::stop_strategy
stop_strategy
Stopper strategies, for use with set_stopper_strategy().
Definition: termgenerator.h:127
Xapian::TermIterator::skip_to
void skip_to(const std::string &term)
Advance the iterator to term term.
Xapian::DatabaseModifiedError::DatabaseModifiedError
DatabaseModifiedError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:563
Xapian::Query::LEAF_POSTING_SOURCE
@ LEAF_POSTING_SOURCE
Value returned by get_type() for a PostingSource.
Definition: query.h:260
Xapian::ValueWeightPostingSource::clone
ValueWeightPostingSource * clone() const
Clone the posting source.
Xapian::RangeProcessor::operator()
virtual Xapian::Query operator()(const std::string &begin, const std::string &end)
Check for a valid range of this type.
Xapian::Document::unserialise
static Document unserialise(const std::string &serialised)
Unserialise a document from a string produced by serialise().
Xapian::DPHWeight
This class implements the DPH weighting scheme.
Definition: weight.h:1331
Xapian::RSet::add_document
void add_document(const Xapian::MSetIterator &i)
Add a document to the relevance set.
Definition: enquire.h:98
Xapian::Unicode::is_whitespace
bool is_whitespace(unsigned ch)
Test if a given Unicode character is a whitespace character.
Definition: unicode.h:361
Xapian::QueryParser::QueryParser
QueryParser(const QueryParser &o)
Copy constructor.
Xapian::QueryParser::set_database
void set_database(const Database &db)
Specify the database being searched.
Xapian::ValueMapPostingSource::add_mapping
void add_mapping(const std::string &key, double wt)
Add a mapping.
Xapian::FieldProcessor
Base class for field processors.
Definition: queryparser.h:722
Xapian::IfB2Weight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
Xapian::PL2Weight
This class implements the PL2 weighting scheme.
Definition: weight.h:1168
Xapian::Weight::stat_flags
stat_flags
Stats which the weighting scheme can use (see need_stat()).
Definition: weight.h:38
Xapian::PostingIterator::get_unique_terms
Xapian::termcount get_unique_terms() const
Return the number of unique terms in the current document.
Xapian::LatLongMetric::~LatLongMetric
virtual ~LatLongMetric()
Destructor.
Xapian::Enquire::set_time_limit
void set_time_limit(double time_limit)
Set a time limit for the match.
Xapian::Document::remove_value
void remove_value(Xapian::valueno slot)
Remove any value with the given number.
Xapian::operator*
const Query operator*(double factor, const Query &q)
Scale a Xapian::Query object using OP_SCALE_WEIGHT.
Definition: query.h:661
Xapian::InternalError::InternalError
InternalError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:785
Xapian::RSet::add_document
void add_document(Xapian::docid did)
Add a document to the relevance set.
Xapian::Document::values_end
ValueIterator values_end() const
Equivalent end iterator for values_begin().
Definition: document.h:271
matchspy.h
MatchSpy implementation.
Xapian::operator+
ESetIterator operator+(ESetIterator::difference_type n, const ESetIterator &it)
Return ESetIterator it incremented by n positions.
Definition: eset.h:337
Xapian::PositionIterator::get_description
std::string get_description() const
Return a string describing this object.
Xapian::MatchSpy::merge_results
virtual void merge_results(const std::string &serialised)
Unserialise some results, and merge them into this matchspy.
Xapian::Document::add_posting
void add_posting(const std::string &tname, Xapian::termpos tpos, Xapian::termcount wdfinc=1)
Add an occurrence of a term at a particular position.
Xapian::Database::synonym_keys_begin
Xapian::TermIterator synonym_keys_begin(const std::string &prefix=std::string()) const
An iterator which returns all terms which have synonyms.
Xapian::Weight::get_sumextra
virtual double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const =0
Calculate the term-independent weight component for a document.
Xapian::LatLongMetric::unserialise
virtual LatLongMetric * unserialise(const std::string &serialised) const =0
Create object given string serialisation returned by serialise().
Xapian::DatabaseClosedError::DatabaseClosedError
DatabaseClosedError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:1113
Xapian::FixedWeightPostingSource::skip_to
void skip_to(Xapian::docid min_docid, double min_wt)
Advance to the specified docid.
Xapian::DecreasingValueWeightPostingSource::skip_if_in_range
void skip_if_in_range(double min_wt)
Skip the iterator forward if in the decreasing range, and weight is low.
Xapian::Database::get_revision
Xapian::rev get_revision() const
Get the revision of the database.
Xapian::WritableDatabase::add_document
Xapian::docid add_document(const Xapian::Document &document)
Add a new document to the database.
postingiterator.h
Class for iterating over a list of document ids.
Xapian::Utf8Iterator
An iterator which returns Unicode character values from a UTF-8 encoded string.
Definition: unicode.h:38
Xapian::PostingSource::get_termfreq_max
virtual Xapian::doccount get_termfreq_max() const =0
An upper bound on the number of documents this object can return.
Xapian::QueryParserError::QueryParserError
QueryParserError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:903
Xapian::Database::valuestream_begin
ValueIterator valuestream_begin(Xapian::valueno slot) const
Return an iterator over the value in slot slot for each document.
Xapian::Database::Database
Database(const Database &other)
Copying is allowed.
Xapian::WritableDatabase::remove_synonym
void remove_synonym(const std::string &term, const std::string &synonym) const
Remove a synonym for a term.
Xapian::TermGenerator::stem_strategy
stem_strategy
Stemming strategies, for use with set_stemming_strategy().
Definition: termgenerator.h:122
Xapian::ValueMapPostingSource::set_default_weight
void set_default_weight(double wt)
Set a default weight for document values not in the map.
Xapian::Database::compact
void compact(const std::string &output, unsigned flags=0, int block_size=0)
Produce a compact version of this database.
Definition: database.h:623
Xapian::Query::~Query
~Query()
Destructor.
Definition: query.h:313
Xapian::NumberRangeProcessor::operator()
Xapian::Query operator()(const std::string &begin, const std::string &end)
Check for a valid numeric range.
Xapian::PostingSource
Base class which provides an "external" source of postings.
Definition: postingsource.h:48
Xapian::PositionIterator::operator++
PositionIterator & operator++()
Advance the iterator to the next position.
Xapian::DBCHECK_SHOW_FREELIST
const int DBCHECK_SHOW_FREELIST
Show the bitmap for the B-tree.
Definition: constants.h:222
Xapian::LatLongDistancePostingSource::check
bool check(Xapian::docid min_docid, double min_wt)
Check if the specified docid occurs.
Xapian::ValueMapPostingSource::ValueMapPostingSource
ValueMapPostingSource(Xapian::valueno slot_)
Construct a ValueMapPostingSource.
Xapian::ESet::operator=
ESet & operator=(const ESet &o)
Copying is allowed.
Xapian::RangeProcessor
Base class for range processors.
Definition: queryparser.h:133
Xapian::ExpandDeciderFilterPrefix
ExpandDecider subclass which restrict terms to a particular prefix.
Definition: expanddecider.h:143
Xapian::Document::termlist_end
TermIterator termlist_end() const
Equivalent end iterator for termlist_begin().
Definition: document.h:260
Xapian::Database::get_doccount
Xapian::doccount get_doccount() const
Get the number of documents in the database.
Xapian::Query::Query
Query(const Query &o)
Copying is allowed.
Definition: query.h:319
Xapian::Unicode::tolower
unsigned tolower(unsigned ch)
Convert a Unicode character to lowercase.
Definition: unicode.h:376
Xapian::PL2Weight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the weight contribution for this object's term to a document.
Xapian::Unicode::PRIVATE_USE
@ PRIVATE_USE
Other, private use (Co)
Definition: unicode.h:238
Xapian::MatchSpy::MatchSpy
MatchSpy()
Default constructor, needed by subclass constructors.
Definition: matchspy.h:60
Xapian::BM25Weight
Xapian::Weight subclass implementing the BM25 probabilistic formula.
Definition: weight.h:513
Xapian::AssertionError::AssertionError
AssertionError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:215
Xapian::BoolWeight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::NumberRangeProcessor::NumberRangeProcessor
NumberRangeProcessor(Xapian::valueno slot_, const std::string &str_=std::string(), unsigned flags_=0)
Constructor.
Definition: queryparser.h:375
Xapian::PostingSource::skip_to
virtual void skip_to(Xapian::docid did, double min_wt)
Advance to the specified docid.
Xapian::operator<=
bool operator<=(const ESetIterator &a, const ESetIterator &b)
Inequality test for ESetIterator objects.
Definition: eset.h:327
Xapian::RSet
A relevance set (R-Set).
Definition: enquire.h:60
Xapian::ESet::ESet
ESet()
Default constructor.
Xapian::WritableDatabase::commit_transaction
void commit_transaction()
Complete the transaction currently in progress.
Xapian::Weight::unserialise
virtual Weight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::ESet::back
ESetIterator back() const
Return iterator pointing to the last object in this ESet.
Definition: eset.h:362
Xapian::FeatureUnavailableError
Indicates an attempt to use a feature which is unavailable.
Definition: error.h:719
Xapian::MSet::get_termfreq
Xapian::doccount get_termfreq(const std::string &term) const
Get the termfreq of a term.
Xapian::Weight::~Weight
virtual ~Weight()
Virtual destructor, because we have virtual methods.
Xapian::CoordWeight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::operator&=
const Query operator&=(Query &a, const InvertedQuery_ &b)
Combine two Xapian::Query objects using OP_AND_NOT with result in the first.
Definition: query.h:726
Xapian::revision
int revision()
Report the revision of the library which the program is linked with.
Definition: xapian.h:142
Xapian::RSet::contains
bool contains(Xapian::docid did) const
Test if a given document in the relevance set.
Xapian::TermGenerator::set_document
void set_document(const Xapian::Document &doc)
Set the current document.
Xapian::sortable_serialise
std::string sortable_serialise(double value)
Convert a floating point number to a string, preserving sort order.
Definition: queryparser.h:1305
Xapian::Database::get_avlength
Xapian::doclength get_avlength() const
Get the average length of the documents in the database.
Xapian::MSet::convert_to_percent
int convert_to_percent(double weight) const
Convert a weight to a percentage.
error.h
Hierarchy of classes which Xapian can throw as exceptions.
Xapian::Unicode::is_wordchar
bool is_wordchar(unsigned ch)
Test if a given Unicode character is "word character".
Definition: unicode.h:343
Xapian::NumberRangeProcessor
Handle a number range.
Definition: queryparser.h:335
Xapian::QueryParser::get_corrected_query_string
std::string get_corrected_query_string() const
Get the spelling-corrected query string.
errorhandler.h
Decide if a Xapian::Error exception should be ignored.
Xapian::ValueCountMatchSpy::get_description
virtual std::string get_description() const
Return a string describing this object.
Xapian::Weight::get_doclength_lower_bound
Xapian::termcount get_doclength_lower_bound() const
A lower bound on the minimum length of any document in the database.
Definition: weight.h:378
Xapian::GreatCircleMetric::clone
LatLongMetric * clone() const
Clone the metric.
Xapian::MSetIterator::operator+
MSetIterator operator+(difference_type n) const
Return the iterator incremented by n positions.
Definition: mset.h:439
Xapian::Registry::get_lat_long_metric
const Xapian::LatLongMetric * get_lat_long_metric(const std::string &name) const
Get a lat-long metric given a name.
Xapian::BB2Weight::unserialise
BB2Weight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::operator|
const Query operator|(const Query &a, const Query &b)
Combine two Xapian::Query objects using OP_OR.
Definition: query.h:643
Xapian::Enquire::set_sort_by_relevance_then_value
void set_sort_by_relevance_then_value(Xapian::valueno sort_key, bool reverse)
Set the sorting to be by relevance then value.
Xapian::ValuePostingSource::next
void next(double min_wt)
Advance the current position to the next matching document.
Xapian::LatLongDistanceKeyMaker::operator()
std::string operator()(const Xapian::Document &doc) const
Build a key string for a Document.
Xapian::ValueIterator
Class for iterating over document values.
Definition: valueiterator.h:40
Xapian::TermGenerator::flags
int flags
For backward compatibility with Xapian 1.2.
Definition: termgenerator.h:98
Xapian::BM25Weight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::TermGenerator::index_text
void index_text(const std::string &text, Xapian::termcount wdf_inc=1, const std::string &prefix=std::string())
Index some text in a std::string.
Definition: termgenerator.h:216
Xapian::Query::get_description
std::string get_description() const
Return a string describing this object.
Xapian::DPHWeight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::Database::compact
void compact(int fd, unsigned flags, int block_size, Xapian::Compactor &compactor)
Produce a compact version of this database.
Definition: database.h:774
Xapian::WritableDatabase::get_description
std::string get_description() const
Return a string describing this object.
Xapian::ValueCountMatchSpy
Class for counting the frequencies of values in the matching documents.
Definition: matchspy.h:205
Xapian::RangeProcessor::release
RangeProcessor * release()
Start reference counting this object.
Definition: queryparser.h:223
Xapian::LatLongCoord::unserialise
void unserialise(const char **ptr, const char *end)
Unserialise a buffer and set this object to its coordinate.
Xapian::Query::serialise
std::string serialise() const
Serialise this object into a string.
Xapian::Enquire::clear_matchspies
void clear_matchspies()
Remove all the matchspies.
Xapian::ExpandDecider::release
const ExpandDecider * release() const
Start reference counting this object.
Definition: expanddecider.h:77
Xapian::ExpandDecider::operator()
virtual bool operator()(const std::string &term) const =0
Do we want this term in the ESet?
Xapian::MSet::get_matches_upper_bound
Xapian::doccount get_matches_upper_bound() const
Upper bound on the total number of matching documents.
Xapian::Query::get_subquery
const Query get_subquery(size_t n) const
Read a top level subquery.
Xapian::InvalidArgumentError::InvalidArgumentError
InvalidArgumentError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:265
Xapian::ValueIterator::operator=
ValueIterator & operator=(const ValueIterator &o)
Assignment.
Xapian::DatabaseError
DatabaseError indicates some sort of database related error.
Definition: error.h:367
Xapian::operator/
const Query operator/(const Query &q, double factor)
Inverse-scale a Xapian::Query object using OP_SCALE_WEIGHT.
Definition: query.h:683
Xapian::FixedWeightPostingSource::init
void init(const Database &db_)
Set this PostingSource to the start of the list of postings.
Xapian::FeatureUnavailableError::FeatureUnavailableError
FeatureUnavailableError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:735
Xapian::LogicError
The base class for exceptions indicating errors in the program logic.
Definition: error.h:154
Xapian::Unicode::LINE_SEPARATOR
@ LINE_SEPARATOR
Separator, line (Zl)
Definition: unicode.h:234
Xapian::TermGenerator::TermGenerator
TermGenerator()
Default constructor.
Xapian::Registry::Registry
Registry(const Registry &other)
Copy constructor.
Xapian::MatchSpy::unserialise
virtual MatchSpy * unserialise(const std::string &serialised, const Registry &context) const
Unserialise parameters.
Xapian::LatLongCoords
A sequence of latitude-longitude coordinates.
Definition: geospatial.h:232
Xapian::Database::get_average_length
double get_average_length() const
New name for get_avlength().
Definition: database.h:284
Xapian::DatabaseClosedError
Indicates an attempt to access a closed database.
Definition: error.h:1097
Xapian::Query::get_terms_begin
const TermIterator get_terms_begin() const
Begin iterator for terms in the query object.
Xapian::DatabaseError::DatabaseError
DatabaseError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:391
Xapian::DateValueRangeProcessor::DateValueRangeProcessor
DateValueRangeProcessor(Xapian::valueno slot_, bool prefer_mdy_=false, int epoch_year_=1970)
Constructor.
Definition: queryparser.h:527
Xapian::TermGenerator::set_max_word_length
void set_max_word_length(unsigned max_word_length)
Set the maximum length word to index.
Xapian::TermIterator
Class for iterating over a list of terms.
Definition: termiterator.h:41
Xapian::Unicode::MODIFIER_SYMBOL
@ MODIFIER_SYMBOL
Symbol, modified (Sk)
Definition: unicode.h:249
Xapian::LatLongCoords::LatLongCoords
LatLongCoords()
Construct an empty container.
Definition: geospatial.h:266
Xapian::Document::Document
Document(const Document &other)
Copying is allowed.
Xapian::DatabaseModifiedError::DatabaseModifiedError
DatabaseModifiedError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:555
Xapian::DPHWeight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the weight contribution for this object's term to a document.
Xapian::Weight::get_doclength_upper_bound
Xapian::termcount get_doclength_upper_bound() const
An upper bound on the maximum length of any document in the database.
Definition: weight.h:368
Xapian::Weight::get_maxpart
virtual double get_maxpart() const =0
Return an upper bound on what get_sumpart() can return for any document.
Xapian::Stem::Stem
Stem(const std::string &language)
Construct a Xapian::Stem object for a particular language.
Xapian::LatLongDistancePostingSource::clone
LatLongDistancePostingSource * clone() const
Clone the posting source.
Xapian::PositionIterator::operator=
PositionIterator & operator=(const PositionIterator &o)
Assignment.
Xapian::operator>
bool operator>(const ESetIterator &a, const ESetIterator &b)
Inequality test for ESetIterator objects.
Definition: eset.h:307
Xapian::Stem
Class representing a stemming algorithm.
Definition: stem.h:62
Xapian::InL2Weight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::Query::OP_AND_NOT
@ OP_AND_NOT
Match documents which the first subquery matches but no others do.
Definition: query.h:99
Xapian::Registry::get_weighting_scheme
const Xapian::Weight * get_weighting_scheme(const std::string &name) const
Get the weighting scheme given a name.
Xapian::Query::Query
Query(op op_, I begin, I end, Xapian::termcount window=0)
Construct a Query object from a begin/end iterator pair.
Definition: query.h:458
Xapian::DatabaseCorruptError
DatabaseCorruptError indicates database corruption was detected.
Definition: error.h:409
Xapian::Document::clear_values
void clear_values()
Remove all values associated with the document.
Xapian::ValueSetMatchDecider::remove_value
void remove_value(const std::string &value)
Remove a value from the test set.
Definition: valuesetmatchdecider.h:84
Xapian::LatLongMetric::operator()
double operator()(const LatLongCoords &a, const std::string &b) const
Return the distance between two coordinate lists, in metres.
Definition: geospatial.h:337
Xapian::LatLongCoordsIterator
An iterator across the values in a LatLongCoords object.
Definition: geospatial.h:165
Xapian::WritableDatabase::remove_spelling
void remove_spelling(const std::string &word, Xapian::termcount freqdec=1) const
Remove a word from the spelling dictionary.
Xapian::LatLongMetric::serialise
virtual std::string serialise() const =0
Serialise object parameters into a string.
Xapian::SerialisationError
Indicates an error in the std::string serialisation of an object.
Definition: error.h:929
Xapian::DBCHECK_FIX
const int DBCHECK_FIX
Fix problems.
Definition: constants.h:243
Xapian::MatchSpy::get_description
virtual std::string get_description() const
Return a string describing this object.
Xapian::BoolWeight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::major_version
int major_version()
Report the major version of the library which the program is linked with.
Definition: xapian.h:124
Xapian::Database::metadata_keys_begin
Xapian::TermIterator metadata_keys_begin(const std::string &prefix=std::string()) const
An iterator which returns all user-specified metadata keys.
Xapian::InL2Weight::name
std::string name() const
Return the name of this weighting scheme.
XAPIAN_TOTALLENGTH_TYPE
#define XAPIAN_TOTALLENGTH_TYPE
Type for returning total document length.
Definition: version.h:80
registry.h
Class for looking up user subclasses during unserialisation.
Xapian::Compactor::add_source
void add_source(const std::string &srcdir)
Add a source database.
Xapian::ValuePostingSource::set_termfreq_min
void set_termfreq_min(Xapian::doccount termfreq_min_)
Set a lower bound on the term frequency.
Definition: postingsource.h:540
Xapian::StringValueRangeProcessor::StringValueRangeProcessor
StringValueRangeProcessor(Xapian::valueno slot_)
Constructor.
Definition: queryparser.h:474
Xapian::StemImplementation::operator()
virtual std::string operator()(const std::string &word)=0
Stem the specified word.
Xapian::ValueCountMatchSpy::serialise
virtual std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::PL2Weight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
Xapian::ValuePostingSource::get_slot
Xapian::valueno get_slot() const
The slot we're reading values from.
Definition: postingsource.h:508
Xapian::LatLongCoords::serialise
std::string serialise() const
Return a serialised form of the coordinate list.
Xapian::Enquire::set_sort_by_key_then_relevance
void set_sort_by_key_then_relevance(Xapian::KeyMaker *sorter, bool reverse)
Set the sorting to be by keys generated from values, then by relevance for documents with identical k...
Xapian::DPHWeight::unserialise
DPHWeight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::TermGenerator::set_stemming_strategy
void set_stemming_strategy(stem_strategy strategy)
Set the stemming strategy.
Xapian::ValueIterator::check
bool check(Xapian::docid docid)
Check if the specified docid occurs.
Xapian::DateRangeProcessor::DateRangeProcessor
DateRangeProcessor(Xapian::valueno slot_, const std::string &str_, unsigned flags_=0, int epoch_year_=1970)
Constructor.
Definition: queryparser.h:309
Xapian::DatabaseNotFoundError::DatabaseNotFoundError
DatabaseNotFoundError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:1071
Xapian::ValueMapPostingSource::serialise
std::string serialise() const
Serialise object parameters into a string.
Xapian::LatLongCoord::LatLongCoord
LatLongCoord(double latitude_, double longitude_)
Construct a coordinate.
Xapian::ValuePostingSource::get_termfreq_min
Xapian::doccount get_termfreq_min() const
A lower bound on the number of documents this object can return.
Xapian::MSet::snippet
std::string snippet(const std::string &text, size_t length=500, const Xapian::Stem &stemmer=Xapian::Stem(), unsigned flags=SNIPPET_BACKGROUND_MODEL|SNIPPET_EXHAUSTIVE, const std::string &hi_start="<b>", const std::string &hi_end="</b>", const std::string &omit="...") const
Generate a snippet.
Xapian::Compactor
Compact a database, or merge and compact several.
Definition: compactor.h:42
Xapian::DateRangeProcessor
Handle a date range.
Definition: queryparser.h:245
Xapian::TradWeight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::BM25Weight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterm) const
Calculate the weight contribution for this object's term to a document.
Xapian::StringValueRangeProcessor::str
std::string str
The prefix (or suffix if prefix==false) string to look for.
Definition: queryparser.h:467
Xapian::CoordWeight::clone
CoordWeight * clone() const
Clone this object.
Xapian::DB_NO_SYNC
const int DB_NO_SYNC
Don't attempt to ensure changes have hit disk.
Definition: constants.h:66
Xapian::Compactor::set_multipass
void set_multipass(bool multipass)
Set whether to merge postlists in multiple passes.
Definition: compactor.h:102
termiterator.h
Class for iterating over a list of terms.
Xapian::WritableDatabase::commit
void commit()
Commit any pending modifications made to the database.
Xapian::TermIterator::positionlist_end
PositionIterator positionlist_end() const
Return an end PositionIterator for the current term.
Definition: termiterator.h:104
Xapian::QueryParser::set_max_expansion
void set_max_expansion(Xapian::termcount max_expansion, int max_type=Xapian::Query::WILDCARD_LIMIT_ERROR, unsigned flags=FLAG_WILDCARD|FLAG_PARTIAL)
Specify the maximum expansion of a wildcard and/or partial term.
Xapian::LatLongDistancePostingSource::name
std::string name() const
Name of the posting source class.
Xapian::TermGenerator::set_database
void set_database(const Xapian::WritableDatabase &db)
Set the database to index spelling data to.
Xapian::IneB2Weight
This class implements the IneB2 weighting scheme.
Definition: weight.h:960
Xapian::PL2PlusWeight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::QueryParser::get_default_op
Query::op get_default_op() const
Get the current default operator.
Xapian::Error::get_context
const std::string & get_context() const
Optional context information.
Definition: error.h:133
Xapian::BB2Weight::BB2Weight
BB2Weight(double c)
Construct a BB2Weight.
Xapian::Database::spellings_end
Xapian::TermIterator spellings_end() const
Corresponding end iterator to spellings_begin().
Definition: database.h:432
Xapian::Enquire::set_sort_by_relevance_then_key
void set_sort_by_relevance_then_key(Xapian::KeyMaker *sorter, bool reverse)
Set the sorting to be by relevance, then by keys generated from values.
Xapian::Database::Database
Database(int fd, int flags=0)
Open a single-file Database.
Xapian::Error::get_msg
const std::string & get_msg() const
Message giving details of the error, intended for human consumption.
Definition: error.h:122
Xapian::Query::MatchNothing
static const Xapian::Query MatchNothing
A query matching no documents.
Definition: query.h:65
Xapian::Enquire::~Enquire
~Enquire()
Close the Xapian::Enquire object.
Xapian::SimpleStopper::get_description
virtual std::string get_description() const
Return a string describing this object.
Xapian::UnimplementedError::UnimplementedError
UnimplementedError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:349
Xapian::TermIterator::TermIterator
TermIterator()
Default constructor.
Definition: termiterator.h:80
Xapian::LatLongCoords::size
size_t size() const
Get the number of coordinates in the container.
Definition: geospatial.h:248
Xapian::Stem::~Stem
~Stem()
Destructor.
Xapian::Unicode::OTHER_SYMBOL
@ OTHER_SYMBOL
Symbol, other (So)
Definition: unicode.h:250
Xapian::Weight::clone
virtual Weight * clone() const =0
Clone this object.
Xapian::AssertionError::AssertionError
AssertionError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:223
Xapian::IfB2Weight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::NumberValueRangeProcessor
Handle a number range.
Definition: queryparser.h:654
Xapian::Database::locked
bool locked() const
Test if this database is currently locked for writing.
Xapian::InMemory::open
WritableDatabase open()
Construct a WritableDatabase object for a new, empty InMemory database.
Definition: dbfactory.h:104
Xapian::BoolWeight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the weight contribution for this object's term to a document.
Xapian::PL2Weight::PL2Weight
PL2Weight(double c)
Construct a PL2Weight.
Xapian::MSetIterator
Iterator over a Xapian::MSet.
Definition: mset.h:351
Xapian::FixedWeightPostingSource::check
bool check(Xapian::docid min_docid, double min_wt)
Check if the specified docid occurs.
Xapian::PostingSource::release
PostingSource * release()
Start reference counting this object.
Definition: postingsource.h:372
Xapian::ExpandDeciderAnd
ExpandDecider subclass which rejects terms using two ExpandDeciders.
Definition: expanddecider.h:88
Xapian::Query::get_unique_terms_end
const TermIterator get_unique_terms_end() const
End iterator for unique terms in the query object.
Definition: query.h:507
Xapian::CoordWeight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::ValuePostingSource::init
void init(const Database &db_)
Set this PostingSource to the start of the list of postings.
Xapian::PositionIterator::PositionIterator
PositionIterator()
Default constructor.
Definition: positioniterator.h:81
Xapian::DatabaseVersionError
DatabaseVersionError indicates that a database is in an unsupported format.
Definition: error.h:632
Xapian::InL2Weight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the weight contribution for this object's term to a document.
Xapian::LMWeight::unserialise
LMWeight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::Enquire::add_matchspy
void add_matchspy(MatchSpy *spy)
Add a matchspy.
Xapian::Enquire::operator=
void operator=(const Enquire &other)
Assignment is allowed (and is cheap).
Xapian::DB_DANGEROUS
const int DB_DANGEROUS
Update the database in-place.
Definition: constants.h:103
Xapian::Database::get_unique_terms
Xapian::termcount get_unique_terms(Xapian::docid did) const
Get the number of unique terms in document.
Xapian::PostingIterator::positionlist_end
PositionIterator positionlist_end() const
Return an end PositionIterator for the current document.
Definition: postingiterator.h:109
Xapian::DocNotFoundError::DocNotFoundError
DocNotFoundError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:690
Xapian::BM25Weight::BM25Weight
BM25Weight(double k1, double k2, double k3, double b, double min_normlen)
Construct a BM25Weight.
Definition: weight.h:558
Xapian::DBCHECK_FULL_TREE
const int DBCHECK_FULL_TREE
Show a full display of the B-tree contents.
Definition: constants.h:216
Xapian::ValueCountMatchSpy::unserialise
virtual MatchSpy * unserialise(const std::string &serialised, const Registry &context) const
Unserialise parameters.
Xapian::Unicode::SPACE_SEPARATOR
@ SPACE_SEPARATOR
Separator, space (Zs)
Definition: unicode.h:233
Xapian::ValueIterator::ValueIterator
ValueIterator()
Default constructor.
Definition: valueiterator.h:81
Xapian::DBCHECK_SHORT_TREE
const int DBCHECK_SHORT_TREE
Show a short-format display of the B-tree contents.
Definition: constants.h:210
Xapian::PositionIterator::skip_to
void skip_to(Xapian::termpos termpos)
Advance the iterator to term position termpos.
Xapian::BM25PlusWeight::unserialise
BM25PlusWeight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::MSetIterator::operator-=
MSetIterator & operator-=(difference_type n)
Move the iterator back by n positions.
Definition: mset.h:430
Xapian::PostingIterator
Class for iterating over a list of terms.
Definition: postingiterator.h:41
Xapian::QueryParserError
Indicates a query string can't be parsed.
Definition: error.h:887
Xapian::BoolWeight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::ErrorHandler
Decide if a Xapian::Error exception should be ignored.
Definition: errorhandler.h:51
Xapian::QueryParser::QueryParser
QueryParser()
Default constructor.
Xapian::ErrorHandler::release
const ErrorHandler * release() const
Start reference counting this object.
Definition: errorhandler.h:117
Xapian::ErrorHandler::release
ErrorHandler * release()
Start reference counting this object.
Definition: errorhandler.h:105
Xapian::ValuePostingSource::done
void done()
End the iteration.
Definition: postingsource.h:522
Xapian::IfB2Weight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterm) const
Calculate the weight contribution for this object's term to a document.
Xapian::TermGenerator::~TermGenerator
~TermGenerator()
Destructor.
Xapian::Unicode::DASH_PUNCTUATION
@ DASH_PUNCTUATION
Punctuation, dash (Pd)
Definition: unicode.h:241
Xapian::ValueCountMatchSpy::clone
virtual MatchSpy * clone() const
Clone the match spy.
Xapian::StemImplementation::get_description
virtual std::string get_description() const =0
Return a string describing this object.
Xapian::Enquire::set_query
void set_query(const Xapian::Query &query, Xapian::termcount qlen=0)
Set the query to run.
Xapian::ESetIterator::operator+=
ESetIterator & operator+=(difference_type n)
Move the iterator forwards by n positions.
Definition: eset.h:233
Xapian::ValueRangeProcessor::release
const ValueRangeProcessor * release() const
Start reference counting this object.
Definition: queryparser.h:446
Xapian::MultiValueKeyMaker::MultiValueKeyMaker
MultiValueKeyMaker(Iterator begin, Iterator end)
Construct a MultiValueKeyMaker from a pair of iterators.
Definition: keymaker.h:125
Xapian::DatabaseError::DatabaseError
DatabaseError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:383
Xapian::DatabaseCorruptError::DatabaseCorruptError
DatabaseCorruptError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:425
Xapian::operator^
const Query operator^(const Query &a, const Query &b)
Combine two Xapian::Query objects using OP_XOR.
Definition: query.h:650
Xapian::metres_to_miles
double metres_to_miles(double metres)
Convert from metres to miles.
Definition: geospatial.h:67
Xapian::ESetIterator::operator--
ESetIterator operator--(int)
Move the iterator to the previous position (postfix version).
Definition: eset.h:203
Xapian::Database::get_doclength
Xapian::termcount get_doclength(Xapian::docid did) const
Get the length of a document.
Xapian::ValueRangeProcessor::operator()
virtual Xapian::valueno operator()(std::string &begin, std::string &end)=0
Check for a valid range of this type.
Xapian::Compactor::resolve_duplicate_metadata
virtual std::string resolve_duplicate_metadata(const std::string &key, size_t num_tags, const std::string tags[])
Resolve multiple user metadata entries with the same key.
Xapian::Utf8Iterator::operator++
Utf8Iterator & operator++()
Move forward to the next Unicode character.
Definition: unicode.h:176
Xapian::Database::~Database
virtual ~Database()
Destroy this handle on the database.
Xapian::QueryParser::add_prefix
void add_prefix(const std::string &field, const std::string &prefix)
Add a free-text field term prefix.
Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker
LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoord &centre_, const LatLongMetric &metric_)
Construct a LatLongDistanceKeyMaker.
Definition: geospatial.h:650
Xapian::Weight::get_sumpart
virtual double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterms) const =0
Calculate the weight contribution for this object's term to a document.
Xapian::RSet::empty
bool empty() const
Test if this R-Set is empty.
Xapian::Enquire::get_matching_terms_begin
TermIterator get_matching_terms_begin(const MSetIterator &it) const
Get terms which match a given document, by match set item.
Xapian::Query::Query
Query(op op_, const std::string &a, const std::string &b)
Construct a Query object by combining two terms.
Definition: query.h:390
Xapian::MSet::end
MSetIterator end() const
Return iterator pointing to just after the last item in this MSet.
Definition: mset.h:612
Xapian::Document::values_count
Xapian::termcount values_count() const
Count the values in this document.
Xapian::Weight::get_wdf_upper_bound
Xapian::termcount get_wdf_upper_bound() const
An upper bound on the wdf of this term.
Definition: weight.h:386
Xapian::PostingIterator::operator++
PostingIterator & operator++()
Advance the iterator to the next position.
Xapian::WritableDatabase::operator=
void operator=(const WritableDatabase &other)
Assignment is allowed.
Xapian::valueno
unsigned valueno
The number for a value slot in a document.
Definition: types.h:108
Xapian::SerialisationError::SerialisationError
SerialisationError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:945
compactor.h
Compact a database, or merge and compact several.
Xapian::ValueCountMatchSpy::get_total
size_t get_total() const
Return the total number of documents tallied.
Definition: matchspy.h:241
Xapian::percent
int percent
The percentage score for a document in an MSet.
Definition: types.h:66
Xapian::IneB2Weight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::DecreasingValueWeightPostingSource::unserialise
DecreasingValueWeightPostingSource * unserialise(const std::string &serialised) const
Create object given string serialisation returned by serialise().
Xapian::GreatCircleMetric::name
std::string name() const
Return the full name of the metric.
Xapian::doclength
double doclength
A normalised document length.
Definition: types.h:59
Xapian::QueryParserError::QueryParserError
QueryParserError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:911
Xapian::Database::get_value_freq
Xapian::doccount get_value_freq(Xapian::valueno slot) const
Return the frequency of a given value slot.
Xapian::Weight::Weight
Weight(const Weight &)
Don't allow copying.
Xapian::BM25Weight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::RuntimeError
The base class for exceptions indicating errors only detectable at runtime.
Definition: error.h:176
Xapian::DB_BACKEND_INMEMORY
const int DB_BACKEND_INMEMORY
Use the "in memory" backend.
Definition: constants.h:195
database.h
API for working with Xapian databases.
Xapian::DPHWeight::DPHWeight
DPHWeight()
Construct a DPHWeight.
Definition: weight.h:1348
constants.h
Constants in the Xapian namespace.
Xapian::Error
All exceptions thrown by Xapian are subclasses of Xapian::Error.
Definition: error.h:43
Xapian::IneB2Weight::IneB2Weight
IneB2Weight(double c)
Construct an IneB2Weight.
Xapian::LMWeight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
Xapian::LatLongMetric::name
virtual std::string name() const =0
Return the full name of the metric.
Xapian::Database::synonyms_begin
Xapian::TermIterator synonyms_begin(const std::string &term) const
An iterator which returns all the synonyms for a given term.
Xapian::MatchSpy::clone
virtual MatchSpy * clone() const
Clone the match spy.
Xapian::sortable_unserialise
double sortable_unserialise(const std::string &serialised)
Convert a string encoded using sortable_serialise back to a floating point number.
postingsource.h
External sources of posting information.
Xapian::LatLongDistancePostingSource::LatLongDistancePostingSource
LatLongDistancePostingSource(Xapian::valueno slot_, const LatLongCoords &centre_, const LatLongMetric &metric_, double max_range_=0.0, double k1_=1000.0, double k2_=1.0)
Construct a new posting source which returns only documents within range of one of the central coordi...
Xapian::ValuePostingSource::at_end
bool at_end() const
Return true if the current position is past the last entry in this list.
positioniterator.h
Class for iterating over term positions.
Xapian::Document::remove_posting
void remove_posting(const std::string &tname, Xapian::termpos tpos, Xapian::termcount wdfdec=1)
Remove a posting of a term from the document.
Xapian::ExpandDeciderFilterTerms
ExpandDecider subclass which rejects terms in a specified list.
Definition: expanddecider.h:119
Xapian::DecreasingValueWeightPostingSource::get_weight
double get_weight() const
Return the weight contribution for the current document.
Xapian::QueryParser::add_rangeprocessor
void add_rangeprocessor(Xapian::RangeProcessor *range_proc, const std::string *grouping=NULL)
Register a RangeProcessor.
Xapian::Weight::name
virtual std::string name() const
Return the name of this weighting scheme.
Xapian::MSetIterator::get_document
Xapian::Document get_document() const
Get the Document object for the current position.
Xapian::LatLongDistancePostingSource::LatLongDistancePostingSource
LatLongDistancePostingSource(Xapian::valueno slot_, const LatLongCoords &centre_, double max_range_=0.0, double k1_=1000.0, double k2_=1.0)
Construct a new posting source which returns only documents within range of one of the central coordi...
Xapian::Compactor::set_status
virtual void set_status(const std::string &table, const std::string &status)
Update progress.
Xapian::MSet::get_firstitem
Xapian::doccount get_firstitem() const
Rank of first item in this MSet.
Xapian::QueryParser::set_stemming_strategy
void set_stemming_strategy(stem_strategy strategy)
Set the stemming strategy.
Xapian::MSet::empty
bool empty() const
Return true if this MSet object is empty.
Definition: mset.h:283
Xapian::IfB2Weight::IfB2Weight
IfB2Weight(double c)
Construct an IfB2Weight.
Xapian::BM25PlusWeight::BM25PlusWeight
BM25PlusWeight(double k1, double k2, double k3, double b, double min_normlen, double delta)
Construct a BM25PlusWeight.
Definition: weight.h:672
Xapian::SimpleStopper
Simple implementation of Stopper class - this will suit most users.
Definition: queryparser.h:96
Xapian::termpos
unsigned XAPIAN_TERMPOS_BASE_TYPE termpos
A term position within a document or query.
Definition: types.h:83
Xapian::QueryParser::stoplist_end
TermIterator stoplist_end() const
End iterator over terms omitted from the query as stopwords.
Definition: queryparser.h:1210
Xapian::MSet::MSet
MSet(const MSet &o)
Copying is allowed.
Xapian::RSet::operator=
void operator=(const RSet &rset)
Assignment operator.
Xapian::ValueMapPostingSource
A posting source which looks up weights in a map using values as the key.
Definition: postingsource.h:686
Xapian::UnimplementedError
UnimplementedError indicates an attempt to use an unimplemented feature.
Definition: error.h:325
Xapian::DecreasingValueWeightPostingSource::next
void next(double min_wt)
Advance the current position to the next matching document.
Xapian::ValueWeightPostingSource::ValueWeightPostingSource
ValueWeightPostingSource(Xapian::valueno slot_)
Construct a ValueWeightPostingSource.
Xapian::Remote::open_writable
WritableDatabase open_writable(const std::string &host, unsigned int port, useconds_t timeout=0, useconds_t connect_timeout=10000, int flags=0)
Construct a WritableDatabase object for update access to a remote database accessed via a TCP connect...
Xapian::BB2Weight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::ExpandDecider
Virtual base class for expand decider functor.
Definition: expanddecider.h:38
Xapian::Stopper::~Stopper
virtual ~Stopper()
Class has virtual methods, so provide a virtual destructor.
Definition: queryparser.h:65
Xapian::Utf8Iterator::left
size_t left() const
Return the number of bytes left in the iterator's buffer.
Definition: unicode.h:59
Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker
LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoord &centre_, const LatLongMetric &metric_, double defdistance)
Construct a LatLongDistanceKeyMaker.
Definition: geospatial.h:629
Xapian::LatLongCoord::get_description
std::string get_description() const
Return a string describing this object.
Xapian::DateValueRangeProcessor::DateValueRangeProcessor
DateValueRangeProcessor(Xapian::valueno slot_, const std::string &str_, bool prefix_=true, bool prefer_mdy_=false, int epoch_year_=1970)
Constructor.
Definition: queryparser.h:569
Xapian::ValuePostingSource::get_value
std::string get_value() const
Read current value.
Definition: postingsource.h:514
Xapian::PostingSource::get_termfreq_min
virtual Xapian::doccount get_termfreq_min() const =0
A lower bound on the number of documents this object can return.
Xapian::ValueIterator::get_docid
Xapian::docid get_docid() const
Return the docid at the current position.
Xapian::MSet
Class representing a list of search results.
Definition: mset.h:44
Xapian::ESetIterator::operator-
ESetIterator operator-(difference_type n) const
Return the iterator decremented by n positions.
Definition: eset.h:256
Xapian::doccount
unsigned XAPIAN_DOCID_BASE_TYPE doccount
A count of documents.
Definition: types.h:38
Xapian::DatabaseLockError
DatabaseLockError indicates failure to lock a database.
Definition: error.h:493
Xapian::Weight
Abstract base class for weighting schemes.
Definition: weight.h:35
Xapian::Unicode::ENCLOSING_MARK
@ ENCLOSING_MARK
Mark, enclosing (Me)
Definition: unicode.h:228
Xapian::Unicode::LETTER_NUMBER
@ LETTER_NUMBER
Number, letter (Nl)
Definition: unicode.h:231
Xapian::ValuePostingSource::set_termfreq_max
void set_termfreq_max(Xapian::doccount termfreq_max_)
An upper bound on the term frequency.
Definition: postingsource.h:562
Xapian::Enquire::get_query
const Xapian::Query & get_query() const
Get the current query.
Xapian::DatabaseCorruptError::DatabaseCorruptError
DatabaseCorruptError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:433
Xapian::DLHWeight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
Xapian::MSet::get_uncollapsed_matches_lower_bound
Xapian::doccount get_uncollapsed_matches_lower_bound() const
Lower bound on the total number of matching documents before collapsing.
Xapian::LatLongDistancePostingSource::unserialise_with_registry
LatLongDistancePostingSource * unserialise_with_registry(const std::string &serialised, const Registry &registry) const
Create object given string serialisation returned by serialise().
Xapian::ESet::ESet
ESet(const ESet &o)
Copying is allowed.
Xapian::RSet::remove_document
void remove_document(const Xapian::MSetIterator &i)
Remove a document from the relevance set.
Definition: enquire.h:104
Xapian::InL2Weight
This class implements the InL2 weighting scheme.
Definition: weight.h:816
Xapian::PostingIterator::~PostingIterator
~PostingIterator()
Destructor.
Definition: postingiterator.h:84
Xapian::RangeError::RangeError
RangeError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:987
Xapian::PL2PlusWeight
Xapian::Weight subclass implementing the PL2+ probabilistic formula.
Definition: weight.h:1235
Xapian::PostingSource::get_description
virtual std::string get_description() const
Return a string describing this object.
Xapian::ValueRangeProcessor
Base class for value range processors.
Definition: queryparser.h:397
Xapian::MultiValueKeyMaker::operator()
virtual std::string operator()(const Xapian::Document &doc) const
Build a key string for a Document.
Xapian::FeatureUnavailableError::FeatureUnavailableError
FeatureUnavailableError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:743
Xapian::Database::get_description
virtual std::string get_description() const
Return a string describing this object.
Xapian::FixedWeightPostingSource::get_weight
double get_weight() const
Return the weight contribution for the current document.
Xapian::QueryParser::parse_query
Query parse_query(const std::string &query_string, unsigned flags=FLAG_DEFAULT, const std::string &default_prefix=std::string())
Parse a query.
Xapian::MSetIterator::operator--
MSetIterator operator--(int)
Move the iterator to the previous position (postfix version).
Definition: mset.h:394
Xapian::QueryParser::stoplist_begin
TermIterator stoplist_begin() const
Begin iterator over terms omitted from the query as stopwords.
unicode.h
Unicode and UTF-8 related classes and functions.
XAPIAN_TERMPOS_BASE_TYPE
#define XAPIAN_TERMPOS_BASE_TYPE
Base (signed) type for Xapian::termpos.
Definition: version.h:77
Xapian::ValuePostingSource::set_termfreq_est
void set_termfreq_est(Xapian::doccount termfreq_est_)
An estimate of the term frequency.
Definition: postingsource.h:551
Xapian::MSet::get_max_attained
double get_max_attained() const
The maximum weight attained by any document.
Xapian::ValuePostingSource::get_docid
Xapian::docid get_docid() const
Return the current docid.
Xapian::DB_BACKEND_STUB
const int DB_BACKEND_STUB
Open a stub database file.
Definition: constants.h:179
Xapian::Database::compact
void compact(int fd, unsigned flags=0, int block_size=0)
Produce a compact version of this database.
Definition: database.h:671
Xapian::Document::get_data
std::string get_data() const
Get data stored in the document.
Xapian::FixedWeightPostingSource::serialise
std::string serialise() const
Serialise object parameters into a string.
Xapian::BM25Weight::unserialise
BM25Weight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::ExpandDeciderAnd::ExpandDeciderAnd
ExpandDeciderAnd(const ExpandDecider *first_, const ExpandDecider *second_)
Compatibility method.
Definition: expanddecider.h:107
Xapian::Query::WILDCARD_LIMIT_ERROR
@ WILDCARD_LIMIT_ERROR
Throw an error if OP_WILDCARD exceeds its expansion limit.
Definition: query.h:282
Xapian::BoolWeight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::ValueIterator::operator*
std::string operator*() const
Return the value at the current position.
Xapian::LatLongMetric::pointwise_distance
virtual double pointwise_distance(const LatLongCoord &a, const LatLongCoord &b) const =0
Return the distance between two coordinates, in metres.
Xapian::MatchDecider::operator()
virtual bool operator()(const Xapian::Document &doc) const =0
Decide whether we want this document to be in the MSet.
Xapian::PL2Weight::unserialise
PL2Weight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::DateRangeProcessor::DateRangeProcessor
DateRangeProcessor(Xapian::valueno slot_, unsigned flags_=0, int epoch_year_=1970)
Constructor.
Definition: queryparser.h:262
Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker
LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoord &centre_)
Construct a LatLongDistanceKeyMaker.
Definition: geospatial.h:671
Xapian::InvalidOperationError
InvalidOperationError indicates the API was used in an invalid way.
Definition: error.h:283
Xapian::ValuePostingSource::check
bool check(Xapian::docid min_docid, double min_wt)
Check if the specified docid occurs.
Xapian::NetworkError::NetworkError
NetworkError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:827
Xapian::BM25Weight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::Stem::Stem
Stem(const std::string &language, bool fallback)
Construct a Xapian::Stem object for a particular language.
Xapian::Database::size
size_t size() const
Return number of shards in this Database object.
Definition: database.h:93
Xapian::Enquire::set_weighting_scheme
void set_weighting_scheme(const Weight &weight_)
Set the weighting scheme to use for queries.
Xapian::ValueMapPostingSource::init
void init(const Database &db_)
Set this PostingSource to the start of the list of postings.
Xapian::MSet::back
MSetIterator back() const
Return iterator pointing to the last object in this MSet.
Definition: mset.h:624
Xapian::Database::postlist_begin
PostingIterator postlist_begin(const std::string &tname) const
An iterator pointing to the start of the postlist for a given term.
XAPIAN_TERMCOUNT_BASE_TYPE
#define XAPIAN_TERMCOUNT_BASE_TYPE
Base (signed) type for Xapian::termcount and related types.
Definition: version.h:74
Xapian::MatchSpy::release
const MatchSpy * release() const
Start reference counting this object.
Definition: matchspy.h:196
Xapian::FixedWeightPostingSource::get_description
std::string get_description() const
Return a string describing this object.
Xapian::QueryParser::add_valuerangeprocessor
void add_valuerangeprocessor(Xapian::ValueRangeProcessor *vrproc)
Register a ValueRangeProcessor.
Definition: queryparser.h:1231
Xapian::MSet::get_uncollapsed_matches_estimated
Xapian::doccount get_uncollapsed_matches_estimated() const
Estimate of the total number of matching documents before collapsing.
Xapian::WritableDatabase::WritableDatabase
WritableDatabase()
Create a WritableDatabase with no subdatabases.
Xapian::Document::add_term
void add_term(const std::string &tname, Xapian::termcount wdfinc=1)
Add a term to the document, without positional information.
Xapian::TradWeight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::Database::get_collection_freq
Xapian::termcount get_collection_freq(const std::string &tname) const
Return the total number of occurrences of the given term.
Xapian::LMWeight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::InL2Weight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::NetworkTimeoutError
Indicates a timeout expired while communicating with a remote database.
Definition: error.h:845
Xapian::MatchDecider
Base class for matcher decision functor.
Definition: enquire.h:118
Xapian::Unicode::UPPERCASE_LETTER
@ UPPERCASE_LETTER
Letter, uppercase (Lu)
Definition: unicode.h:222
Xapian::Database::get_wdf_upper_bound
Xapian::termcount get_wdf_upper_bound(const std::string &term) const
Get an upper bound on the wdf of term term.
Xapian::NumberValueRangeProcessor::operator()
Xapian::valueno operator()(std::string &begin, std::string &end)
Check for a valid numeric range.
Xapian::MSetIterator::get_description
std::string get_description() const
Return a string describing this object.
Xapian::DateValueRangeProcessor::operator()
Xapian::valueno operator()(std::string &begin, std::string &end)
Check for a valid date range.
Xapian::PostingIterator::operator*
Xapian::docid operator*() const
Return the document id at the current position.
Xapian::BM25PlusWeight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::Query::get_length
Xapian::termcount get_length() const
Return the length of this query object.
Xapian::WildcardError::WildcardError
WildcardError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:1037
Xapian::StemImplementation
Class representing a stemming algorithm implementation.
Definition: stem.h:40
Xapian::DBCHECK_SHOW_STATS
const int DBCHECK_SHOW_STATS
Show statistics for the B-tree.
Definition: constants.h:228
Xapian::StringValueRangeProcessor::StringValueRangeProcessor
StringValueRangeProcessor(Xapian::valueno slot_, const std::string &str_, bool prefix_=true)
Constructor.
Definition: queryparser.h:485
Xapian::TermGenerator
Parses a piece of text and generate terms.
Definition: termgenerator.h:48
Xapian::CoordWeight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
XAPIAN_REVISION_TYPE
#define XAPIAN_REVISION_TYPE
Underlying type for Xapian::rev.
Definition: version.h:83
Xapian::ESetIterator
Iterator over a Xapian::ESet.
Definition: eset.h:160
Xapian::WritableDatabase::WritableDatabase
WritableDatabase(const WritableDatabase &other)
Copying is allowed.
Xapian::MSetIterator::operator++
MSetIterator & operator++()
Advance the iterator to the next position.
Definition: mset.h:375
Xapian::PL2Weight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::DecreasingValueWeightPostingSource::name
std::string name() const
Name of the posting source class.
Xapian::InL2Weight::InL2Weight
InL2Weight(double c)
Construct an InL2Weight.
Xapian::Query::Query
Query(op op_, Xapian::valueno slot, const std::string &range_limit)
Construct a Query object for a single-ended value range.
Xapian::MSet::get_uncollapsed_matches_upper_bound
Xapian::doccount get_uncollapsed_matches_upper_bound() const
Upper bound on the total number of matching documents before collapsing.
Xapian::LatLongCoordsIterator::operator==
bool operator==(const LatLongCoordsIterator &other) const
Equality test for LatLongCoordsIterator objects.
Definition: geospatial.h:199
Xapian::DPHWeight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::Query::empty
bool empty() const
Check if this query is Xapian::Query::MatchNothing.
Definition: query.h:515
Xapian::Weight::get_average_length
Xapian::doclength get_average_length() const
The average length of a document in the collection.
Definition: weight.h:347
Xapian::TermGenerator::get_termpos
Xapian::termpos get_termpos() const
Get the current term position.
Xapian::LatLongDistanceKeyMaker
KeyMaker subclass which sorts by distance from a latitude/longitude.
Definition: geospatial.h:551
Xapian::DLHWeight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::DatabaseOpeningError::DatabaseOpeningError
DatabaseOpeningError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:597
Xapian::LatLongDistancePostingSource
Posting source which returns a weight based on geospatial distance.
Definition: geospatial.h:455
Xapian::Weight::get_reltermfreq
Xapian::doccount get_reltermfreq() const
The number of relevant documents which this term indexes.
Definition: weight.h:353
Xapian::StemImplementation::StemImplementation
StemImplementation()
Default constructor.
Definition: stem.h:49
Xapian::LatLongCoordsIterator::operator++
DerefWrapper_< LatLongCoord > operator++(int)
Advance the iterator to the next position (postfix version).
Definition: geospatial.h:192
Xapian::LatLongCoord::latitude
double latitude
A latitude, as decimal degrees.
Definition: geospatial.h:88
enquire.h
API for running queries.
Xapian::DLHWeight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::PL2PlusWeight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the weight contribution for this object's term to a document.
Xapian::TfIdfWeight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterm) const
Calculate the weight contribution for this object's term to a document.
Xapian::MSetIterator::get_collapse_count
Xapian::doccount get_collapse_count() const
Return a count of the number of collapses done onto the current key.
Xapian::GreatCircleMetric::GreatCircleMetric
GreatCircleMetric()
Construct a GreatCircleMetric.
Xapian::Database::term_exists
bool term_exists(const std::string &tname) const
Check if a given term exists in the database.
Xapian::DecreasingValueWeightPostingSource::range_start
Xapian::docid range_start
Start of range of docids for which weights are known to be decreasing.
Definition: postingsource.h:632
Xapian::TermIterator::operator++
TermIterator & operator++()
Advance the iterator to the next position.
Xapian::Stem::operator()
std::string operator()(const std::string &word) const
Stem a word.
Xapian::MatchSpy::serialise
virtual std::string serialise() const
Return this object's parameters serialised as a single string.
valuesetmatchdecider.h
MatchDecider subclass for filtering results by value.
Xapian::BM25Weight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::Query::get_unique_terms_begin
const TermIterator get_unique_terms_begin() const
Begin iterator for unique terms in the query object.
Xapian::BM25PlusWeight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::LatLongCoords::get_description
std::string get_description() const
Return a string describing this object.
Xapian::WritableDatabase::cancel_transaction
void cancel_transaction()
Abort the transaction currently in progress, discarding the pending modifications made to the databas...
Xapian::Query::unserialise
static const Query unserialise(const std::string &serialised, const Registry &reg=Registry())
Unserialise a string and return a Query object.
Xapian::ESetIterator::get_weight
double get_weight() const
Get the weight for the current position.
Xapian::IneB2Weight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
Xapian::LMWeight
Xapian::Weight subclass implementing the Language Model formula.
Definition: weight.h:1384
Xapian::Weight::get_collection_freq
Xapian::termcount get_collection_freq() const
The collection frequency of the term.
Definition: weight.h:356
Xapian::PostingIterator::get_description
std::string get_description() const
Return a string describing this object.
Xapian::ESetIterator::operator--
ESetIterator & operator--()
Move the iterator to the previous position.
Definition: eset.h:197
Xapian::QueryParser::get_description
std::string get_description() const
Return a string describing this object.
Xapian::IneB2Weight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::ESet::get_ebound
Xapian::termcount get_ebound() const
Return a bound on the full size of this ESet object.
Xapian::Stem::get_description
std::string get_description() const
Return a string describing this object.
Xapian::Unicode::FORMAT
@ FORMAT
Other, format (Cf)
Definition: unicode.h:237
Xapian::BM25PlusWeight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterm) const
Calculate the weight contribution for this object's term to a document.
Xapian::QueryParser::add_boolean_prefix
void add_boolean_prefix(const std::string &field, const std::string &prefix, bool exclusive)
Add a boolean term prefix allowing the user to restrict a search with a boolean filter specified in t...
Definition: queryparser.h:1176
Xapian::Weight::get_rset_size
Xapian::doccount get_rset_size() const
The number of documents marked as relevant.
Definition: weight.h:344
Xapian::FixedWeightPostingSource::at_end
bool at_end() const
Return true if the current position is past the last entry in this list.
Xapian::docid
unsigned XAPIAN_DOCID_BASE_TYPE docid
A unique identifier for a document.
Definition: types.h:52
Xapian::Error::get_type
const char * get_type() const
The type of this error (e.g. "DocNotFoundError".)
Definition: error.h:117
Xapian::DecreasingValueWeightPostingSource
Read weights from a value which is known to decrease as docid increases.
Definition: postingsource.h:626
Xapian::PositionIterator::operator++
DerefWrapper_< Xapian::termpos > operator++(int)
Advance the iterator to the next position (postfix version).
Definition: positioniterator.h:96
Xapian::PostingSource::get_maxweight
double get_maxweight() const
Return the currently set upper bound on what get_weight() can return.
Definition: postingsource.h:131
Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker
LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoords &centre_)
Construct a LatLongDistanceKeyMaker.
Definition: geospatial.h:614
Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker
LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoords &centre_, const LatLongMetric &metric_)
Construct a LatLongDistanceKeyMaker.
Definition: geospatial.h:594
Xapian::ValuePostingSource::get_started
bool get_started() const
Flag indicating if we've started (true if we have).
Definition: postingsource.h:531
termgenerator.h
parse free text and generate terms
Xapian::WritableDatabase
This class provides read/write access to a database.
Definition: database.h:785
Xapian::PL2PlusWeight::unserialise
PL2PlusWeight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::DBCOMPACT_MULTIPASS
const int DBCOMPACT_MULTIPASS
If merging more than 3 databases, merge the postlists in multiple passes.
Definition: constants.h:262
Xapian::RangeProcessor::RangeProcessor
RangeProcessor()
Default constructor.
Definition: queryparser.h:165
Xapian::DocNotFoundError::DocNotFoundError
DocNotFoundError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:698
Xapian::TradWeight::unserialise
TradWeight * unserialise(const std::string &serialised) const
Unserialise parameters.
Xapian::TfIdfWeight::TfIdfWeight
TfIdfWeight()
Construct a TfIdfWeight using the default normalizations ("ntn").
Definition: weight.h:487
Xapian::PL2PlusWeight::get_maxpart
double get_maxpart() const
Return an upper bound on what get_sumpart() can return for any document.
Xapian::MatchSpy::release
MatchSpy * release()
Start reference counting this object.
Definition: matchspy.h:184
Xapian::Compactor::set_destdir
void set_destdir(const std::string &destdir)
Set where to write the output.
Xapian::ValuePostingSource::skip_to
void skip_to(Xapian::docid min_docid, double min_wt)
Advance to the specified docid.
Xapian::PostingSource::get_docid
virtual Xapian::docid get_docid() const =0
Return the current docid.
Xapian
The Xapian namespace contains public interfaces for the Xapian library.
Definition: error.h:34
Xapian::DatabaseLockError::DatabaseLockError
DatabaseLockError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:517
Xapian::WildcardError::WildcardError
WildcardError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:1029
Xapian::GreatCircleMetric
Calculate the great-circle distance between two coordinates on a sphere.
Definition: geospatial.h:399
Xapian::Unicode::CURRENCY_SYMBOL
@ CURRENCY_SYMBOL
Symbol, currency (Sc)
Definition: unicode.h:248
Xapian::Enquire::set_sort_by_key
void set_sort_by_key(Xapian::KeyMaker *sorter, bool reverse)
Set the sorting to be by key generated from values only.
Xapian::Utf8Iterator::assign
void assign(const std::string &s)
Assign a new string to the iterator.
Definition: unicode.h:92
Xapian::NetworkTimeoutError::NetworkTimeoutError
NetworkTimeoutError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:869
Xapian::Stem::Stem
Stem(const Stem &o)
Copy constructor.
Xapian::DecreasingValueWeightPostingSource::get_description
std::string get_description() const
Return a string describing this object.
Xapian::IfB2Weight::name
std::string name() const
Return the name of this weighting scheme.
Xapian::ExpandDecider::~ExpandDecider
virtual ~ExpandDecider()
Virtual destructor, because we have virtual methods.
Xapian::WritableDatabase::add_spelling
void add_spelling(const std::string &word, Xapian::termcount freqinc=1) const
Add a word to the spelling dictionary.
Xapian::ValueCountMatchSpy::operator()
void operator()(const Xapian::Document &doc, double wt)
Implementation of virtual operator().
Xapian::QueryParser::set_stemmer
void set_stemmer(const Xapian::Stem &stemmer)
Set the stemmer.
Xapian::DatabaseCreateError::DatabaseCreateError
DatabaseCreateError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:475
Xapian::ValueCountMatchSpy::top_values_end
TermIterator top_values_end(size_t) const
End iterator corresponding to top_values_begin()
Definition: matchspy.h:272
Xapian::Compactor::compaction_level
compaction_level
Compaction level.
Definition: compactor.h:48
Xapian::ValueCountMatchSpy::values_begin
TermIterator values_begin() const
Get an iterator over the values seen in the slot.
Xapian::Utf8Iterator::Utf8Iterator
Utf8Iterator(const char *p_)
Create an iterator given a pointer to a null terminated string.
Xapian::DatabaseClosedError::DatabaseClosedError
DatabaseClosedError(const std::string &msg_, int errno_)
Construct from message and errno value.
Definition: error.h:1121
Xapian::LatLongCoords::end
LatLongCoordsIterator end() const
Get an end iterator for the coordinates.
Definition: geospatial.h:243
Xapian::MatchSpy::~MatchSpy
virtual ~MatchSpy()
Virtual destructor, because we have virtual methods.
Xapian::TfIdfWeight
Xapian::Weight subclass implementing the tf-idf weighting scheme.
Definition: weight.h:425
Xapian::Query
Class representing a query.
Definition: query.h:46
Xapian::PostingIterator::skip_to
void skip_to(Xapian::docid did)
Advance the iterator to document did.
Xapian::ValueCountMatchSpy::values_end
TermIterator values_end() const
End iterator corresponding to values_begin()
Definition: matchspy.h:255
Xapian::QueryParser::set_max_wildcard_expansion
void set_max_wildcard_expansion(Xapian::termcount)
Specify the maximum expansion of a wildcard.
Definition: queryparser.h:1268
Xapian::TfIdfWeight::serialise
std::string serialise() const
Return this object's parameters serialised as a single string.
Xapian::MSetIterator::operator*
Xapian::docid operator*() const
Get the numeric document id for the current position.
Xapian::Database::positionlist_begin
PositionIterator positionlist_begin(Xapian::docid did, const std::string &tname) const
An iterator pointing to the start of the position list for a given term in a given document.
Xapian::ESetIterator::operator+
ESetIterator operator+(difference_type n) const
Return the iterator incremented by n positions.
Definition: eset.h:248
Xapian::Compactor::set_renumber
void set_renumber(bool renumber)
Set whether to preserve existing document id values.
Definition: compactor.h:90
Xapian::ESetIterator::operator++
ESetIterator operator++(int)
Advance the iterator to the next position (postfix version).
Definition: eset.h:190
Xapian::LatLongCoords::empty
bool empty() const
Return true if and only if there are no coordinates in the container.
Definition: geospatial.h:254
Xapian::MSet::swap
void swap(MSet &o)
Efficiently swap this MSet object with another.
Definition: mset.h:286
Xapian::TfIdfWeight::TfIdfWeight
TfIdfWeight(const std::string &normalizations)
Construct a TfIdfWeight.
Xapian::BB2Weight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::LatLongDistancePostingSource::serialise
std::string serialise() const
Serialise object parameters into a string.
constinfo.h
Mechanism for accessing a struct of constant information.
Xapian::IfB2Weight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
Xapian::QueryParser::FLAG_WILDCARD
@ FLAG_WILDCARD
Support wildcards.
Definition: queryparser.h:801
Xapian::RangeError
RangeError indicates an attempt to access outside the bounds of a container.
Definition: error.h:971
Xapian::FixedWeightPostingSource::name
std::string name() const
Name of the posting source class.
Xapian::PostingSource::check
virtual bool check(Xapian::docid did, double min_wt)
Check if the specified docid occurs.
Xapian::RangeProcessor::~RangeProcessor
virtual ~RangeProcessor()
Destructor.
Xapian::TermGenerator::index_text_without_positions
void index_text_without_positions(const std::string &text, Xapian::termcount wdf_inc=1, const std::string &prefix=std::string())
Index some text in a std::string without positional information.
Definition: termgenerator.h:246
Xapian::QueryParser::add_boolean_prefix
void add_boolean_prefix(const std::string &field, Xapian::FieldProcessor *proc, bool exclusive)
Register a FieldProcessor for a boolean prefix.
Definition: queryparser.h:1196
Xapian::LatLongMetric::operator()
double operator()(const LatLongCoords &a, const char *b_ptr, size_t b_len) const
Return the distance between two coordinate lists, in metres.
Xapian::PostingIterator::operator++
DerefWrapper_< Xapian::docid > operator++(int)
Advance the iterator to the next position (postfix version).
Definition: postingiterator.h:117
Xapian::PostingSource::next
virtual void next(double min_wt)=0
Advance the current position to the next matching document.
Xapian::RangeProcessor::slot
Xapian::valueno slot
The value slot to process.
Definition: queryparser.h:145
Xapian::ValuePostingSource::ValuePostingSource
ValuePostingSource(Xapian::valueno slot_)
Construct a ValuePostingSource.
Xapian::Query::Query
Query(Xapian::PostingSource *source)
Construct a Query object for a PostingSource.
Xapian::MSetIterator::operator-
MSetIterator operator-(difference_type n) const
Return the iterator decremented by n positions.
Definition: mset.h:447
Xapian::PostingSource::init
virtual void init(const Database &db)=0
Set this PostingSource to the start of the list of postings.
Xapian::LatLongDistancePostingSource::next
void next(double min_wt)
Advance the current position to the next matching document.
Xapian::ESet::begin
ESetIterator begin() const
Return iterator pointing to the first item in this ESet.
Definition: eset.h:345
Xapian::WritableDatabase::delete_document
void delete_document(Xapian::docid did)
Delete a document from the database.
Xapian::Document::termlist_count
Xapian::termcount termlist_count() const
The length of the termlist - i.e.
Xapian::ValueWeightPostingSource::get_weight
double get_weight() const
Return the weight contribution for the current document.
Xapian::Stem::operator=
Stem & operator=(const Stem &o)
Assignment.
Xapian::RangeProcessor::check_range
Xapian::Query check_range(const std::string &b, const std::string &e)
Check prefix/suffix on range.
Xapian::ESetIterator::ESetIterator
ESetIterator()
Create an unpositioned ESetIterator.
Definition: eset.h:178
Xapian::Database::get_doclength_lower_bound
Xapian::termcount get_doclength_lower_bound() const
Get a lower bound on the length of a document in this DB.
Xapian::operator!=
bool operator!=(const ESetIterator &a, const ESetIterator &b)
Inequality test for ESetIterator objects.
Definition: eset.h:287
Xapian::RSet::remove_document
void remove_document(Xapian::docid did)
Remove a document from the relevance set.
Xapian::QueryParser::add_prefix
void add_prefix(const std::string &field, Xapian::FieldProcessor *proc)
Register a FieldProcessor.
Xapian::Query::Query
Query(double factor, const Xapian::Query &subquery)
Scale using OP_SCALE_WEIGHT.
Xapian::ValueWeightPostingSource::init
void init(const Database &db_)
Set this PostingSource to the start of the list of postings.
Xapian::FieldProcessor::FieldProcessor
FieldProcessor()
Default constructor.
Definition: queryparser.h:731
Xapian::Database::get_spelling_suggestion
std::string get_spelling_suggestion(const std::string &word, unsigned max_edit_distance=2) const
Suggest a spelling correction.
geospatial.h
Geospatial search support routines.
Xapian::DLHWeight::get_sumextra
double get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the term-independent weight component for a document.
Xapian::DB_NO_TERMLIST
const int DB_NO_TERMLIST
When creating a database, don't create a termlist table.
Definition: constants.h:136
Xapian::Document
A handle representing a document in a Xapian database.
Definition: document.h:61
Xapian::Document::values_begin
ValueIterator values_begin() const
Iterator for the values in this document.
Xapian::Query::Query
Query(op op_, const std::string &pattern, Xapian::termcount max_expansion=0, int max_type=WILDCARD_LIMIT_ERROR, op combiner=OP_SYNONYM)
Query constructor for OP_WILDCARD queries.
Xapian::BM25PlusWeight
Xapian::Weight subclass implementing the BM25+ probabilistic formula.
Definition: weight.h:617
Xapian::DB_BACKEND_CHERT
const int DB_BACKEND_CHERT
Use the chert backend.
Definition: constants.h:170
Xapian::PostingSource::serialise
virtual std::string serialise() const
Serialise object parameters into a string.
Xapian::MSet::get_termweight
double get_termweight(const std::string &term) const
Get the term weight of a term.
Xapian::ValueIterator::operator++
ValueIterator & operator++()
Advance the iterator to the next position.
Xapian::Database
This class is used to access a database, or a group of databases.
Definition: database.h:68
Xapian::ESetIterator::operator*
std::string operator*() const
Get the term at the current position.
Xapian::Enquire::set_collapse_key
void set_collapse_key(Xapian::valueno collapse_key, Xapian::doccount collapse_max=1)
Set the collapse key to use for queries.
Xapian::DateValueRangeProcessor::DateValueRangeProcessor
DateValueRangeProcessor(Xapian::valueno slot_, const char *str_, bool prefix_=true, bool prefer_mdy_=false, int epoch_year_=1970)
Constructor.
Definition: queryparser.h:620
Xapian::MSet::get_description
std::string get_description() const
Return a string describing this object.
Xapian::Enquire::docid_order
docid_order
Ordering of docids.
Definition: enquire.h:322
Xapian::DecreasingValueWeightPostingSource::clone
DecreasingValueWeightPostingSource * clone() const
Clone the posting source.
Xapian::Database::Database
Database()
Create a Database with no databases in.
Xapian::DLHWeight::get_maxextra
double get_maxextra() const
Return an upper bound on what get_sumextra() can return for any document.
mset.h
Class representing a list of search results.
Xapian::Query::Query
Query(op op_, Xapian::valueno slot, const std::string &range_lower, const std::string &range_upper)
Construct a Query object for a value range.
Xapian::RSet::~RSet
~RSet()
Destructor.
Xapian::UnimplementedError::UnimplementedError
UnimplementedError(const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
General purpose constructor.
Definition: error.h:341
Xapian::LMWeight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterm) const
Calculate the weight contribution for this object's term to a document.
Xapian::PositionIterator::~PositionIterator
~PositionIterator()
Destructor.
Definition: positioniterator.h:85
Xapian::ErrorHandler::~ErrorHandler
virtual ~ErrorHandler()
We require a virtual destructor because we have virtual methods.
Xapian::RSet::contains
bool contains(const Xapian::MSetIterator &i) const
Test if a given document in the relevance set.
Definition: enquire.h:110
Xapian::Query::LEAF_MATCH_ALL
@ LEAF_MATCH_ALL
Value returned by get_type() for MatchAll or equivalent.
Definition: query.h:267
Xapian::Enquire::get_mset
MSet get_mset(Xapian::doccount first, Xapian::doccount maxitems, const RSet *omrset, const MatchDecider *mdecider=0) const
Get (a portion of) the match set for the current query.
Definition: enquire.h:576
Xapian::WritableDatabase::add_synonym
void add_synonym(const std::string &term, const std::string &synonym) const
Add a synonym for a term.
Xapian::KeyMaker::KeyMaker
KeyMaker()
Default constructor.
Definition: keymaker.h:51
Xapian::PositionIterator::PositionIterator
PositionIterator(const PositionIterator &o)
Copy constructor.
Xapian::Document::add_boolean_term
void add_boolean_term(const std::string &term)
Add a boolean filter term to the document.
Definition: document.h:191
Xapian::DLHWeight::get_sumpart
double get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterms) const
Calculate the weight contribution for this object's term to a document.
Xapian::QueryParser::add_boolean_prefix
void add_boolean_prefix(const std::string &field, Xapian::FieldProcessor *proc, const std::string *grouping=NULL)
Register a FieldProcessor for a boolean prefix.
Xapian::NetworkError
Indicates a problem communicating with a remote database.
Definition: error.h:803
Xapian::Stem::get_available_languages
static std::string get_available_languages()
Return a list of available languages.
Definition: stem.h:181
Xapian::RSet::get_description
std::string get_description() const
Return a string describing this object.
Xapian::TermIterator::get_description
std::string get_description() const
Return a string describing this object.