RAJA: RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType > Class Template Reference

RAJA

RAJA provides a collection of platform portability abstractions for C++ HPC applications.

#include <Iterators.hpp>

Public Types
using	value_type = Type

using	stripped_value_type = strip_index_type_t< Type >

using	difference_type = DifferenceType

using	pointer = DifferenceType *

using	reference = DifferenceType &

using	iterator_category = std::random_access_iterator_tag

Public Member Functions
constexpr	strided_numeric_iterator () noexcept=default

constexpr	strided_numeric_iterator (const strided_numeric_iterator &) noexcept=default

constexpr	strided_numeric_iterator (strided_numeric_iterator &&) noexcept=default

strided_numeric_iterator &	operator= (const strided_numeric_iterator &) noexcept=default

strided_numeric_iterator &	operator= (strided_numeric_iterator &&) noexcept=default

constexpr RAJA_HOST_DEVICE	strided_numeric_iterator (stripped_value_type rhs, DifferenceType stride_=DifferenceType(1))

RAJA_HOST_DEVICE DifferenceType	get_stride () const

RAJA_HOST_DEVICE strided_numeric_iterator &	operator++ ()

RAJA_HOST_DEVICE strided_numeric_iterator &	operator-- ()

RAJA_HOST_DEVICE strided_numeric_iterator &	operator+= (const difference_type &rhs)

RAJA_HOST_DEVICE strided_numeric_iterator &	operator-= (const difference_type &rhs)

RAJA_HOST_DEVICE difference_type	operator+ (const strided_numeric_iterator &rhs) const

RAJA_HOST_DEVICE difference_type	operator- (const strided_numeric_iterator &rhs) const

RAJA_HOST_DEVICE strided_numeric_iterator	operator+ (const difference_type &rhs) const

RAJA_HOST_DEVICE strided_numeric_iterator	operator- (const difference_type &rhs) const

RAJA_HOST_DEVICE bool	operator!= (const strided_numeric_iterator &rhs) const

RAJA_HOST_DEVICE bool	operator== (const strided_numeric_iterator &rhs) const

RAJA_HOST_DEVICE bool	operator> (const strided_numeric_iterator &rhs) const

RAJA_HOST_DEVICE bool	operator< (const strided_numeric_iterator &rhs) const

RAJA_HOST_DEVICE bool	operator>= (const strided_numeric_iterator &rhs) const

RAJA_HOST_DEVICE bool	operator<= (const strided_numeric_iterator &rhs) const

RAJA_HOST_DEVICE value_type	operator* () const

RAJA_HOST_DEVICE value_type	operator-> () const

constexpr RAJA_HOST_DEVICE value_type	operator[] (difference_type rhs) const

Member Typedef Documentation

◆ value_type

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

using RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::value_type = Type

◆ stripped_value_type

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

using RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::stripped_value_type = strip_index_type_t<Type>

◆ difference_type

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

using RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::difference_type = DifferenceType

◆ pointer

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

using RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::pointer = DifferenceType*

◆ reference

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

using RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::reference = DifferenceType&

◆ iterator_category

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

using RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::iterator_category = std::random_access_iterator_tag

Constructor & Destructor Documentation

◆ strided_numeric_iterator() [1/4]

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

constexpr RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::strided_numeric_iterator ( )

constexprdefaultnoexcept

◆ strided_numeric_iterator() [2/4]

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

constexpr RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::strided_numeric_iterator ( const strided_numeric_iterator< Type, DifferenceType, PointerType > & )

constexprdefaultnoexcept

◆ strided_numeric_iterator() [3/4]

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

constexpr RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::strided_numeric_iterator ( strided_numeric_iterator< Type, DifferenceType, PointerType > && )

constexprdefaultnoexcept

◆ strided_numeric_iterator() [4/4]

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

constexpr RAJA_HOST_DEVICE RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::strided_numeric_iterator	(	stripped_value_type	rhs,
		DifferenceType	stride_ = `DifferenceType(1)`
	)

inlineconstexpr

Member Function Documentation

◆ operator=() [1/2]

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

strided_numeric_iterator& RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator= ( const strided_numeric_iterator< Type, DifferenceType, PointerType > & )

defaultnoexcept

◆ operator=() [2/2]

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

strided_numeric_iterator& RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator= ( strided_numeric_iterator< Type, DifferenceType, PointerType > && )

defaultnoexcept

◆ get_stride()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE DifferenceType RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::get_stride ( ) const

inline

◆ operator++()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE strided_numeric_iterator& RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator++ ( )

inline

◆ operator--()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE strided_numeric_iterator& RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator-- ( )

inline

◆ operator+=()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE strided_numeric_iterator& RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator+= ( const difference_type & rhs )

inline

◆ operator-=()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE strided_numeric_iterator& RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator-= ( const difference_type & rhs )

inline

◆ operator+() [1/2]

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE difference_type RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator+ ( const strided_numeric_iterator< Type, DifferenceType, PointerType > & rhs ) const

inline

◆ operator-() [1/2]

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE difference_type RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator- ( const strided_numeric_iterator< Type, DifferenceType, PointerType > & rhs ) const

inline

◆ operator+() [2/2]

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE strided_numeric_iterator RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator+ ( const difference_type & rhs ) const

inline

◆ operator-() [2/2]

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE strided_numeric_iterator RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator- ( const difference_type & rhs ) const

inline

◆ operator!=()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE bool RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator!= ( const strided_numeric_iterator< Type, DifferenceType, PointerType > & rhs ) const

inline

◆ operator==()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE bool RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator== ( const strided_numeric_iterator< Type, DifferenceType, PointerType > & rhs ) const

inline

◆ operator>()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE bool RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator> ( const strided_numeric_iterator< Type, DifferenceType, PointerType > & rhs ) const

inline

◆ operator<()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE bool RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator< ( const strided_numeric_iterator< Type, DifferenceType, PointerType > & rhs ) const

inline

◆ operator>=()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE bool RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator>= ( const strided_numeric_iterator< Type, DifferenceType, PointerType > & rhs ) const

inline

◆ operator<=()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE bool RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator<= ( const strided_numeric_iterator< Type, DifferenceType, PointerType > & rhs ) const

inline

◆ operator*()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE value_type RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator* ( ) const

inline

◆ operator->()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

RAJA_HOST_DEVICE value_type RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator-> ( ) const

inline

◆ operator[]()

template<typename Type = Index_type, typename DifferenceType = Type, typename PointerType = Type*>

constexpr RAJA_HOST_DEVICE value_type RAJA::Iterators::strided_numeric_iterator< Type, DifferenceType, PointerType >::operator[] ( difference_type rhs ) const

inlineconstexpr

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

/home/docs/checkouts/readthedocs.org/user_builds/raja/checkouts/v2025.12.2/include/RAJA/internal/Iterators.hpp