Inheritance diagram for CheckBoundsPostingSource:

Collaboration diagram for CheckBoundsPostingSource:

Public Member Functions
	CheckBoundsPostingSource (Xapian::doccount &doclen_lb_, Xapian::doccount &doclen_ub_)

CheckBoundsPostingSource *	clone () const override
	Clone the posting source. More...

void	reset (const Xapian::Database &database, Xapian::doccount shard_index) override
	Set this PostingSource to the start of the list of postings. More...

Public Member Functions inherited from Xapian::DecreasingValueWeightPostingSource
	DecreasingValueWeightPostingSource (Xapian::valueno slot_, Xapian::docid range_start_=0, Xapian::docid range_end_=0)
	Construct a DecreasingValueWeightPostingSource. More...

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

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

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

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

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

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

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

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

Public Member Functions inherited from Xapian::ValueWeightPostingSource
	ValueWeightPostingSource (Xapian::valueno slot_)
	Construct a ValueWeightPostingSource. More...

Public Member Functions inherited from Xapian::ValuePostingSource
	ValuePostingSource (Xapian::valueno slot_) noexcept
	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...

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...

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 () noexcept
	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 noexcept
	Return the currently set upper bound on what get_weight() can return. More...

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

virtual void	init (const Database &db)
	Older method which did the same job as reset(). 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

Public Attributes
Xapian::doccount &	doclen_lb

Xapian::doccount &	doclen_ub

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

Additional Inherited Members
Protected Member Functions inherited from Xapian::DecreasingValueWeightPostingSource
void	skip_if_in_range (double min_wt)
	Skip the iterator forward if in the decreasing range, and weight is low. More...

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

Protected Attributes inherited from Xapian::DecreasingValueWeightPostingSource
Xapian::docid	range_start
	Start of range of docids for which weights are known to be decreasing. More...

Xapian::docid	range_end
	End of range of docids for which weights are known to be decreasing. More...

double	curr_weight
	Weight at current position. More...

bool	items_at_end
	Flag, set to true if there are docs after the end of the range. More...

Detailed Description

Definition at line 650 of file api_postingsource.cc.

Constructor & Destructor Documentation

◆ CheckBoundsPostingSource()

CheckBoundsPostingSource::CheckBoundsPostingSource	(	Xapian::doccount &	doclen_lb_,
		Xapian::doccount &	doclen_ub_
	)

inline

Definition at line 657 of file api_postingsource.cc.

Member Function Documentation

◆ clone()

CheckBoundsPostingSource* CheckBoundsPostingSource::clone ( ) const

inlineoverridevirtual

Clone the posting source.

The clone should inherit the configuration of the parent, but need not inherit the state. ie, the clone does not need to be in the same iteration position as the original: the matcher will always call reset() on the clone before attempting to move the iterator, or read the information about the current position of the iterator.

This may return NULL to indicate that cloning is not supported. In this case, the PostingSource may only be used with a single-database search.

The default implementation returns NULL.

Note that the returned object will be deallocated by Xapian after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the Xapian API for use from another language) then you can define a static operator delete method in your subclass as shown here: https://trac.xapian.org/ticket/554#comment:1

Reimplemented from Xapian::DecreasingValueWeightPostingSource.

Definition at line 663 of file api_postingsource.cc.

◆ reset()

void CheckBoundsPostingSource::reset	(	const Xapian::Database &	db,
		Xapian::doccount	shard_index
	)

inlineoverridevirtual

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, reset() 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.
shard_index	The 0-based index indicating which shard in a multi-database db is. This can be useful if you have an external source of postings corresponding to each shard.

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.

A default implementation is provided which calls the older init() method to allow existing subclasses to continue to work, but the default implementation of init() throws Xapian::InvalidOperationError so you must override either this method or init(). In new code, override this method in preference.

Since: Added in Xapian 2.0.0.

Reimplemented from Xapian::DecreasingValueWeightPostingSource.

Definition at line 667 of file api_postingsource.cc.

References Xapian::Database::get_doclength_lower_bound(), Xapian::Database::get_doclength_upper_bound(), and Xapian::DecreasingValueWeightPostingSource::reset().

Member Data Documentation

◆ doclen_lb

Xapian::doccount& CheckBoundsPostingSource::doclen_lb

Definition at line 653 of file api_postingsource.cc.

◆ doclen_ub

Xapian::doccount& CheckBoundsPostingSource::doclen_ub

Definition at line 655 of file api_postingsource.cc.

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

tests/api_postingsource.cc

Public Member Functions

Public Attributes

Additional Inherited Members