A posting source which generates weights from a value slot. More...

#include <postingsource.h>

Inheritance diagram for Xapian::ValuePostingSource:

Collaboration diagram for Xapian::ValuePostingSource:

Public Member Functions
	ValuePostingSource (Xapian::valueno slot_)
	Construct a ValuePostingSource. More...

Xapian::doccount	get_termfreq_min () const
	A lower bound on the number of documents this object can return. More...

Xapian::doccount	get_termfreq_est () const
	An estimate of the number of documents this object can return. More...

Xapian::doccount	get_termfreq_max () const
	An upper bound on the number of documents this object can return. More...

void	next (double min_wt)
	Advance the current position to the next matching document. More...

void	skip_to (Xapian::docid min_docid, double min_wt)
	Advance to the specified docid. More...

bool	check (Xapian::docid min_docid, double min_wt)
	Check if the specified docid occurs. More...

bool	at_end () const
	Return true if the current position is past the last entry in this list. More...

Xapian::docid	get_docid () const
	Return the current docid. More...

void	init (const Database &db_)
	Set this PostingSource to the start of the list of postings. More...

Xapian::Database	get_database () const
	The database we're reading values from. More...

Xapian::valueno	get_slot () const
	The slot we're reading values from. More...

std::string	get_value () const
	Read current value. More...

void	done ()
	End the iteration. More...

bool	get_started () const
	Flag indicating if we've started (true if we have). More...

void	set_termfreq_min (Xapian::doccount termfreq_min_)
	Set a lower bound on the term frequency. More...

void	set_termfreq_est (Xapian::doccount termfreq_est_)
	An estimate of the term frequency. More...

void	set_termfreq_max (Xapian::doccount termfreq_max_)
	An upper bound on the term frequency. More...

Public Member Functions inherited from Xapian::PostingSource
	PostingSource ()
	Allow subclasses to be instantiated. More...

virtual	~PostingSource ()

void	set_maxweight (double max_weight)
	Specify an upper bound on what get_weight() will return from now on. More...

double	get_maxweight () const
	Return the currently set upper bound on what get_weight() can return. More...

virtual double	get_weight () const
	Return the weight contribution for the current document. More...

virtual PostingSource *	clone () const
	Clone the posting source. More...

virtual std::string	name () const
	Name of the posting source class. More...

virtual std::string	serialise () const
	Serialise object parameters into a string. More...

virtual PostingSource *	unserialise (const std::string &serialised) const
	Create object given string serialisation returned by serialise(). More...

virtual PostingSource *	unserialise_with_registry (const std::string &serialised, const Registry &registry) const
	Create object given string serialisation returned by serialise(). More...

virtual std::string	get_description () const
	Return a string describing this object. More...

PostingSource *	release ()
	Start reference counting this object. More...

const PostingSource *	release () const
	Start reference counting this object. More...

Public Member Functions inherited from Xapian::Internal::opt_intrusive_base
	opt_intrusive_base (const opt_intrusive_base &)

opt_intrusive_base &	operator= (const opt_intrusive_base &)

	opt_intrusive_base ()
	Construct object which is initially not reference counted. More...

virtual	~opt_intrusive_base ()

void	ref () const

void	unref () const

Protected Attributes
Xapian::Database &	db
	The database we're reading values from. More...

Xapian::valueno &	slot
	The slot we're reading values from. More...

Xapian::ValueIterator &	value_it
	Value stream iterator. More...

bool &	started
	Flag indicating if we've started (true if we have). More...

Xapian::doccount &	termfreq_min
	A lower bound on the term frequency. More...

Xapian::doccount &	termfreq_est
	An estimate of the term frequency. More...

Xapian::doccount &	termfreq_max
	An upper bound on the term frequency. More...

Private Attributes
Xapian::Database	real_db

Xapian::valueno	real_slot

Xapian::ValueIterator	real_value_it

bool	real_started

Xapian::doccount	real_termfreq_min

Xapian::doccount	real_termfreq_est

Xapian::doccount	real_termfreq_max

Additional Inherited Members
Public Attributes inherited from Xapian::Internal::opt_intrusive_base
unsigned	_refs
	Reference count. More...

