Xapian::MSet::Internal Class Reference
#include <omenquireinternal.h>
Classes | |
| struct | TermFreqAndWeight |
| A structure containing the term frequency and weight for a given query term. More... | |
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_, Xapian::weight max_possible_, Xapian::weight max_attained_, vector< Xapian::Internal::MSetItem > &items_, const map< string, TermFreqAndWeight > &termfreqandwts_, Xapian::weight percent_factor_) | |
| Note: destroys parameter items. | |
| Xapian::Document | get_doc_by_index (Xapian::doccount index) const |
| get a document by index in MSet, via the cache. | |
| percent | convert_to_percent_internal (Xapian::weight wt) const |
| Converts a weight to a percentage weight. | |
| string | get_description () const |
| Return a string describing this object. | |
| void | fetch_items (Xapian::doccount first, Xapian::doccount last) const |
| Fetch items specified into the document cache. | |
Public Attributes | |
| double | percent_factor |
| Factor to multiply weights by to convert them to percentages. | |
| Xapian::Internal::RefCntPtr < const Enquire::Internal > | enquire |
| Xapian::Enquire reference, for getting documents. | |
| map< string, TermFreqAndWeight > | termfreqandwts |
| The term frequencies and weights returned by the match process. | |
| vector < Xapian::Internal::MSetItem > | items |
| A list of items comprising the (selected part of the) MSet. | |
| Xapian::doccount | firstitem |
| Rank of first item in MSet. | |
| 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 |
| Xapian::weight | max_possible |
| Xapian::weight | max_attained |
Private Member Functions | |
| void | read_docs () const |
| Read and cache the documents so far requested. | |
| Internal (const Internal &) | |
| Copy not allowed. | |
| void | operator= (const Internal &) |
| Assignment not allowed. | |
Private Attributes | |
| set< Xapian::doccount > | requested_docs |
| The set of documents which have been requested but not yet collected. | |
| map< Xapian::doccount, Xapian::Document > | indexeddocs |
| Cache of documents, indexed by MSet index. | |
Detailed Description
Definition at line 194 of file omenquireinternal.h.
Constructor & Destructor Documentation
| Xapian::MSet::Internal::Internal | ( | const Internal & | ) | [private] |
Copy not allowed.
| Xapian::MSet::Internal::Internal | ( | ) | [inline] |
Definition at line 262 of file omenquireinternal.h.
| 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_, | |||
| Xapian::weight | max_possible_, | |||
| Xapian::weight | max_attained_, | |||
| vector< Xapian::Internal::MSetItem > & | items_, | |||
| const map< string, TermFreqAndWeight > & | termfreqandwts_, | |||
| Xapian::weight | percent_factor_ | |||
| ) | [inline] |
Note: destroys parameter items.
Definition at line 275 of file omenquireinternal.h.
References items, and Xapian::MSet::swap().
Member Function Documentation
| percent Xapian::MSet::Internal::convert_to_percent_internal | ( | Xapian::weight | wt | ) | const |
Converts a weight to a percentage weight.
Definition at line 368 of file omenquire.cc.
References LOGCALL, LOGLINE, max_possible, percent_factor, and RETURN.
| void Xapian::MSet::Internal::fetch_items | ( | Xapian::doccount | first, | |
| Xapian::doccount | last | |||
| ) | const |
Fetch items specified into the document cache.
Definition at line 407 of file omenquire.cc.
References enquire, firstitem, Xapian::Internal::RefCntPtr< T >::get(), indexeddocs, items, LOGCALL_VOID, and requested_docs.
Referenced by get_doc_by_index().
| string Xapian::MSet::Internal::get_description | ( | ) | const |
Return a string describing this object.
Definition at line 430 of file omenquire.cc.
References firstitem, items, matches_estimated, matches_lower_bound, matches_upper_bound, max_attained, max_possible, and Xapian::Internal::str().
| 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 386 of file omenquire.cc.
References Assert, fetch_items(), firstitem, indexeddocs, items, LOGCALL, read_docs(), RETURN, and Xapian::Internal::str().
| void Xapian::MSet::Internal::operator= | ( | const Internal & | ) | [private] |
Assignment not allowed.
| void Xapian::MSet::Internal::read_docs | ( | ) | const [private] |
Read and cache the documents so far requested.
Definition at line 453 of file omenquire.cc.
References enquire, firstitem, indexeddocs, items, LOGLINE, and requested_docs.
Referenced by get_doc_by_index().
Member Data Documentation
Xapian::Enquire reference, for getting documents.
Definition at line 218 of file omenquireinternal.h.
Referenced by fetch_items(), and read_docs().
Rank of first item in MSet.
Definition at line 244 of file omenquireinternal.h.
Referenced by fetch_items(), get_description(), get_doc_by_index(), and read_docs().
map<Xapian::doccount, Xapian::Document> Xapian::MSet::Internal::indexeddocs [mutable, private] |
Cache of documents, indexed by MSet index.
Definition at line 206 of file omenquireinternal.h.
Referenced by fetch_items(), get_doc_by_index(), and read_docs().
A list of items comprising the (selected part of the) MSet.
Definition at line 241 of file omenquireinternal.h.
Referenced by fetch_items(), get_description(), get_doc_by_index(), Internal(), and read_docs().
Definition at line 258 of file omenquireinternal.h.
Referenced by convert_to_percent_internal(), and get_description().
Factor to multiply weights by to convert them to percentages.
Definition at line 197 of file omenquireinternal.h.
Referenced by convert_to_percent_internal().
set<Xapian::doccount> Xapian::MSet::Internal::requested_docs [mutable, private] |
The set of documents which have been requested but not yet collected.
Definition at line 203 of file omenquireinternal.h.
Referenced by fetch_items(), and read_docs().
| map<string, TermFreqAndWeight> Xapian::MSet::Internal::termfreqandwts |
The term frequencies and weights returned by the match process.
This map contains information for each term which was in the query.
Definition at line 238 of file omenquireinternal.h.
Definition at line 254 of file omenquireinternal.h.
Definition at line 252 of file omenquireinternal.h.
Definition at line 256 of file omenquireinternal.h.
The documentation for this class was generated from the following files:
- common/omenquireinternal.h
- api/omenquire.cc