chesspp::util::KeyIter< Map > Class Template Reference

#include <Utilities.hpp>

Inheritance diagram for chesspp::util::KeyIter< Map >:

Public Member Functions
	KeyIter (typename Map::const_iterator mapit) noexcept
	KeyIter (KeyIter const &)=default
	KeyIter (KeyIter &&)=default
KeyIter &	operator= (KeyIter const &)=default
KeyIter &	operator= (KeyIter &&)=default
KeyIter &	operator++ () noexcept
KeyIter	operator++ (int) noexcept
Map::key_type const &	operator* () const
Map::key_type const *	operator-> () const

Friends
bool	operator== (KeyIter const &a, KeyIter const &b) noexcept
bool	operator!= (KeyIter const &a, KeyIter const &b) noexcept

Detailed Description

template<typename Map>
class chesspp::util::KeyIter< Map >

Allows iterating over the keys of a map. There does not yet exist a version for iterating over the values of a map.

Template Parameters

Map	must be std::map<Key, Value> or equivalent container

Constructor & Destructor Documentation

template<typename Map >

chesspp::util::KeyIter< Map >::KeyIter ( typename Map::const_iterator  mapit )

inlinenoexcept

template<typename Map >

chesspp::util::KeyIter< Map >::KeyIter ( KeyIter< Map > const &  )

default

template<typename Map >

chesspp::util::KeyIter< Map >::KeyIter ( KeyIter< Map > &&  )

default

Member Function Documentation

template<typename Map >

Map::key_type const& chesspp::util::KeyIter< Map >::operator* ( ) const

inline

template<typename Map >

KeyIter& chesspp::util::KeyIter< Map >::operator++ ( )

inlinenoexcept

template<typename Map >

KeyIter chesspp::util::KeyIter< Map >::operator++ ( int  )

inlinenoexcept

template<typename Map >

Map::key_type const* chesspp::util::KeyIter< Map >::operator-> ( ) const

inline

template<typename Map >

KeyIter& chesspp::util::KeyIter< Map >::operator= ( KeyIter< Map > const &  )

default

template<typename Map >

KeyIter& chesspp::util::KeyIter< Map >::operator= ( KeyIter< Map > &&  )

default

Friends And Related Function Documentation

template<typename Map >

bool operator!= ( KeyIter< Map > const &  a, KeyIter< Map > const &  b  )

friend

template<typename Map >

bool operator== ( KeyIter< Map > const &  a, KeyIter< Map > const &  b  )

friend

---

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

• /ChessPlusPlus/src/util/Utilities.hpp