CeresEngine::BitIterator< ContainerIterator > Class Template Reference

#include <CeresEngine/Foundation/Container/BitView.hpp>

Public Types
using	iterator_category = std::random_access_iterator_tag
using	value_type = BitReference< Word >
using	difference_type = size_t
using	reference = value_type

Public Member Functions
constexpr	BitIterator (ContainerIterator i, const size_t o) noexcept
BitIterator &	operator++ (int) noexcept
BitIterator	operator++ () noexcept
BitIterator &	operator-- (int) noexcept
BitIterator	operator-- () noexcept
BitIterator	operator+ (const int n) const noexcept
BitIterator	operator- (const int n) const noexcept
size_t	operator- (const BitIterator &other) const noexcept
constexpr bool	operator!= (const BitIterator &other) const
constexpr bool	operator== (const BitIterator &other) const
constexpr BitReference< Word >	operator* () const noexcept

Private Types
using	Word = typename std::remove_reference< decltype(*std::declval< ContainerIterator >())>::type

Private Attributes
ContainerIterator	mIterator
size_t	mIndex

Static Private Attributes
static constexpr auto	WORD_SIZE = WordSize<Word>::value

Member Typedef Documentation

difference_type

template<class ContainerIterator >

using CeresEngine::BitIterator< ContainerIterator >::difference_type = size_t

iterator_category

template<class ContainerIterator >

using CeresEngine::BitIterator< ContainerIterator >::iterator_category = std::random_access_iterator_tag

reference

template<class ContainerIterator >

using CeresEngine::BitIterator< ContainerIterator >::reference = value_type

value_type

template<class ContainerIterator >

using CeresEngine::BitIterator< ContainerIterator >::value_type = BitReference<Word>

Word

template<class ContainerIterator >

using CeresEngine::BitIterator< ContainerIterator >::Word = typename std::remove_reference<decltype(*std::declval<ContainerIterator>())>::type

private

Constructor & Destructor Documentation

BitIterator()

template<class ContainerIterator >

constexpr CeresEngine::BitIterator< ContainerIterator >::BitIterator ( ContainerIterator  i, const size_t  o  )

inlineconstexprnoexcept

Member Function Documentation

operator!=()

template<class ContainerIterator >

constexpr bool CeresEngine::BitIterator< ContainerIterator >::operator!= ( const BitIterator< ContainerIterator > &  other ) const

inlineconstexpr

operator*()

template<class ContainerIterator >

constexpr BitReference< Word > CeresEngine::BitIterator< ContainerIterator >::operator* ( ) const

inlineconstexprnoexcept

operator+()

template<class ContainerIterator >

BitIterator CeresEngine::BitIterator< ContainerIterator >::operator+ ( const int  n ) const

inlinenoexcept

operator++() [1/2]

template<class ContainerIterator >

BitIterator CeresEngine::BitIterator< ContainerIterator >::operator++ ( )

inlinenoexcept

operator++() [2/2]

template<class ContainerIterator >

BitIterator & CeresEngine::BitIterator< ContainerIterator >::operator++ ( int  )

inlinenoexcept

operator-() [1/2]

template<class ContainerIterator >

size_t CeresEngine::BitIterator< ContainerIterator >::operator- ( const BitIterator< ContainerIterator > &  other ) const

inlinenoexcept

operator-() [2/2]

template<class ContainerIterator >

BitIterator CeresEngine::BitIterator< ContainerIterator >::operator- ( const int  n ) const

inlinenoexcept

operator--() [1/2]

template<class ContainerIterator >

BitIterator CeresEngine::BitIterator< ContainerIterator >::operator-- ( )

inlinenoexcept

operator--() [2/2]

template<class ContainerIterator >

BitIterator & CeresEngine::BitIterator< ContainerIterator >::operator-- ( int  )

inlinenoexcept

operator==()

template<class ContainerIterator >

constexpr bool CeresEngine::BitIterator< ContainerIterator >::operator== ( const BitIterator< ContainerIterator > &  other ) const

inlineconstexpr

Member Data Documentation

mIndex

template<class ContainerIterator >

size_t CeresEngine::BitIterator< ContainerIterator >::mIndex

private

mIterator

template<class ContainerIterator >

ContainerIterator CeresEngine::BitIterator< ContainerIterator >::mIterator

private

WORD_SIZE

template<class ContainerIterator >

constexpr auto CeresEngine::BitIterator< ContainerIterator >::WORD_SIZE = WordSize<Word>::value

staticconstexprprivate

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Foundation/Container/BitView.hpp