Inheritance diagram for SlowDecreasingValueWeightPostingSource:
Collaboration diagram for SlowDecreasingValueWeightPostingSource:
Public Member Functions | |
| SlowDecreasingValueWeightPostingSource (int &count_) | |
| SlowDecreasingValueWeightPostingSource * | clone () const |
| Clone the posting source. More... | |
| void | next (double min_wt) |
| Advance the current position to the next matching document. 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 |
| Return the weight contribution for the current document. More... | |
| std::string | name () const |
| Name of the posting source class. More... | |
| std::string | serialise () const |
| Serialise object parameters into a string. More... | |
| DecreasingValueWeightPostingSource * | unserialise (const std::string &serialised) const |
| Create object given string serialisation returned by serialise(). More... | |
| void | init (const Xapian::Database &db_) |
| Set this PostingSource to the start of the list of postings. 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... | |
| std::string | get_description () const |
| 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_) | |
| 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 () | |
| 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 PostingSource * | unserialise_with_registry (const std::string &serialised, const Registry ®istry) const |
| Create object given string serialisation returned by serialise(). 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 | |
| int & | count |
| 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... | |
| Protected Attributes inherited from Xapian::ValuePostingSource | |
| 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... | |
Detailed Description
Definition at line 588 of file api_postingsource.cc.
Constructor & Destructor Documentation
◆ SlowDecreasingValueWeightPostingSource()
|
inline |
Definition at line 593 of file api_postingsource.cc.
Member Function Documentation
◆ clone()
|
inlinevirtual |
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 init() 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 596 of file api_postingsource.cc.
◆ next()
|
inlinevirtual |
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).
Reimplemented from Xapian::DecreasingValueWeightPostingSource.
Definition at line 601 of file api_postingsource.cc.
References Xapian::DecreasingValueWeightPostingSource::next(), and RealTime::sleep().
Member Data Documentation
◆ count
| int& SlowDecreasingValueWeightPostingSource::count |
Definition at line 591 of file api_postingsource.cc.
The documentation for this class was generated from the following file:
- tests/api_postingsource.cc