A termlist iterator over a vector of StringAndFrequency objects. More...
Inheritance diagram for StringAndFreqTermList:
Collaboration diagram for StringAndFreqTermList:
Public Member Functions | |
| void | init () |
| init should be called after the values have been set, but before iteration begins. More... | |
| Xapian::doccount | get_termfreq () const |
| Return the term frequency for the term at the current position. More... | |
| TermList * | next () |
| Advance the current position to the next term in the termlist. More... | |
| TermList * | skip_to (string_view term) |
| Skip forward to the specified term. More... | |
| Xapian::termcount | get_approx_size () const |
| Return approximate size of this termlist. More... | |
| Xapian::termcount | get_wdf () const |
| Return the wdf for the term at the current position. More... | |
| PositionList * | positionlist_begin () const |
| Return PositionList for the current position. More... | |
| Xapian::termcount | positionlist_count () const |
| Return the length of the position list for the current position. More... | |
| Public Member Functions inherited from Xapian::TermIterator::Internal | |
| virtual | ~Internal () |
| We have virtual methods and want to be able to delete derived classes using a pointer to the base class, so we need a virtual destructor. More... | |
| virtual void | accumulate_stats (Xapian::Internal::ExpandStats &stats) const |
| Collate weighting information for the current term. More... | |
| const std::string & | get_termname () const |
| Return the termname at the current position. More... | |
| virtual const Xapian::VecCOW< Xapian::termpos > * | get_vec_termpos () const |
| Get pointer to VecCOW<termpos> if that's the internal representation. More... | |
| Public Member Functions inherited from Xapian::Internal::intrusive_base | |
| intrusive_base () | |
| Construct with no references. More... | |
Public Attributes | |
| vector< StringAndFrequency > | values |
| Public Attributes inherited from Xapian::TermIterator::Internal | |
| size_t | shard_index = 0 |
| Which shard of a multidatabase this is from. More... | |
| Public Attributes inherited from Xapian::Internal::intrusive_base | |
| unsigned | _refs |
| Reference count. More... | |
Private Attributes | |
| vector< StringAndFrequency >::const_iterator | it |
| bool | started |
Additional Inherited Members | |
| Protected Member Functions inherited from Xapian::TermIterator::Internal | |
| Internal () | |
| Only constructable as a base class for derived classes. More... | |
| Protected Attributes inherited from Xapian::TermIterator::Internal | |
| std::string | current_term |
| The current term. More... | |
Detailed Description
A termlist iterator over a vector of StringAndFrequency objects.
Definition at line 182 of file matchspy.cc.
Member Function Documentation
◆ get_approx_size()
|
inlinevirtual |
Return approximate size of this termlist.
Implements Xapian::TermIterator::Internal.
Definition at line 228 of file matchspy.cc.
References unsupported_method().
◆ get_termfreq()
|
inlinevirtual |
Return the term frequency for the term at the current position.
Implements Xapian::TermIterator::Internal.
Definition at line 197 of file matchspy.cc.
References Assert.
◆ get_wdf()
|
inlinevirtual |
Return the wdf for the term at the current position.
Implements Xapian::TermIterator::Internal.
Definition at line 229 of file matchspy.cc.
References unsupported_method().
◆ init()
|
inline |
init should be called after the values have been set, but before iteration begins.
Definition at line 192 of file matchspy.cc.
◆ next()
|
inlinevirtual |
Advance the current position to the next term in the termlist.
The list starts before the first term in the list, so next(), skip_to() or check() must be called before any methods which need the context of the current position.
- Returns
- Normally returns NULL to indicate success. If the end has been reached, returns this; if another non-NULL pointer is returned then the caller should substitute the returned pointer for its pointer to us, and then delete us. This "pruning" can only happen for a non-leaf subclass of this class.
Implements Xapian::TermIterator::Internal.
Definition at line 203 of file matchspy.cc.
References Assert.
◆ positionlist_begin()
|
inlinevirtual |
Return PositionList for the current position.
Implements Xapian::TermIterator::Internal.
Definition at line 230 of file matchspy.cc.
References unsupported_method().
◆ positionlist_count()
|
inlinevirtual |
Return the length of the position list for the current position.
Implements Xapian::TermIterator::Internal.
Definition at line 231 of file matchspy.cc.
References unsupported_method().
◆ skip_to()
|
inlinevirtual |
Skip forward to the specified term.
If the specified term isn't in the list, position ourselves on the first term after term.
- Returns
- Normally returns NULL to indicate success. If no terms after term exist, returns this; if another non-NULL pointer is returned then the caller should substitute the returned pointer for its pointer to us, and then delete us. This "pruning" can only happen for a non-leaf subclass of this class.
Implements Xapian::TermIterator::Internal.
Definition at line 217 of file matchspy.cc.
References term.
Member Data Documentation
◆ it
|
private |
Definition at line 184 of file matchspy.cc.
◆ started
|
private |
Definition at line 185 of file matchspy.cc.
◆ values
| vector<StringAndFrequency> StringAndFreqTermList::values |
Definition at line 187 of file matchspy.cc.
The documentation for this class was generated from the following file:
- api/matchspy.cc