Protected Member Functions inherited from Xapian::Internal::opt_intrusive_base
void	release () const
	Start reference counting. More...

Detailed Description

A posting source which generates weights from a value slot.

This is a base class for classes which generate weights using values stored in the specified slot. For example, ValueWeightPostingSource uses sortable_unserialise to convert values directly to weights.

The upper bound on the weight returned is set to DBL_MAX. Subclasses should call set_maxweight() in their init() methods after calling ValuePostingSource::init() if they know a tighter bound on the weight.

Definition at line 401 of file postingsource.h.

Constructor & Destructor Documentation

◆ ValuePostingSource()

Xapian::ValuePostingSource::ValuePostingSource ( Xapian::valueno slot_ )

explicit

Construct a ValuePostingSource.

Parameters

slot_ The value slot to read values from.

Definition at line 121 of file postingsource.cc.

Member Function Documentation

◆ at_end()

bool Xapian::ValuePostingSource::at_end ( ) const

virtual

Return true if the current position is past the last entry in this list.

At least one of next(), skip_to() or check() will be called before this method is first called.

Implements Xapian::PostingSource.

Definition at line 204 of file postingsource.cc.

References real_db, real_slot, real_started, real_value_it, and Xapian::Database::valuestream_end().

Referenced by Xapian::LatLongDistancePostingSource::check(), DEFINE_TESTCASE(), Xapian::ValueWeightPostingSource::get_weight(), Xapian::LatLongDistancePostingSource::next(), Xapian::DecreasingValueWeightPostingSource::skip_if_in_range(), and Xapian::LatLongDistancePostingSource::skip_to().

◆ check()

bool Xapian::ValuePostingSource::check	(	Xapian::docid	did,
		double	min_wt
	)

virtual

Check if the specified docid occurs.

The caller is required to ensure that the specified document id did actually exists in the database. If it does, it must move to that document id, and return true. If it does not, it may either:

return true, having moved to a definite position (including "at_end"), which must be the same position as skip_to() would have moved to.

or

return false, having moved to an "indeterminate" position, such that a subsequent call to next() or skip_to() will move to the next matching position after did.

Generally, this method should act like skip_to() and return true if that can be done at little extra cost.

Otherwise it should simply check if a particular docid is present, returning true if it is, and false if it isn't.

The default implementation calls skip_to() and always returns true.

Xapian will always call init() on a PostingSource before calling this for the first time.

Note: in the case of a multi-database search, the docid specified is the docid in the single subdatabase relevant to this posting source. See the init() method for details.

Parameters

did	The document id to check.
min_wt	The minimum weight contribution that is needed (this is just a hint which subclasses may ignore).

Reimplemented from Xapian::PostingSource.

Reimplemented in Xapian::DecreasingValueWeightPostingSource.

Definition at line 187 of file postingsource.cc.

References Xapian::ValueIterator::check(), Xapian::PostingSource::get_maxweight(), real_db, real_slot, real_started, real_value_it, Xapian::Database::valuestream_begin(), and Xapian::Database::valuestream_end().

Referenced by Xapian::LatLongDistancePostingSource::check(), Xapian::DecreasingValueWeightPostingSource::check(), and DEFINE_TESTCASE().

◆ done()

void Xapian::ValuePostingSource::done ( )

inline

End the iteration.

Calls to at_end() will return true after calling this method.

Added in 1.2.23 and 1.3.5.

Definition at line 522 of file postingsource.h.

References Xapian::Database::valuestream_end().

Referenced by Xapian::DecreasingValueWeightPostingSource::check(), Xapian::DecreasingValueWeightPostingSource::next(), Xapian::DecreasingValueWeightPostingSource::skip_if_in_range(), and Xapian::DecreasingValueWeightPostingSource::skip_to().

◆ get_database()

Xapian::Database Xapian::ValuePostingSource::get_database ( ) const

inline

The database we're reading values from.

Added in 1.2.23 and 1.3.5.

Definition at line 502 of file postingsource.h.

Referenced by Xapian::ValueWeightPostingSource::init(), and Xapian::DecreasingValueWeightPostingSource::init().

◆ get_docid()

Xapian::docid Xapian::ValuePostingSource::get_docid ( ) const

virtual

Return the current docid.

