#include <TensorIterator.h>

Collaboration diagram for txeo::TensorIterator< T >:

Public Types
using	value_type = T

using	pointer = T *

using	reference = T &

using	difference_type = std::ptrdiff_t

using	iterator_category = std::random_access_iterator_tag

Public Member Functions
	TensorIterator ()

	TensorIterator (T *elements, std::ptrdiff_t step=1)

reference	operator* () const

pointer	operator-> () const

TensorIterator &	operator++ ()

TensorIterator	operator++ (int)

TensorIterator &	operator-- ()

TensorIterator	operator-- (int)

TensorIterator &	operator+= (const difference_type &val)

TensorIterator &	operator-= (const difference_type &val)

difference_type	operator- (const TensorIterator &other) const

bool	operator== (const TensorIterator &other) const

bool	operator!= (const TensorIterator &other) const

bool	operator< (const TensorIterator &other) const

bool	operator> (const TensorIterator &other) const

bool	operator<= (const TensorIterator &other) const

bool	operator>= (const TensorIterator &other) const

Detailed Description

template<typename T>
class txeo::TensorIterator< T >

Definition at line 10 of file TensorIterator.h.

Member Typedef Documentation

◆ difference_type

template<typename T >

using txeo::TensorIterator< T >::difference_type = std::ptrdiff_t

Definition at line 15 of file TensorIterator.h.

◆ iterator_category

template<typename T >

using txeo::TensorIterator< T >::iterator_category = std::random_access_iterator_tag

Definition at line 16 of file TensorIterator.h.

◆ pointer

template<typename T >

using txeo::TensorIterator< T >::pointer = T *

Definition at line 13 of file TensorIterator.h.

◆ reference

template<typename T >

using txeo::TensorIterator< T >::reference = T &

Definition at line 14 of file TensorIterator.h.

◆ value_type

template<typename T >

using txeo::TensorIterator< T >::value_type = T

Definition at line 12 of file TensorIterator.h.

Constructor & Destructor Documentation

◆ TensorIterator() [1/2]

template<typename T >

txeo::TensorIterator< T >::TensorIterator ( )

inline

Definition at line 18 of file TensorIterator.h.

18: _elements(nullptr), _step(1) {} // required by some std functions

◆ TensorIterator() [2/2]

template<typename T >

txeo::TensorIterator< T >::TensorIterator	(	T *	elements,
		std::ptrdiff_t	step = `1`
	)

inline

Definition at line 19 of file TensorIterator.h.

19: _elements(elements), _step(step) {}

Member Function Documentation

◆ operator!=()

template<typename T >

bool txeo::TensorIterator< T >::operator!= ( const TensorIterator< T > & other ) const

inline

Definition at line 78 of file TensorIterator.h.

                                                              {
      return _elements != other._elements;
    }

◆ operator*()

template<typename T >

reference txeo::TensorIterator< T >::operator* ( ) const

inline

Definition at line 21 of file TensorIterator.h.

21{ return *_elements; }

◆ operator++() [1/2]

template<typename T >

TensorIterator & txeo::TensorIterator< T >::operator++ ( )

inline

Definition at line 24 of file TensorIterator.h.

                                        {
      _elements += _step;
      return *this;
    }

◆ operator++() [2/2]

template<typename T >

TensorIterator txeo::TensorIterator< T >::operator++ ( int )

inline

Definition at line 29 of file TensorIterator.h.

                                          {
      auto aux = *this;
      ++(*this);
      return aux;
    }

◆ operator+=()

template<typename T >

TensorIterator & txeo::TensorIterator< T >::operator+= ( const difference_type & val )

inline

Definition at line 46 of file TensorIterator.h.

                                                                  {
      _elements += val * _step;
      return *this;
    }

◆ operator-()

template<typename T >

difference_type txeo::TensorIterator< T >::operator- ( const TensorIterator< T > & other ) const

inline

Definition at line 71 of file TensorIterator.h.

                                                                        {
      return (_elements - other._elements) / _step;
    }

◆ operator--() [1/2]

template<typename T >

TensorIterator & txeo::TensorIterator< T >::operator-- ( )

inline

Definition at line 35 of file TensorIterator.h.

                                        {
      _elements -= _step;
      return *this;
    }

◆ operator--() [2/2]

template<typename T >

TensorIterator txeo::TensorIterator< T >::operator-- ( int )

inline

Definition at line 40 of file TensorIterator.h.

                                          {
      auto aux = *this;
      --(*this);
      return aux;
    }

◆ operator-=()

template<typename T >

TensorIterator & txeo::TensorIterator< T >::operator-= ( const difference_type & val )

inline

Definition at line 51 of file TensorIterator.h.

                                                                  {
      _elements -= val * _step;
      return *this;
    }

◆ operator->()

template<typename T >

pointer txeo::TensorIterator< T >::operator-> ( ) const

inline

Definition at line 22 of file TensorIterator.h.

22{ return _elements; }

◆ operator<()

template<typename T >

bool txeo::TensorIterator< T >::operator< ( const TensorIterator< T > & other ) const

inline

Definition at line 81 of file TensorIterator.h.

81{ return _elements < other._elements; }

◆ operator<=()

template<typename T >

bool txeo::TensorIterator< T >::operator<= ( const TensorIterator< T > & other ) const

inline

Definition at line 83 of file TensorIterator.h.

                                                              {
      return _elements <= other._elements;
    }

◆ operator==()

template<typename T >

bool txeo::TensorIterator< T >::operator== ( const TensorIterator< T > & other ) const

inline

Definition at line 75 of file TensorIterator.h.

                                                              {
      return _elements == other._elements;
    }

◆ operator>()

template<typename T >

bool txeo::TensorIterator< T >::operator> ( const TensorIterator< T > & other ) const

inline

Definition at line 82 of file TensorIterator.h.

82{ return _elements > other._elements; }

◆ operator>=()

template<typename T >

bool txeo::TensorIterator< T >::operator>= ( const TensorIterator< T > & other ) const

inline

Definition at line 86 of file TensorIterator.h.

                                                              {
      return _elements >= other._elements;
    }

Friends And Related Symbol Documentation

◆ operator+ [1/2]

template<typename T >

TensorIterator operator+	(	const difference_type &	val,
		TensorIterator< T >	iterator
	)

friend

Definition at line 61 of file TensorIterator.h.

                                                                                         {
      iterator += val;
      return iterator;
    }

◆ operator+ [2/2]

template<typename T >

TensorIterator operator+	(	TensorIterator< T >	iterator,
		const difference_type &	val
	)

friend

Definition at line 56 of file TensorIterator.h.

                                                                                         {
      iterator += val;
      return iterator;
    }

◆ operator-

template<typename T >

TensorIterator operator-	(	TensorIterator< T >	iterator,
		const difference_type &	val
	)

friend

Definition at line 66 of file TensorIterator.h.

                                                                                         {
      iterator -= val;
      return iterator;
    }

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

include/txeo/TensorIterator.h

Friends
TensorIterator	operator+ (TensorIterator iterator, const difference_type &val)

TensorIterator	operator+ (const difference_type &val, TensorIterator iterator)

TensorIterator	operator- (TensorIterator iterator, const difference_type &val)

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ difference_type

◆ iterator_category

◆ pointer

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ TensorIterator() [1/2]

◆ TensorIterator() [2/2]

Member Function Documentation

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-()

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator->()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

Friends And Related Symbol Documentation

◆ operator+ [1/2]

◆ operator+ [2/2]

◆ operator-