Inheritance diagram for gimbal::RandomAccessIterator< O, Index, Value, Reverse >:

Public Types
using	object_type = O

using	iterator_type = RandomAccessIterator< O, Index, Value, Reverse >

using	const_iterator_type = RandomAccessIterator< std::add_const_t< O >, Index, Value, Reverse >

using	nonconst_iterator_type = RandomAccessIterator< std::remove_const_t< O >, Index, Value, Reverse >

using	value_type = Value

using	index_type = std::make_signed_t< Index >

using	reference = std::conditional_t< std::is_const_v< O >, std::add_lvalue_reference_t< std::add_const_t< Value > >, std::add_lvalue_reference_t< Value > >

using	const_reference = std::add_lvalue_reference_t< std::add_const_t< Value > >

using	pointer = std::conditional_t< std::is_const_v< O >, std::add_pointer_t< std::add_const_t< Value > >, std::add_pointer_t< Value > >

using	difference_type = std::ptrdiff_t

using	iterator_category = std::random_access_iterator_tag

Public Member Functions
void	checkBounds (Index index) const

reference	operator* ()

const_reference	operator* () const

pointer	operator& ()

iterator_type &	operator++ ()

iterator_type	operator++ (int)

iterator_type &	operator-- ()

iterator_type	operator-- (int)

iterator_type &	operator+= (index_type offset)

iterator_type &	operator-= (index_type offset)

iterator_type	operator+ (const iterator_type &rhs) const

difference_type	operator- (const iterator_type &rhs) const

reference	operator[] (difference_type offset) const

bool	operator== (const iterator_type &rhs) const

bool	operator<= (const iterator_type &rhs) const

bool	operator< (const iterator_type &rhs) const

bool	operator> (const iterator_type &rhs) const

bool	operator>= (const iterator_type &rhs) const

bool	operator!= (const iterator_type &rhs) const

	RandomAccessIterator (const const_iterator_type &rhs)

	RandomAccessIterator (O &objType, index_type index=-1)

	RandomAccessIterator (const nonconst_iterator_type &rhs)

Data Fields
O *	pObj_

index_type	index_

Static Public Attributes
static constexpr bool	reverse

Friends
iterator_type	operator+ (const iterator_type &it, index_type offset)

iterator_type	operator+ (index_type offset, const iterator_type &it)

iterator_type	operator- (const iterator_type &it, index_type offset)

Detailed Description

template<typename O, typename Index, typename Value, bool Reverse>
struct gimbal::RandomAccessIterator< O, Index, Value, Reverse >

Definition at line 111 of file gimbal_generics.hpp.

Member Typedef Documentation

◆ object_type

template<typename O , typename Index , typename Value , bool Reverse>

using gimbal::RandomAccessIterator< O, Index, Value, Reverse >::object_type = O

Definition at line 116 of file gimbal_generics.hpp.

◆ iterator_type

template<typename O , typename Index , typename Value , bool Reverse>

using gimbal::RandomAccessIterator< O, Index, Value, Reverse >::iterator_type = RandomAccessIterator<O, Index, Value, Reverse>

Definition at line 117 of file gimbal_generics.hpp.

◆ const_iterator_type

template<typename O , typename Index , typename Value , bool Reverse>

using gimbal::RandomAccessIterator< O, Index, Value, Reverse >::const_iterator_type = RandomAccessIterator<std::add_const_t<O>, Index, Value, Reverse>

Definition at line 118 of file gimbal_generics.hpp.

◆ nonconst_iterator_type

template<typename O , typename Index , typename Value , bool Reverse>

using gimbal::RandomAccessIterator< O, Index, Value, Reverse >::nonconst_iterator_type = RandomAccessIterator<std::remove_const_t<O>, Index, Value, Reverse>

Definition at line 119 of file gimbal_generics.hpp.

◆ value_type

template<typename O , typename Index , typename Value , bool Reverse>