This method may assume that it will only be called when there is a "current document". See get_weight() for details.

Note: in the case of a multi-database search, the returned docid should be in the single subdatabase relevant to this posting source. See the init() method for details.

Implements Xapian::PostingSource.

Definition at line 210 of file postingsource.cc.

References Xapian::ValueIterator::get_docid(), and real_value_it.

Referenced by DEFINE_TESTCASE(), and Xapian::DecreasingValueWeightPostingSource::skip_if_in_range().

◆ get_slot()

Xapian::valueno Xapian::ValuePostingSource::get_slot ( ) const

inline

The slot we're reading values from.

Added in 1.2.23 and 1.3.5.

Definition at line 508 of file postingsource.h.

Referenced by Xapian::LatLongDistancePostingSource::clone(), Xapian::ValueWeightPostingSource::clone(), Xapian::DecreasingValueWeightPostingSource::clone(), Xapian::ValueMapPostingSource::clone(), Xapian::LatLongDistancePostingSource::get_description(), Xapian::ValueWeightPostingSource::get_description(), Xapian::ValueMapPostingSource::get_description(), Xapian::ValueWeightPostingSource::init(), Xapian::LatLongDistancePostingSource::serialise(), Xapian::ValueWeightPostingSource::serialise(), Xapian::DecreasingValueWeightPostingSource::serialise(), and Xapian::ValueMapPostingSource::serialise().

◆ get_started()

bool Xapian::ValuePostingSource::get_started ( ) const

inline

Flag indicating if we've started (true if we have).

Added in 1.2.23 and 1.3.5.

Definition at line 531 of file postingsource.h.

Referenced by Xapian::ValueWeightPostingSource::get_weight().

◆ get_termfreq_est()

Xapian::doccount Xapian::ValuePostingSource::get_termfreq_est ( ) const

virtual

An estimate of the number of documents this object can return.

It must always be true that:

get_termfreq_min() <= get_termfreq_est() <= get_termfreq_max()

Xapian will always call init() on a PostingSource before calling this for the first time.

Implements Xapian::PostingSource.

Definition at line 140 of file postingsource.cc.

References real_termfreq_est.

Referenced by DEFINE_TESTCASE().

◆ get_termfreq_max()

Xapian::doccount Xapian::ValuePostingSource::get_termfreq_max ( ) const

virtual

An upper bound on the number of documents this object can return.

Xapian will always call init() on a PostingSource before calling this for the first time.

Implements Xapian::PostingSource.

Definition at line 146 of file postingsource.cc.

References real_termfreq_max.

Referenced by DEFINE_TESTCASE().

◆ get_termfreq_min()

Xapian::doccount Xapian::ValuePostingSource::get_termfreq_min ( ) const

virtual

A lower bound on the number of documents this object can return.

Xapian will always call init() on a PostingSource before calling this for the first time.

Implements Xapian::PostingSource.

Definition at line 134 of file postingsource.cc.

References real_termfreq_min.

Referenced by DEFINE_TESTCASE().

◆ get_value()

std::string Xapian::ValuePostingSource::get_value ( ) const

inline

Read current value.

Added in 1.2.23 and 1.3.5.

Definition at line 514 of file postingsource.h.

Referenced by Xapian::ValueWeightPostingSource::get_weight(), and Xapian::ValueMapPostingSource::get_weight().

◆ init()

void Xapian::ValuePostingSource::init ( const Database & db )

virtual

Set this PostingSource to the start of the list of postings.

This is called automatically by the matcher prior to each query being processed.

If a PostingSource is used for multiple searches, init() will therefore be called multiple times, and must handle this by using the database passed in the most recent call.

Parameters

db	The database which the PostingSource should iterate through.

Note: in the case of a multi-database search, a separate PostingSource will be used for each database (the separate PostingSources will be obtained using clone()), and each PostingSource will be passed one of the sub-databases as the db parameter here. The db parameter will therefore always refer to a single database. All docids passed to, or returned from, the PostingSource refer to docids in that single database, rather than in the multi-database.

Implements Xapian::PostingSource.

Reimplemented in Xapian::ValueMapPostingSource, Xapian::DecreasingValueWeightPostingSource, CheckBoundsPostingSource, and Xapian::ValueWeightPostingSource.

