mrdocs::Corpus::iterator

The iterator type for the index of all symbols.

Synopsis

Declared in <mrdocs/Corpus.hpp>

class iterator;

Description

The iterator is a forward iterator that iterates over all symbols in the index. It dereferences to a reference to a const Symbol.

The logic for incrementing the iterator is provided by the Corpus implementation via a function that retuns the next Symbol in the index, or nullptr if there are no more.

Member Functions

Name

Description

iterator [constructor]

Constructors

operator=

Copy assignment operator

operator*

operator++

Increment operators

operator‐>

operator==

Equality operator

operator!=

Inequality operator

Created with MrDocs