using gimbal::RandomAccessIterator< O, Index, Value, Reverse >::value_type = Value

Definition at line 120 of file gimbal_generics.hpp.

◆ index_type

template<typename O , typename Index , typename Value , bool Reverse>

using gimbal::RandomAccessIterator< O, Index, Value, Reverse >::index_type = std::make_signed_t<Index>

Definition at line 121 of file gimbal_generics.hpp.

◆ reference

template<typename O , typename Index , typename Value , bool Reverse>

using gimbal::RandomAccessIterator< O, Index, Value, Reverse >::reference = std::conditional_t<std::is_const_v<O>, std::add_lvalue_reference_t<std::add_const_t<Value> >, std::add_lvalue_reference_t<Value> >

Definition at line 122 of file gimbal_generics.hpp.

◆ const_reference

template<typename O , typename Index , typename Value , bool Reverse>

using gimbal::RandomAccessIterator< O, Index, Value, Reverse >::const_reference = std::add_lvalue_reference_t<std::add_const_t<Value> >

Definition at line 125 of file gimbal_generics.hpp.

◆ pointer

template<typename O , typename Index , typename Value , bool Reverse>

using gimbal::RandomAccessIterator< O, Index, Value, Reverse >::pointer = std::conditional_t<std::is_const_v<O>, std::add_pointer_t<std::add_const_t<Value> >, std::add_pointer_t<Value> >

Definition at line 126 of file gimbal_generics.hpp.

◆ difference_type

template<typename O , typename Index , typename Value , bool Reverse>

using gimbal::RandomAccessIterator< O, Index, Value, Reverse >::difference_type = std::ptrdiff_t

Definition at line 129 of file gimbal_generics.hpp.

◆ iterator_category

template<typename O , typename Index , typename Value , bool Reverse>

using gimbal::RandomAccessIterator< O, Index, Value, Reverse >::iterator_category = std::random_access_iterator_tag

Definition at line 130 of file gimbal_generics.hpp.

Constructor & Destructor Documentation

◆ RandomAccessIterator() [1/3]

template<typename O , typename Index , typename Value , bool Reverse>

gimbal::RandomAccessIterator< O, Index, Value, Reverse >::RandomAccessIterator ( const const_iterator_type & rhs )

inline

Definition at line 202 of file gimbal_generics.hpp.

202 :

203 pObj_(rhs.pObj_), index_(rhs.index_) {}

◆ RandomAccessIterator() [2/3]

template<typename O , typename Index , typename Value , bool Reverse>

gimbal::RandomAccessIterator< O, Index, Value, Reverse >::RandomAccessIterator	(	O &	objType,
		index_type	index = `-1`
	)

inline

Definition at line 205 of file gimbal_generics.hpp.

205 :

206 pObj_(&objType), index_(index) {}

◆ RandomAccessIterator() [3/3]

template<typename O , typename Index , typename Value , bool Reverse>

gimbal::RandomAccessIterator< O, Index, Value, Reverse >::RandomAccessIterator ( const nonconst_iterator_type & rhs )

inline

Definition at line 208 of file gimbal_generics.hpp.

208 :

209 RandomAccessIterator(*rhs.pObj_, rhs.index_) {}

Member Function Documentation

◆ checkBounds()

template<typename O , typename Index , typename Value , bool Reverse>

void gimbal::RandomAccessIterator< O, Index, Value, Reverse >::checkBounds ( Index index ) const

inline

Definition at line 132 of file gimbal_generics.hpp.

                                            {
           if(index >= pObj_->getElementCount_()) Exception::checkThrow({Result::ErrorOutOfRange, "Index >= obj.elementCount"});
        }

◆ operator*() [1/2]

template<typename O , typename Index , typename Value , bool Reverse>

reference gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator* ( )

inline

Definition at line 142 of file gimbal_generics.hpp.

                               {
            checkBounds(index_);
            return pObj_->getElement_(index_);
        }