Definition at line 216 of file postingsource.cc.

References Xapian::Database::get_value_freq(), real_db, real_slot, real_started, real_termfreq_est, real_termfreq_max, real_termfreq_min, and Xapian::PostingSource::set_maxweight().

Referenced by Xapian::LatLongDistancePostingSource::init(), Xapian::ValueWeightPostingSource::init(), and Xapian::ValueMapPostingSource::init().

◆ next()

void Xapian::ValuePostingSource::next ( double min_wt )

virtual

Advance the current position to the next matching document.

The PostingSource starts before the first entry in the list, so next(), skip_to() or check() must be called before any methods which need the context of the current position.

Xapian will always call init() on a PostingSource before calling this for the first time.

Parameters

min_wt The minimum weight contribution that is needed (this is just a hint which subclasses may ignore).

Implements Xapian::PostingSource.

Reimplemented in Xapian::DecreasingValueWeightPostingSource, and SlowDecreasingValueWeightPostingSource.

Definition at line 152 of file postingsource.cc.

References Xapian::PostingSource::get_maxweight(), real_db, real_slot, real_started, real_value_it, Xapian::Database::valuestream_begin(), and Xapian::Database::valuestream_end().

Referenced by DEFINE_TESTCASE(), Xapian::LatLongDistancePostingSource::next(), Xapian::DecreasingValueWeightPostingSource::next(), and Xapian::LatLongDistancePostingSource::skip_to().

◆ set_termfreq_est()

void Xapian::ValuePostingSource::set_termfreq_est ( Xapian::doccount termfreq_est_ )

inline

An estimate of the term frequency.

Subclasses should set this if they are overriding the next(), skip_to() or check() methods.

Added in 1.2.23 and 1.3.5.

Definition at line 551 of file postingsource.h.

◆ set_termfreq_max()

void Xapian::ValuePostingSource::set_termfreq_max ( Xapian::doccount termfreq_max_ )

inline

An upper bound on the term frequency.

Subclasses should set this if they are overriding the next(), skip_to() or check() methods.

Added in 1.2.23 and 1.3.5.

Definition at line 562 of file postingsource.h.

◆ set_termfreq_min()

void Xapian::ValuePostingSource::set_termfreq_min ( Xapian::doccount termfreq_min_ )

inline

Set a lower bound on the term frequency.

Subclasses should set this if they are overriding the next(), skip_to() or check() methods to return fewer documents.

Added in 1.2.23 and 1.3.5.

Definition at line 540 of file postingsource.h.

Referenced by Xapian::LatLongDistancePostingSource::init().

◆ skip_to()

void Xapian::ValuePostingSource::skip_to	(	Xapian::docid	did,
		double	min_wt
	)

virtual

Advance to the specified docid.

If the specified docid isn't in the list, position ourselves on the first document after it (or at_end() if no greater docids are present).

If the current position is already the specified docid, this method will leave the position unmodified.

If the specified docid is earlier than the current position, the behaviour is unspecified. A sensible behaviour would be to leave the current position unmodified, but it is also reasonable to move to the specified docid.

The default implementation calls next() repeatedly, which works but skip_to() can often be implemented much more efficiently.

Xapian will always call init() on a PostingSource before calling this for the first time.

Note: in the case of a multi-database search, the docid specified is the docid in the single subdatabase relevant to this posting source. See the init() method for details.

Parameters

did	The document id to advance to.
min_wt	The minimum weight contribution that is needed (this is just a hint which subclasses may ignore).

Reimplemented from Xapian::PostingSource.

Reimplemented in Xapian::DecreasingValueWeightPostingSource.

Definition at line 170 of file postingsource.cc.

References Xapian::PostingSource::get_maxweight(), real_db, real_slot, real_started, real_value_it, Xapian::ValueIterator::skip_to(), Xapian::Database::valuestream_begin(), and Xapian::Database::valuestream_end().

Referenced by DEFINE_TESTCASE(), Xapian::DecreasingValueWeightPostingSource::skip_if_in_range(), Xapian::LatLongDistancePostingSource::skip_to(), and Xapian::DecreasingValueWeightPostingSource::skip_to().

