Kicking it Olde Sküül! Burgerlib on Github Follow Olde Sküül on Twitter Burgerbecky on LinkedIn Burgerbecky on LinkedIn
Loading...
Searching...
No Matches
Burger::HashMap< T, U >::const_iterator Class Reference

STL compatible constant iterator for HashMap. More...

Inheritance diagram for Burger::HashMap< T, U >::const_iterator:
Collaboration diagram for Burger::HashMap< T, U >::const_iterator:

Public Member Functions

const Entryoperator* () const noexcept
 Get a reference to the Entry indexed by the const_iterator.
 
const Entryoperator-> () const noexcept
 Get a pointer to the Entry indexed by the const_iterator.
 
- Public Member Functions inherited from Burger::HashMapShared::const_iterator
uint_t IsEnd (void) const noexcept
 Is the iterator at the end of the array?
 
const EntryGetPtr (void) const noexcept
 Get the Entry pointer.
 
const Entryoperator* () const noexcept
 Get the Entry reference.
 
const Entryoperator-> () const noexcept
 Get the Entry pointer.
 
void operator++ () noexcept
 Increment the iterator to the next valid entry.
 
uint_t operator== (const const_iterator &it) const noexcept
 Test for equality between iterators.
 
uint_t operator!= (const const_iterator &it) const noexcept
 Test for inequality between iterators.
 

Private Member Functions

 const_iterator (const HashMapShared *pParent, uintptr_t uIndex) noexcept
 Standard constructor.
 

Friends

class HashMap< T, U >
 
class iterator
 

Additional Inherited Members

- Protected Member Functions inherited from Burger::HashMapShared::const_iterator
 const_iterator (const HashMapShared *pParent, uintptr_t uIndex) noexcept
 Base class constructor.
 
- Protected Attributes inherited from Burger::HashMapShared::const_iterator
const HashMapSharedm_pParent
 Pointer to the parent class instance.
 
uintptr_t m_uIndex
 Last accessed index.
 

Detailed Description

template<class T, class U>
class Burger::HashMap< T, U >::const_iterator

STL compatible constant iterator for HashMap.


To allow STL functionality, this class allow iteration over the entire hash.

Note
The const_iterator can only be created by a call to HashMap::begin() or HashMap::end()
See also
iterator and HashMapShared::const_iterator

Constructor & Destructor Documentation

◆ const_iterator()

template<class T , class U >
Burger::HashMap< T, U >::const_iterator::const_iterator ( const HashMapShared * pParent,
uintptr_t uIndex )
inlineprivatenoexcept

Standard constructor.


This private function is used to create the const_iterator for returning to applications.

Note
The const_iterator can only be created by a call to HashMap::begin() or HashMap::end()
See also
iterator and HashMapShared::const_iterator

Member Function Documentation

◆ operator*()

template<class T , class U >
const Entry & Burger::HashMap< T, U >::const_iterator::operator* ( ) const
inlinenoexcept

Get a reference to the Entry indexed by the const_iterator.


Note
Function will fail if the iterator is at the end of the array.
Returns
Reference to the Entry record pointed by the const_iterator
See also
iterator and HashMapShared::const_iterator

◆ operator->()

template<class T , class U >
const Entry * Burger::HashMap< T, U >::const_iterator::operator-> ( ) const
inlinenoexcept

Get a pointer to the Entry indexed by the const_iterator.


Note
Function will fail if the iterator is at the end of the array.
Returns
Pointer to the Entry record pointed by the const_iterator
See also
iterator and HashMapShared::const_iterator

Friends And Related Symbol Documentation

◆ HashMap< T, U >

template<class T , class U >
friend class HashMap< T, U >
friend

◆ iterator

template<class T , class U >
friend class iterator
friend