◆ operator*() [2/2]

template<typename O , typename Index , typename Value , bool Reverse>

const_reference gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator* ( ) const

inline

Definition at line 147 of file gimbal_generics.hpp.

                                           {
            checkBounds(index_);
            return const_cast<const O*>(pObj_)->getElement_(index_);
        }

◆ operator&()

template<typename O , typename Index , typename Value , bool Reverse>

pointer gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator& ( )

inline

Definition at line 152 of file gimbal_generics.hpp.

                             {
            checkBounds(index_);
            return &pObj_->getElement_(index_);
        }

◆ operator++() [1/2]

template<typename O , typename Index , typename Value , bool Reverse>

iterator_type & gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator++ ( )

inline

Definition at line 157 of file gimbal_generics.hpp.

                                     {
            if constexpr(Reverse) --index_;
            else ++index_ ;
            return *this;
        }

◆ operator++() [2/2]

template<typename O , typename Index , typename Value , bool Reverse>

iterator_type gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator++ ( int )

inline

Definition at line 162 of file gimbal_generics.hpp.

                                       {
            const auto temp(*this);
            if constexpr(Reverse) --*this;
            else ++*this;
            return temp;
        }

◆ operator--() [1/2]

template<typename O , typename Index , typename Value , bool Reverse>

iterator_type & gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator-- ( )

inline

Definition at line 168 of file gimbal_generics.hpp.

                                    {
            if constexpr(Reverse) ++index_;
            else --index_;
            return *this;
        }

◆ operator--() [2/2]

template<typename O , typename Index , typename Value , bool Reverse>

iterator_type gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator-- ( int )

inline

Definition at line 173 of file gimbal_generics.hpp.

                                      {
            const auto temp(*this);
            if constexpr(Reverse) ++*this;
            else --*this;
            return temp;
        }

◆ operator+=()

template<typename O , typename Index , typename Value , bool Reverse>

iterator_type & gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator+= ( index_type offset )

inline

Definition at line 179 of file gimbal_generics.hpp.

179{ if constexpr(Reverse) index_ -= offset; else index_ += offset; return *this; }

◆ operator-=()

template<typename O , typename Index , typename Value , bool Reverse>

iterator_type & gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator-= ( index_type offset )

inline

Definition at line 180 of file gimbal_generics.hpp.

180{ if constexpr(Reverse) index_ += offset; else index_ -= offset; return *this; }

◆ operator+()

template<typename O , typename Index , typename Value , bool Reverse>

iterator_type gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator+ ( const iterator_type & rhs ) const

inline

Definition at line 185 of file gimbal_generics.hpp.

185{ if constexpr(!Reverse) return *this + rhs.index_; else return *this - rhs.index_; }

◆ operator-()

template<typename O , typename Index , typename Value , bool Reverse>

difference_type gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator- ( const iterator_type & rhs ) const

inline

Definition at line 187 of file gimbal_generics.hpp.

187{ auto temp(*this); temp.index_ -= rhs.index_; return temp.index_; }

◆ operator[]()

template<typename O , typename Index , typename Value , bool Reverse>

reference gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator[] ( difference_type offset ) const

inline

Definition at line 189 of file gimbal_generics.hpp.

                                                           {
            return pObj_->getElement_(index_ + offset);
        }

◆ operator==()

template<typename O , typename Index , typename Value , bool Reverse>

bool gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator== ( const iterator_type & rhs ) const

inline

Definition at line 193 of file gimbal_generics.hpp.

193{ return pObj_ == pObj_ && index_ == rhs.index_; }

◆ operator<=()

template<typename O , typename Index , typename Value , bool Reverse>

bool gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator<= ( const iterator_type & rhs ) const

inline

Definition at line 194 of file gimbal_generics.hpp.

194{ return pObj_ == rhs.pObj_ && index_ <= rhs.index_; }

◆ operator<()

template<typename O , typename Index , typename Value , bool Reverse>

