tetengo 1.8.1
A multipurpose library set
Loading...
Searching...
No Matches
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_typeoperator* () const
 Dereferences the iterator.
 
value_typeoperator* ()
 Dereferences the iterator.
 
const value_typeoperator-> () const
 Returns the pointer to the value.
 
value_typeoperator-> ()
 Returns the pointer to the value.
 
trie_iteratoroperator++ ()
 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
ValueA 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
implAn implementation of trie iterator.

Member Function Documentation

◆ operator*() [1/2]

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

Dereferences the iterator.

Returns
The dereferenced value.

◆ operator*() [2/2]

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

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-> ( )
inline

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
inline

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
oneOne iterator.
anotherAnother iterator.
Return values
trueWhen one is equal to another.
falseOtherwise.

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