xapian-core  1.4.19
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
Xapian::MSet::Internal Class Reference

#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::Internalenquire
 Xapian::Enquire reference, for getting documents. More...
 
Xapian::Weight::Internalstats
 Provides the term frequency and weight for each term in the query. More...
 
vector< Xapian::Internal::MSetItemitems
 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::doccountrequested_docs
 The set of documents which have been requested but not yet collected. More...
 
map< Xapian::doccount, Xapian::Documentindexeddocs
 Cache of documents, indexed by MSet index. More...
 
std::unordered_map< std::string, double > snippet_bg_relevance
 

Detailed Description

Definition at line 203 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 256 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 270 of file omenquireinternal.h.

◆ ~Internal()

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

Definition at line 295 of file omenquireinternal.h.

References stemmer.

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

Member Data Documentation

◆ enquire

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

Xapian::Enquire reference, for getting documents.

Definition at line 229 of file omenquireinternal.h.

◆ firstitem

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

Rank of first item in MSet.

Definition at line 238 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 215 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 235 of file omenquireinternal.h.

◆ matches_estimated

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

Definition at line 242 of file omenquireinternal.h.

◆ matches_lower_bound

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

Definition at line 240 of file omenquireinternal.h.

◆ matches_upper_bound

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

Definition at line 244 of file omenquireinternal.h.

◆ max_attained

double Xapian::MSet::Internal::max_attained

Definition at line 254 of file omenquireinternal.h.

◆ max_possible

double Xapian::MSet::Internal::max_possible

Definition at line 252 of file omenquireinternal.h.

◆ percent_factor

double Xapian::MSet::Internal::percent_factor

Factor to multiply weights by to convert them to percentages.

Definition at line 206 of file omenquireinternal.h.

◆ 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 212 of file omenquireinternal.h.

◆ snippet_bg_relevance

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

Definition at line 225 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 232 of file omenquireinternal.h.

◆ uncollapsed_estimated

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

Definition at line 248 of file omenquireinternal.h.

◆ uncollapsed_lower_bound

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

Definition at line 246 of file omenquireinternal.h.

◆ uncollapsed_upper_bound

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

Definition at line 250 of file omenquireinternal.h.


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