iterator class for iterating over an index More...
Collaboration diagram for JASS::ciff_lin::docrecords_iterator:
Public Member Functions | |
| docrecords_iterator (ciff_lin &of, size_t which) | |
| Constructor. More... | |
| docrecords_iterator & | operator++ () |
| Move on to the next postings list by constructing and storing the current one. On error move to the end of the stream and mark it as bad. More... | |
| doc_record & | operator* () |
| Return the most recently constructed postings list. More... | |
| bool | operator!= (docrecords_iterator &with) |
| Compare two iterators. More... | |
Private Attributes | |
| ciff_lin & | source |
| The ciff_lin being iterated over. | |
| const uint8_t * | stream |
| Where in the source stream we are reading from. | |
| size_t | which |
| Which doc record we are current on (counting from 0) | |
| doc_record | current |
| The doc record list we just made. | |
Detailed Description
iterator class for iterating over an index
Constructor & Destructor Documentation
◆ docrecords_iterator()
|
inline |
Constructor.
- Parameters
-
of [in] The ciff_lin object we iterate over [in] Either 0 for start() or file_size for end()
Member Function Documentation
◆ operator!=()
|
inline |
Compare two iterators.
- Returns
- True if the iterators are different
◆ operator*()
|
inline |
Return the most recently constructed postings list.
- Returns
- A reference to the current postings list
◆ operator++()
|
inline |
Move on to the next postings list by constructing and storing the current one. On error move to the end of the stream and mark it as bad.
- Returns
- A reference to this iterator
The documentation for this class was generated from the following file:
- tools/ciff_lin.h
