BaseIterator< COLLECTION, STRIDED > Class Template Reference

#include <block.h>

Detailed Description

template<typename COLLECTION, Bool STRIDED>
class maxon::BaseIterator< COLLECTION, STRIDED >

The BaseIterator internally is a pointer. So using it to iterate over an array or parts of it is as efficient as using a real pointer (for more ease of use you may want to invoke this via the C++11 range based for loop).

As already said you can use an Iterator almost like a pointer, e.g.

it++;               // go to the next element
it--;               // go to the previous element
it += 5;            // advance by 5 elements
it -= 3;            // go back 3 elements
cnt = itB - itA;    // number of elements from itA to itB
it = array.Begin(); // iterator to the first element of the array
*it = value;        // assign value to the elements referenced by the iterator
value = *it;        // get value of the element referenced by the iterator

Please note that using a postfix operator access (*it++ or *it–) can be slower than using the prefix form or a separate assignment. E.g.

value = *it++; 

is most likely slower than

value = it; ++it; 

or

value = it; it++; 

because *it++ requires a temporary copy of the iterator that the compiler may not be able to remove during optimization. As long as you only use the iterator's postfix operator without assignment it should be fine because the compiler will remove the temporary copy.

You can either type alias the BaseIterator (like the BaseArray does) or inherit from it.

Template Parameters

COLLECTION	Type of the array.
STRIDED	False for pointer-only iterator. True if the iterator has to support a variable stride offset (slower and requires another member variable).

Classes
class	ResultFunctions

Public Types
using	CollectionType = COLLECTION
using	ValueType = typename InheritConst< typename COLLECTION::ValueType, COLLECTION >::type
using	iterator_category = std::random_access_iterator_tag
using	difference_type = Int
using	value_type = ValueType
using	pointer = ValueType *
using	reference = ValueType &

Public Member Functions
MAXON_ATTRIBUTE_FORCE_INLINE	BaseIterator (CollectionType &a, Int start=0)
MAXON_ATTRIBUTE_FORCE_INLINE	BaseIterator (ValueType *pos=nullptr, Int index=0, Int stride=0)
	BaseIterator (const BaseIterator &src)=default
BaseIterator &	operator= (const BaseIterator &src)=default
MAXON_ATTRIBUTE_FORCE_INLINE	operator BaseIterator< typename std::add_const< COLLECTION >::type, STRIDED > & ()
MAXON_ATTRIBUTE_FORCE_INLINE	operator Bool () const
MAXON_ATTRIBUTE_FORCE_INLINE ValueType *	GetPtr () const
MAXON_ATTRIBUTE_FORCE_INLINE ValueType &	operator* () const
MAXON_ATTRIBUTE_FORCE_INLINE ValueType *	operator-> () const
MAXON_ATTRIBUTE_FORCE_INLINE Bool	operator== (const BaseIterator &b) const
MAXON_ATTRIBUTE_FORCE_INLINE Bool	operator< (const BaseIterator &b) const
	MAXON_OPERATOR_COMPARISON (BaseIterator)
MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator &	operator++ ()
MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator	operator++ (int)
MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator &	operator+= (Int i)
MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator &	operator-- ()
MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator	operator-- (int)
MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator &	operator-= (Int i)
MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator	operator+ (Int i) const
MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator	operator- (Int i) const
MAXON_ATTRIBUTE_FORCE_INLINE Int	operator- (const BaseIterator &b) const

Static Public Attributes
static const Bool	isLinearIterator

Protected Attributes
ValueType *	_data

Member Typedef Documentation

CollectionType

using CollectionType = COLLECTION

ValueType

using ValueType = typename InheritConst<typename COLLECTION::ValueType, COLLECTION>::type

iterator_category

using iterator_category = std::random_access_iterator_tag

difference_type

using difference_type = Int

value_type

using value_type = ValueType

pointer

using pointer = ValueType*

reference

using reference = ValueType&

Constructor & Destructor Documentation

BaseIterator() [1/3]

MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator ( CollectionType &  a, Int  start = 0  )

explicit

BaseIterator() [2/3]

MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator ( ValueType *  pos = nullptr, Int  index = 0, Int  stride = 0  )

explicit

BaseIterator() [3/3]

BaseIterator ( const BaseIterator< COLLECTION, STRIDED > &  src )

default

Member Function Documentation

operator=()

BaseIterator& operator= ( const BaseIterator< COLLECTION, STRIDED > &  src )

default

operator BaseIterator< typename std::add_const< COLLECTION >::type, STRIDED > &()

MAXON_ATTRIBUTE_FORCE_INLINE operator BaseIterator< typename std::add_const< COLLECTION >::type, STRIDED > &

(

)

operator Bool()

MAXON_ATTRIBUTE_FORCE_INLINE operator Bool ( ) const

explicit

Returns

true if the iterator points to an element.

GetPtr()

MAXON_ATTRIBUTE_FORCE_INLINE ValueType* GetPtr

(

)

const

operator*()

MAXON_ATTRIBUTE_FORCE_INLINE ValueType& operator*

(

)

const

operator->()

MAXON_ATTRIBUTE_FORCE_INLINE ValueType* operator->

(

)

const

operator==()

MAXON_ATTRIBUTE_FORCE_INLINE Bool operator==

(

const BaseIterator< COLLECTION, STRIDED > &

b

)

const

operator<()

MAXON_ATTRIBUTE_FORCE_INLINE Bool operator<

(

const BaseIterator< COLLECTION, STRIDED > &

b

)

const

MAXON_OPERATOR_COMPARISON()

MAXON_OPERATOR_COMPARISON

(

BaseIterator< COLLECTION, STRIDED >

)

operator++() [1/2]

MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator& operator++

(

)

operator++() [2/2]

MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator operator++

(

int

)

operator+=()

MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator& operator+=

(

Int

i

)

operator--() [1/2]

MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator& operator--

(

)

operator--() [2/2]

MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator operator--

(

int

)

operator-=()

MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator& operator-=

(

Int

i

)

operator+()

MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator operator+

(

Int

i

)

const

operator-() [1/2]

MAXON_ATTRIBUTE_FORCE_INLINE BaseIterator operator-

(

Int

i

)

const

operator-() [2/2]

MAXON_ATTRIBUTE_FORCE_INLINE Int operator-

(

const BaseIterator< COLLECTION, STRIDED > &

b

)

const

Member Data Documentation

isLinearIterator

const Bool isLinearIterator

static

_data

ValueType* _data

protected