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.

Types

Name

Description

const_pointer

Pointer to const value.

const_reference

Reference to const value.

difference_type

Signed difference type.

pointer

Pointer to value.

reference

Reference to value.

size_type

Unsigned size type.

value_type

Value type yielded by the iterator.

Member Functions

Name

Description

iterator [constructor]

Constructors

operator=

Copy assignment.

operator*

Dereference to the current symbol.

operator++

Increment operators

operator‐>

Pointer‐like access to the current symbol.

operator==

Equality comparison.

operator!=

Inequality comparison.

Created with MrDocs