#include <omenquireinternal.h>

Inheritance diagram for Xapian::MSet::Internal:

Collaboration diagram for Xapian::MSet::Internal:

Public Member Functions
	Internal ()

	Internal (Xapian::doccount firstitem_, Xapian::doccount matches_upper_bound_, Xapian::doccount matches_lower_bound_, Xapian::doccount matches_estimated_, Xapian::doccount uncollapsed_upper_bound_, Xapian::doccount uncollapsed_lower_bound_, Xapian::doccount uncollapsed_estimated_, double max_possible_, double max_attained_, vector< Xapian::Internal::MSetItem > &items_, double percent_factor_)
	Note: destroys parameter items. More...

	~Internal ()

Xapian::Document	get_doc_by_index (Xapian::doccount index) const
	get a document by index in MSet, via the cache. More...

int	convert_to_percent_internal (double wt) const
	Converts a weight to a percentage weight. More...

std::string	snippet (const std::string &text, size_t length, const Xapian::Stem &stemmer, unsigned flags, const std::string &hi_start, const std::string &hi_end, const std::string &omit) const

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

void	fetch_items (Xapian::doccount first, Xapian::doccount last) const
	Fetch items specified into the document cache. More...

Public Member Functions inherited from Xapian::Internal::intrusive_base
	intrusive_base ()
	Construct with no references. More...

Public Attributes
double	percent_factor
	Factor to multiply weights by to convert them to percentages. More...

Xapian::Internal::intrusive_ptr< const Enquire::Internal >	enquire
	Xapian::Enquire reference, for getting documents. More...

Xapian::Weight::Internal *	stats
	Provides the term frequency and weight for each term in the query. More...

vector< Xapian::Internal::MSetItem >	items
	A list of items comprising the (selected part of the) MSet. More...

Xapian::doccount	firstitem
	Rank of first item in MSet. More...

Xapian::doccount	matches_lower_bound

Xapian::doccount	matches_estimated

Xapian::doccount	matches_upper_bound

Xapian::doccount	uncollapsed_lower_bound

Xapian::doccount	uncollapsed_estimated

Xapian::doccount	uncollapsed_upper_bound

double	max_possible

double	max_attained

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

Private Member Functions
void	read_docs () const
	Read and cache the documents so far requested. More...

	Internal (const Internal &)
	Copy not allowed. More...

void	operator= (const Internal &)
	Assignment not allowed. More...

Private Attributes
set< Xapian::doccount >	requested_docs
	The set of documents which have been requested but not yet collected. More...

map< Xapian::doccount, Xapian::Document >	indexeddocs
	Cache of documents, indexed by MSet index. More...

std::unordered_map< std::string, double >	snippet_bg_relevance

Detailed Description

Definition at line 206 of file omenquireinternal.h.

Constructor & Destructor Documentation

◆ Internal() [1/3]

Xapian::MSet::Internal::Internal ( const Internal & )

private

Copy not allowed.

◆ Internal() [2/3]

Xapian::MSet::Internal::Internal ( )

inline

Definition at line 259 of file omenquireinternal.h.

◆ Internal() [3/3]

Xapian::MSet::Internal::Internal	(	Xapian::doccount	firstitem_,
		Xapian::doccount	matches_upper_bound_,
		Xapian::doccount	matches_lower_bound_,
		Xapian::doccount	matches_estimated_,
		Xapian::doccount	uncollapsed_upper_bound_,
		Xapian::doccount	uncollapsed_lower_bound_,
		Xapian::doccount	uncollapsed_estimated_,
		double	max_possible_,
		double	max_attained_,
		vector< Xapian::Internal::MSetItem > &	items_,
		double	percent_factor_
	)

inline

Note: destroys parameter items.

Definition at line 273 of file omenquireinternal.h.

References items.

◆ ~Internal()

Xapian::MSet::Internal::~Internal ( )

inline

Definition at line 298 of file omenquireinternal.h.

References stats.

Member Function Documentation

◆ convert_to_percent_internal()

int Xapian::MSet::Internal::convert_to_percent_internal ( double wt ) const

Converts a weight to a percentage weight.

Definition at line 332 of file omenquire.cc.

References LOGCALL, LOGLINE, max_possible, percent_factor, and RETURN.

◆ fetch_items()

void Xapian::MSet::Internal::fetch_items	(	Xapian::doccount	first,
		Xapian::doccount	last
	)		const

Fetch items specified into the document cache.

Definition at line 377 of file omenquire.cc.

References LOGCALL_VOID.

◆ get_description()

string Xapian::MSet::Internal::get_description ( ) const

Return a string describing this object.

Definition at line 403 of file omenquire.cc.

References Xapian::Internal::str().

◆ get_doc_by_index()

Document Xapian::MSet::Internal::get_doc_by_index ( Xapian::doccount index ) const

get a document by index in MSet, via the cache.

Definition at line 350 of file omenquire.cc.

