alpaka
Abstraction Library for Parallel Kernel Acceleration
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec > Struct Template Reference

The iterator type for BoundaryDirectionsContainer. More...

#include <BoundaryIter.hpp>

Public Types

using const_pointer = value_type const*
using const_reference = value_type const&
using difference_type = std::ptrdiff_t
using pointer = value_type*
using reference = value_type&
using T_BoundaryVec = Vec<BoundaryType, T_dim>
using value_type = BoundaryDirection<T_dim, T_LowHaloVec, T_UpHaloVec>

Public Member Functions

constexpr BoundaryDirectionIter (T_BoundaryVec const &boundaries, T_LowHaloVec const &lower_halo_sizes, T_UpHaloVec const &upper_halo_sizes)
constexpr reference & operator* ()
constexpr const_reference & operator* () const
constexpr auto & operator++ ()
constexpr auto operator<=> (BoundaryDirectionIter const &) const =default

Static Public Member Functions

static consteval auto dim ()

Private Attributes

BoundaryDirection< T_dim, T_LowHaloVec, T_UpHaloVec > boundaries
T_LowHaloVec lowerHaloSizes
T_UpHaloVec upperHaloSizes

Detailed Description

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
struct alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >

The iterator type for BoundaryDirectionsContainer.

Template Parameters
T_dimThe dimensionality of the volume that this is a boundary direction iterator for.
T_LowHaloVecThe vector type used for the lower halo sizes.
T_UpHaloVecThe vector type used for the upper halo sizes.

Definition at line 131 of file BoundaryIter.hpp.

Member Typedef Documentation

◆ const_pointer

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
using alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::const_pointer = value_type const*

Definition at line 140 of file BoundaryIter.hpp.

◆ const_reference

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
using alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::const_reference = value_type const&

Definition at line 138 of file BoundaryIter.hpp.

◆ difference_type

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
using alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::difference_type = std::ptrdiff_t

Definition at line 135 of file BoundaryIter.hpp.

◆ pointer

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
using alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::pointer = value_type*

Definition at line 139 of file BoundaryIter.hpp.

◆ reference

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
using alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::reference = value_type&

Definition at line 137 of file BoundaryIter.hpp.

◆ T_BoundaryVec

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
using alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::T_BoundaryVec = Vec<BoundaryType, T_dim>

Definition at line 133 of file BoundaryIter.hpp.

◆ value_type

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
using alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::value_type = BoundaryDirection<T_dim, T_LowHaloVec, T_UpHaloVec>

Definition at line 136 of file BoundaryIter.hpp.

Constructor & Destructor Documentation

◆ BoundaryDirectionIter()

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::BoundaryDirectionIter ( T_BoundaryVec const & boundaries,
T_LowHaloVec const & lower_halo_sizes,
T_UpHaloVec const & upper_halo_sizes )
inlineconstexpr

Definition at line 142 of file BoundaryIter.hpp.

Member Function Documentation

◆ dim()

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
consteval auto alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::dim ( )
inlinestaticnodiscardconsteval

Definition at line 204 of file BoundaryIter.hpp.

◆ operator*() [1/2]

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
reference & alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::operator* ( )
inlinenodiscardconstexpr

Definition at line 157 of file BoundaryIter.hpp.

◆ operator*() [2/2]

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
const_reference & alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::operator* ( ) const
inlinenodiscardconstexpr

Definition at line 152 of file BoundaryIter.hpp.

◆ operator++()

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
auto & alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::operator++ ( )
inlineconstexpr

Definition at line 162 of file BoundaryIter.hpp.

◆ operator<=>()

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
auto alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::operator<=> ( BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec > const & ) const
nodiscardconstexprdefault

Member Data Documentation

◆ boundaries

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
BoundaryDirection<T_dim, T_LowHaloVec, T_UpHaloVec> alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::boundaries
private

Definition at line 212 of file BoundaryIter.hpp.

◆ lowerHaloSizes

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
T_LowHaloVec alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::lowerHaloSizes
private

Definition at line 214 of file BoundaryIter.hpp.

◆ upperHaloSizes

template<uint32_t T_dim, concepts::Vector T_LowHaloVec, concepts::Vector T_UpHaloVec>
T_UpHaloVec alpaka::BoundaryDirectionIter< T_dim, T_LowHaloVec, T_UpHaloVec >::upperHaloSizes
private

Definition at line 215 of file BoundaryIter.hpp.

The documentation for this struct was generated from the following file:
Generated on for alpaka by doxygen 1.16.1