tetengo::trie::trie_iterator< Value > Class Template Reference

A trie iterator. More...

#include <trie_iterator.hpp>

Inheritance diagram for tetengo::trie::trie_iterator< Value >:

Collaboration diagram for tetengo::trie::trie_iterator< Value >:

Public Types
using	value_type = Value
	The value type.

Public Member Functions
	trie_iterator (trie_iterator_impl &&impl)
	Creates an iterator.
const value_type &	operator* () const
	Dereferences the iterator.
value_type &	operator* ()
	Dereferences the iterator.
const value_type *	operator-> () const
	Returns the pointer to the value.
value_type *	operator-> ()
	Returns the pointer to the value.
trie_iterator &	operator++ ()
	Increments the iterator.
trie_iterator	operator++ (int)
	Postincrements the iterator.

Friends
bool	operator== (const trie_iterator &one, const trie_iterator &another)
	Returns true when one iterator is equal to another.

Detailed Description

template<typename Value>
class tetengo::trie::trie_iterator< Value >

A trie iterator.

Template Parameters

Value

A value type.

Constructor & Destructor Documentation

trie_iterator()

template<typename Value >

tetengo::trie::trie_iterator< Value >::trie_iterator ( trie_iterator_impl && impl )

inline

Creates an iterator.

Parameters

impl	An implementation of trie iterator.

Member Function Documentation

operator*() [1/2]

template<typename Value >

value_type & tetengo::trie::trie_iterator< Value >::operator* ( )

inlinenodiscard

Dereferences the iterator.

Returns

The dereferenced value.

operator*() [2/2]

template<typename Value >

const value_type & tetengo::trie::trie_iterator< Value >::operator* ( ) const

inlinenodiscard

Dereferences the iterator.

Returns

The dereferenced value.

operator++() [1/2]

template<typename Value >

trie_iterator & tetengo::trie::trie_iterator< Value >::operator++ ( )

inline

Increments the iterator.

Returns

This iterator.

operator++() [2/2]

template<typename Value >

trie_iterator tetengo::trie::trie_iterator< Value >::operator++ ( int )

inline

Postincrements the iterator.

Returns

The iterator before the incrementation.

operator->() [1/2]

template<typename Value >

value_type * tetengo::trie::trie_iterator< Value >::operator-> ( )

inlinenodiscard

Returns the pointer to the value.

Returns

The pointer to the value.

operator->() [2/2]

template<typename Value >

const value_type * tetengo::trie::trie_iterator< Value >::operator-> ( ) const

inlinenodiscard

Returns the pointer to the value.

Returns

The pointer to the value.

Friends And Related Symbol Documentation

operator==

template<typename Value >

bool operator== ( const trie_iterator< Value > & one, const trie_iterator< Value > & another )

friend

Returns true when one iterator is equal to another.

Parameters

one	One iterator.
another	Another iterator.

Return values

true	When one is equal to another.
false	Otherwise.

---

The documentation for this class was generated from the following file:

• library/trie/cpp/include/tetengo/trie/trie_iterator.hpp