References Assert, LOGCALL, RETURN, and Xapian::Internal::str().

◆ operator=()

void Xapian::MSet::Internal::operator= ( const Internal & )

private

Assignment not allowed.

◆ read_docs()

void Xapian::MSet::Internal::read_docs ( ) const

private

Read and cache the documents so far requested.

Definition at line 426 of file omenquire.cc.

References LOGLINE.

◆ snippet()

string Xapian::MSet::Internal::snippet	(	const std::string &	text,
		size_t	length,
		const Xapian::Stem &	stemmer,
		unsigned	flags,
		const std::string &	hi_start,
		const std::string &	hi_end,
		const std::string &	omit
	)		const

Definition at line 754 of file termgenerator_internal.cc.

References Xapian::check_query(), Xapian::check_term(), Xapian::Unicode::Internal::get_category(), if(), Xapian::Unicode::is_whitespace(), Xapian::Utf8Iterator::left(), Xapian::parse_terms(), Xapian::SnipPipe::pump(), query(), Xapian::MSet::SNIPPET_BACKGROUND_MODEL, startswith(), stemmer, and Xapian::Unicode::UPPERCASE_LETTER.

Member Data Documentation

◆ enquire

Xapian::Internal::intrusive_ptr<const Enquire::Internal> Xapian::MSet::Internal::enquire

Xapian::Enquire reference, for getting documents.

Definition at line 232 of file omenquireinternal.h.

◆ firstitem

Xapian::doccount Xapian::MSet::Internal::firstitem

Rank of first item in MSet.

Definition at line 241 of file omenquireinternal.h.

◆ indexeddocs

map<Xapian::doccount, Xapian::Document> Xapian::MSet::Internal::indexeddocs

mutableprivate

Cache of documents, indexed by MSet index.

Definition at line 218 of file omenquireinternal.h.

◆ items

vector<Xapian::Internal::MSetItem> Xapian::MSet::Internal::items

A list of items comprising the (selected part of the) MSet.

Definition at line 238 of file omenquireinternal.h.

Referenced by Internal().

◆ matches_estimated

Xapian::doccount Xapian::MSet::Internal::matches_estimated

Definition at line 245 of file omenquireinternal.h.

◆ matches_lower_bound

Xapian::doccount Xapian::MSet::Internal::matches_lower_bound

Definition at line 243 of file omenquireinternal.h.

◆ matches_upper_bound

Xapian::doccount Xapian::MSet::Internal::matches_upper_bound

Definition at line 247 of file omenquireinternal.h.

◆ max_attained

double Xapian::MSet::Internal::max_attained

Definition at line 257 of file omenquireinternal.h.

◆ max_possible

double Xapian::MSet::Internal::max_possible

Definition at line 255 of file omenquireinternal.h.

Referenced by convert_to_percent_internal().

◆ percent_factor

double Xapian::MSet::Internal::percent_factor

Factor to multiply weights by to convert them to percentages.

Definition at line 209 of file omenquireinternal.h.

Referenced by convert_to_percent_internal().

◆ requested_docs

set<Xapian::doccount> Xapian::MSet::Internal::requested_docs

mutableprivate

The set of documents which have been requested but not yet collected.

Definition at line 215 of file omenquireinternal.h.

◆ snippet_bg_relevance

std::unordered_map<std::string, double> Xapian::MSet::Internal::snippet_bg_relevance

mutableprivate

Definition at line 228 of file omenquireinternal.h.

◆ stats

Xapian::Weight::Internal* Xapian::MSet::Internal::stats

Provides the term frequency and weight for each term in the query.

Definition at line 235 of file omenquireinternal.h.

Referenced by ~Internal().

◆ uncollapsed_estimated

Xapian::doccount Xapian::MSet::Internal::uncollapsed_estimated

Definition at line 251 of file omenquireinternal.h.

◆ uncollapsed_lower_bound

Xapian::doccount Xapian::MSet::Internal::uncollapsed_lower_bound

Definition at line 249 of file omenquireinternal.h.

◆ uncollapsed_upper_bound

Xapian::doccount Xapian::MSet::Internal::uncollapsed_upper_bound

Definition at line 253 of file omenquireinternal.h.

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

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Internal() [1/3]

◆ Internal() [2/3]

◆ Internal() [3/3]

◆ ~Internal()

Member Function Documentation

◆ convert_to_percent_internal()

◆ fetch_items()

◆ get_description()

◆ get_doc_by_index()

◆ operator=()

◆ read_docs()

◆ snippet()

Member Data Documentation

◆ enquire

◆ firstitem

◆ indexeddocs

◆ items

◆ matches_estimated

◆ matches_lower_bound

◆ matches_upper_bound

◆ max_attained

◆ max_possible

◆ percent_factor

◆ requested_docs

◆ snippet_bg_relevance

◆ stats

◆ uncollapsed_estimated

◆ uncollapsed_lower_bound

◆ uncollapsed_upper_bound