Member Data Documentation

◆ db

Xapian::Database& Xapian::ValuePostingSource::db

protected

The database we're reading values from.

Deprecated:: Use get_database() in preference.

Definition at line 428 of file postingsource.h.

◆ real_db

Xapian::Database Xapian::ValuePostingSource::real_db

private

Definition at line 409 of file postingsource.h.

Referenced by at_end(), check(), init(), next(), and skip_to().

◆ real_slot

Xapian::valueno Xapian::ValuePostingSource::real_slot

private

Definition at line 411 of file postingsource.h.

Referenced by at_end(), check(), init(), next(), and skip_to().

◆ real_started

bool Xapian::ValuePostingSource::real_started

private

Definition at line 415 of file postingsource.h.

Referenced by at_end(), check(), init(), next(), and skip_to().

◆ real_termfreq_est

Xapian::doccount Xapian::ValuePostingSource::real_termfreq_est

private

Definition at line 419 of file postingsource.h.

Referenced by get_termfreq_est(), and init().

◆ real_termfreq_max

Xapian::doccount Xapian::ValuePostingSource::real_termfreq_max

private

Definition at line 421 of file postingsource.h.

Referenced by get_termfreq_max(), and init().

◆ real_termfreq_min

Xapian::doccount Xapian::ValuePostingSource::real_termfreq_min

private

Definition at line 417 of file postingsource.h.

Referenced by get_termfreq_min(), and init().

◆ real_value_it

Xapian::ValueIterator Xapian::ValuePostingSource::real_value_it

private

Definition at line 413 of file postingsource.h.

Referenced by at_end(), check(), get_docid(), next(), and skip_to().

◆ slot

Xapian::valueno& Xapian::ValuePostingSource::slot

protected

The slot we're reading values from.

Deprecated:: Use get_slot() in preference.

Definition at line 434 of file postingsource.h.

◆ started

bool& Xapian::ValuePostingSource::started

protected

Flag indicating if we've started (true if we have).

Deprecated:: Use get_started() in preference.

Definition at line 448 of file postingsource.h.

◆ termfreq_est

Xapian::doccount& Xapian::ValuePostingSource::termfreq_est

protected

An estimate of the term frequency.

Subclasses should set this if they are overriding the next(), skip_to() or check() methods.

Deprecated:: Use set_termfreq_est() in preference.

Definition at line 466 of file postingsource.h.

◆ termfreq_max

Xapian::doccount& Xapian::ValuePostingSource::termfreq_max

protected

An upper bound on the term frequency.

Subclasses should set this if they are overriding the next(), skip_to() or check() methods.

Deprecated:: Use set_termfreq_max() in preference.

Definition at line 475 of file postingsource.h.

◆ termfreq_min

Xapian::doccount& Xapian::ValuePostingSource::termfreq_min

protected

A lower bound on the term frequency.

Subclasses should set this if they are overriding the next(), skip_to() or check() methods to return fewer documents.

Deprecated:: Use set_termfreq_min() in preference.

Definition at line 457 of file postingsource.h.

◆ value_it

Xapian::ValueIterator& Xapian::ValuePostingSource::value_it

protected

Value stream iterator.

Deprecated:: Use get_value() in preference to *value_it, and other methods of ValuePostingSource in preference to calling methods of value_it.

Definition at line 442 of file postingsource.h.

The documentation for this class was generated from the following files:

include/xapian/postingsource.h
api/postingsource.cc

Public Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ValuePostingSource()

Member Function Documentation

◆ at_end()

◆ check()

◆ done()

◆ get_database()

◆ get_docid()

◆ get_slot()

◆ get_started()

◆ get_termfreq_est()

◆ get_termfreq_max()

◆ get_termfreq_min()

◆ get_value()

◆ init()

◆ next()

◆ set_termfreq_est()

◆ set_termfreq_max()

◆ set_termfreq_min()

◆ skip_to()

Member Data Documentation

◆ db

◆ real_db

◆ real_slot

◆ real_started

◆ real_termfreq_est

◆ real_termfreq_max

◆ real_termfreq_min

◆ real_value_it

◆ slot

◆ started

◆ termfreq_est

◆ termfreq_max

◆ termfreq_min

◆ value_it