Provides the ability to iterate over the words from a DictionaryMetaData object. More...
#include <DictionaryKeyIterator.hpp>
Inheritance diagram for inflection::dictionary::DictionaryKeyIterator:
Public Member Functions | |
| DictionaryKeyIterator (DictionaryKeyIterator &&iterator) | |
| ~DictionaryKeyIterator () override | |
| const ::std::u16string & | operator* () const |
| DictionaryKeyIterator & | operator++ () |
| bool | operator== (const DictionaryKeyIterator &rhs) const |
| DictionaryKeyIterator | begin () const |
| DictionaryKeyIterator | end () const |
| DictionaryKeyIterator (const DictionaryKeyIterator &)=delete | |
| DictionaryKeyIterator & | operator= (const DictionaryKeyIterator &)=delete |
| Public Member Functions inherited from inflection::Object | |
| virtual ::std::u16string | toString () const |
| virtual | ~Object () |
Friends | |
| class | DictionaryMetaData_MMappedDictionary |
Detailed Description
Provides the ability to iterate over the words from a DictionaryMetaData object.
Definition at line 16 of file DictionaryKeyIterator.hpp.
Constructor & Destructor Documentation
◆ DictionaryKeyIterator()
| inflection::dictionary::DictionaryKeyIterator::DictionaryKeyIterator | ( | DictionaryKeyIterator && | iterator | ) |
Move constructor
◆ ~DictionaryKeyIterator()
|
override |
Destructor
Member Function Documentation
◆ begin()
| DictionaryKeyIterator inflection::dictionary::DictionaryKeyIterator::begin | ( | ) | const |
The first word in the dictionary.
◆ end()
| DictionaryKeyIterator inflection::dictionary::DictionaryKeyIterator::end | ( | ) | const |
The last word in the dictionary.
◆ operator*()
| const ::std::u16string & inflection::dictionary::DictionaryKeyIterator::operator* | ( | ) | const |
Retrieve a reference to the current word.
◆ operator++()
| DictionaryKeyIterator & inflection::dictionary::DictionaryKeyIterator::operator++ | ( | ) |
Iterate to the next word
◆ operator==()
| bool inflection::dictionary::DictionaryKeyIterator::operator== | ( | const DictionaryKeyIterator & | rhs | ) | const |
Return true when this is equal to the other iterator.
Friends And Related Symbol Documentation
◆ DictionaryMetaData_MMappedDictionary
|
friend |
Definition at line 66 of file DictionaryKeyIterator.hpp.
The documentation for this class was generated from the following file:
- /home/runner/work/inflection/inflection/inflection/build/inflection_headers/inflection/dictionary/DictionaryKeyIterator.hpp