bool gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator< ( const iterator_type & rhs ) const

inline

Definition at line 195 of file gimbal_generics.hpp.

195{ return pObj_ == rhs.pObj_ && index_ < rhs.index_; }

◆ operator>()

template<typename O , typename Index , typename Value , bool Reverse>

bool gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator> ( const iterator_type & rhs ) const

inline

Definition at line 196 of file gimbal_generics.hpp.

196{ return pObj_ == rhs.pObj_ && index_ > rhs.index_; }

◆ operator>=()

template<typename O , typename Index , typename Value , bool Reverse>

bool gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator>= ( const iterator_type & rhs ) const

inline

Definition at line 197 of file gimbal_generics.hpp.

197{ return pObj_ == rhs.pObj_ && index_ >= rhs.index_; }

◆ operator!=()

template<typename O , typename Index , typename Value , bool Reverse>

bool gimbal::RandomAccessIterator< O, Index, Value, Reverse >::operator!= ( const iterator_type & rhs ) const

inline

Definition at line 198 of file gimbal_generics.hpp.

198{ return !(*this == rhs); }

Friends And Related Symbol Documentation

◆ operator+ [1/2]

template<typename O , typename Index , typename Value , bool Reverse>

iterator_type operator+	(	const iterator_type &	it,
		index_type	offset
	)

friend

Definition at line 182 of file gimbal_generics.hpp.

182{ auto temp(it); if constexpr(Reverse) temp.index_ -= offset; else temp.index_ += offset; return temp; }

◆ operator+ [2/2]

template<typename O , typename Index , typename Value , bool Reverse>

iterator_type operator+	(	index_type	offset,
		const iterator_type &	it
	)

friend

Definition at line 183 of file gimbal_generics.hpp.

183{ if constexpr(!Reverse) return it + offset; else return it - offset; }

◆ operator-

template<typename O , typename Index , typename Value , bool Reverse>

iterator_type operator-	(	const iterator_type &	it,
		index_type	offset
	)

friend

Definition at line 184 of file gimbal_generics.hpp.

184{ auto temp(it); if constexpr(Reverse) temp.index_ += offset; else temp.index_ -= offset; return temp; }

Field Documentation

◆ reverse

template<typename O , typename Index , typename Value , bool Reverse>

constexpr bool gimbal::RandomAccessIterator< O, Index, Value, Reverse >::reverse

inlinestaticconstexpr

Definition at line 115 of file gimbal_generics.hpp.

◆ pObj_

template<typename O , typename Index , typename Value , bool Reverse>

O* gimbal::RandomAccessIterator< O, Index, Value, Reverse >::pObj_

Definition at line 211 of file gimbal_generics.hpp.

◆ index_

template<typename O , typename Index , typename Value , bool Reverse>

index_type gimbal::RandomAccessIterator< O, Index, Value, Reverse >::index_

Definition at line 212 of file gimbal_generics.hpp.

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

gimbal_generics.hpp

Public Types

Public Member Functions

Data Fields

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ object_type

◆ iterator_type

◆ const_iterator_type

◆ nonconst_iterator_type

◆ value_type

◆ index_type

◆ reference

◆ const_reference

◆ pointer

◆ difference_type

◆ iterator_category

Constructor & Destructor Documentation

◆ RandomAccessIterator() [1/3]

◆ RandomAccessIterator() [2/3]

◆ RandomAccessIterator() [3/3]

Member Function Documentation

◆ checkBounds()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator&()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator+=()

◆ operator-=()

◆ operator+()

◆ operator-()

◆ operator[]()

◆ operator==()

◆ operator<=()

◆ operator<()

◆ operator>()

◆ operator>=()

◆ operator!=()

Friends And Related Symbol Documentation

◆ operator+ [1/2]

◆ operator+ [2/2]

◆ operator-

Field Documentation

◆ reverse

◆ pObj_

◆ index_