NumCpp  2.12.1
A Templatized Header Only C++ Implementation of the Python NumPy Library
Public Types | Public Member Functions
nc::NdArrayConstIterator< dtype, PointerType, DifferenceType > Class Template Reference

Custom const_iterator for NdArray. More...

#include <NdArrayIterators.hpp>

Inherited by nc::NdArrayIterator< dtype, PointerType, DifferenceType >.

Public Types

using difference_type = DifferenceType
 
using iterator_category = std::random_access_iterator_tag
 
using pointer = PointerType
 
using reference = const value_type &
 
using value_type = dtype
 

Public Member Functions

 NdArrayConstIterator ()=default
 
 NdArrayConstIterator (pointer ptr) noexcept
 
bool operator!= (const self_type &rhs) const noexcept
 
reference operator* () const noexcept
 
self_type operator+ (const difference_type offset) const noexcept
 
self_type & operator++ () noexcept
 
self_type operator++ (int) noexcept
 
self_type & operator+= (const difference_type offset) noexcept
 
self_type operator- (const difference_type offset) const noexcept
 
difference_type operator- (const self_type &rhs) const noexcept
 
self_type & operator-- () noexcept
 
self_type operator-- (int) noexcept
 
self_type & operator-= (const difference_type offset) noexcept
 
pointer operator-> () const noexcept
 
bool operator< (const self_type &rhs) const noexcept
 
bool operator<= (const self_type &rhs) const noexcept
 
bool operator== (const self_type &rhs) const noexcept
 
bool operator> (const self_type &rhs) const noexcept
 
bool operator>= (const self_type &rhs) const noexcept
 
reference operator[] (const difference_type offset) const noexcept
 

Detailed Description

template<typename dtype, typename PointerType, typename DifferenceType>
class nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >

Custom const_iterator for NdArray.

Member Typedef Documentation

◆ difference_type

template<typename dtype , typename PointerType , typename DifferenceType >
using nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::difference_type = DifferenceType

◆ iterator_category

template<typename dtype , typename PointerType , typename DifferenceType >
using nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::iterator_category = std::random_access_iterator_tag

◆ pointer

template<typename dtype , typename PointerType , typename DifferenceType >
using nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::pointer = PointerType

◆ reference

template<typename dtype , typename PointerType , typename DifferenceType >
using nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::reference = const value_type&

◆ value_type

template<typename dtype , typename PointerType , typename DifferenceType >
using nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::value_type = dtype

Constructor & Destructor Documentation

◆ NdArrayConstIterator() [1/2]

template<typename dtype , typename PointerType , typename DifferenceType >
nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::NdArrayConstIterator ( )
default

Default Constructor

◆ NdArrayConstIterator() [2/2]

template<typename dtype , typename PointerType , typename DifferenceType >
nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::NdArrayConstIterator ( pointer  ptr)
inlineexplicitnoexcept

Constructor

Parameters
ptrthe iterator pointer

Member Function Documentation

◆ operator!=()

template<typename dtype , typename PointerType , typename DifferenceType >
bool nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator!= ( const self_type &  rhs) const
inlinenoexcept

Iterator not-equality operator

Parameters
rhs
Returns
bool

◆ operator*()

template<typename dtype , typename PointerType , typename DifferenceType >
reference nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator* ( ) const
inlinenoexcept

Iterator dereference

Returns
reference

◆ operator+()

template<typename dtype , typename PointerType , typename DifferenceType >
self_type nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator+ ( const difference_type  offset) const
inlinenoexcept

Iterator addition operator

Parameters
offset
Returns
NdArrayConstIterator

◆ operator++() [1/2]

template<typename dtype , typename PointerType , typename DifferenceType >
self_type & nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator++ ( )
inlinenoexcept

Iterator prefix incrament operator

Returns
NdArrayConstIterator&

◆ operator++() [2/2]

template<typename dtype , typename PointerType , typename DifferenceType >
self_type nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator++ ( int  )
inlinenoexcept

Iterator postfix incrament operator

Returns
NdArrayConstIterator

◆ operator+=()

template<typename dtype , typename PointerType , typename DifferenceType >
self_type & nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator+= ( const difference_type  offset)
inlinenoexcept

Iterator addition assignement operator

Parameters
offset
Returns
NdArrayConstIterator&

◆ operator-() [1/2]

template<typename dtype , typename PointerType , typename DifferenceType >
self_type nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator- ( const difference_type  offset) const
inlinenoexcept

Iterator subtraction operator

Parameters
offset
Returns
NdArrayConstIterator

◆ operator-() [2/2]

template<typename dtype , typename PointerType , typename DifferenceType >
difference_type nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator- ( const self_type &  rhs) const
inlinenoexcept

Iterator difference operator

Parameters
rhs
Returns
difference_type

◆ operator--() [1/2]

template<typename dtype , typename PointerType , typename DifferenceType >
self_type & nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator-- ( )
inlinenoexcept

Iterator prefix decrament operator

Returns
NdArrayConstIterator&

◆ operator--() [2/2]

template<typename dtype , typename PointerType , typename DifferenceType >
self_type nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator-- ( int  )
inlinenoexcept

Iterator postfix decrament operator

Returns
NdArrayConstIterator

◆ operator-=()

template<typename dtype , typename PointerType , typename DifferenceType >
self_type & nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator-= ( const difference_type  offset)
inlinenoexcept

Iterator subtraction assignement operator

Parameters
offset
Returns
NdArrayConstIterator&

◆ operator->()

template<typename dtype , typename PointerType , typename DifferenceType >
pointer nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator-> ( ) const
inlinenoexcept

Iterator pointer operator

Returns
pointer

◆ operator<()

template<typename dtype , typename PointerType , typename DifferenceType >
bool nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator< ( const self_type &  rhs) const
inlinenoexcept

Iterator less than operator

Parameters
rhs
Returns
bool

◆ operator<=()

template<typename dtype , typename PointerType , typename DifferenceType >
bool nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator<= ( const self_type &  rhs) const
inlinenoexcept

Iterator less than equal operator

Parameters
rhs
Returns
bool

◆ operator==()

template<typename dtype , typename PointerType , typename DifferenceType >
bool nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator== ( const self_type &  rhs) const
inlinenoexcept

Iterator equality operator

Parameters
rhs
Returns
bool

◆ operator>()

template<typename dtype , typename PointerType , typename DifferenceType >
bool nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator> ( const self_type &  rhs) const
inlinenoexcept

Iterator greater than operator

Parameters
rhs
Returns
bool

◆ operator>=()

template<typename dtype , typename PointerType , typename DifferenceType >
bool nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator>= ( const self_type &  rhs) const
inlinenoexcept

Iterator greater than equal operator

Parameters
rhs
Returns
bool

◆ operator[]()

template<typename dtype , typename PointerType , typename DifferenceType >
reference nc::NdArrayConstIterator< dtype, PointerType, DifferenceType >::operator[] ( const difference_type  offset) const
inlinenoexcept

Iterator access operator

Parameters
offset
Returns
reference
The documentation for this class was generated from the following file: