Moose::Kokkos::JaggedArrayInnerData< T, inner, layout > Class Template Reference

The inner array wrapper class. More...

#include <KokkosJaggedArray.h>

Public Member Functions
KOKKOS_FUNCTION	JaggedArrayInnerData (T *data, JaggedArrayInnerDim< inner > dim)
	Constructor. More...
KOKKOS_FUNCTION unsigned int	size () const
	Get the total inner array size. More...
KOKKOS_FUNCTION unsigned int	n (unsigned int dim) const
	Get the size of a dimension of the inner array. More...
KOKKOS_FUNCTION T &	operator[] (unsigned int i) const
	Get an array entry. More...
template<typename... indices>
KOKKOS_FUNCTION T &	operator() (indices... i) const
	Get an array entry. More...

Protected Attributes
T *	_data
	Pointer to the inner array data. More...
JaggedArrayInnerDim< inner >	_dim
	Inner array dimension information. More...

Detailed Description

template<typename T, unsigned int inner, LayoutType layout>
class Moose::Kokkos::JaggedArrayInnerData< T, inner, layout >

The inner array wrapper class.

This object provides access to an inner array with local multi-dimensional indexing and is created as a temporary object by the jagged array class.

Template Parameters

T	The data type
inner	The inner array dimension size
layout	The memory layout type

Definition at line 52 of file KokkosJaggedArray.h.

Constructor & Destructor Documentation

JaggedArrayInnerData()

template<typename T, unsigned int inner, LayoutType layout>

KOKKOS_FUNCTION Moose::Kokkos::JaggedArrayInnerData< T, inner, layout >::JaggedArrayInnerData ( T *  data, JaggedArrayInnerDim< inner >  dim  )

inline

Constructor.

Parameters

data	The pointer to the inner array data
dim	The inner array dimension information

Definition at line 60 of file KokkosJaggedArray.h.

    : _data(data), _dim(dim)
  {
  }

Member Function Documentation

n()

template<typename T, unsigned int inner, LayoutType layout>

KOKKOS_FUNCTION unsigned int Moose::Kokkos::JaggedArrayInnerData< T, inner, layout >::n ( unsigned int  dim ) const

inline

Get the size of a dimension of the inner array.

Parameters

dim	The dimension index

Returns

The size of the dimension of the inner array

Definition at line 75 of file KokkosJaggedArray.h.

{ return _dim[dim]; }

operator()()

template<typename T , unsigned int inner, LayoutType layout>

template<typename... indices>

KOKKOS_FUNCTION T & Moose::Kokkos::JaggedArrayInnerData< T, inner, layout >::operator()

(

indices...

i

)

const

Get an array entry.

Parameters

i	The inner array index of each dimension

Definition at line 107 of file KokkosJaggedArray.h.

{
  static_assert((std::is_convertible<indices, unsigned int>::value && ...),
                "All arguments must be convertible to unsigned int");
  static_assert(sizeof...(i) == inner, "Number of arguments should match array dimension");

#ifndef NDEBUG
  {
    unsigned int idx[inner] = {static_cast<unsigned int>(i)...};

    for (unsigned int d = 0; d < sizeof...(i); ++d)
      KOKKOS_ASSERT(idx[d] < _dim[d]);
  }
#endif

  unsigned int idx = 0;
  unsigned int d = 0;

  if constexpr (layout == LayoutType::LEFT)
    (((idx +=
       (d == 0 ? static_cast<unsigned int>(i) : static_cast<unsigned int>(i) * _dim.stride[d])),
      ++d),
     ...);
  else
    (((idx += (d == inner - 1 ? static_cast<unsigned int>(i)
                              : static_cast<unsigned int>(i) * _dim.stride[d])),
      ++d),
     ...);

  return _data[idx];
}

operator[]()

template<typename T, unsigned int inner, LayoutType layout>

KOKKOS_FUNCTION T& Moose::Kokkos::JaggedArrayInnerData< T, inner, layout >::operator[] ( unsigned int  i ) const

inline

Get an array entry.

Parameters

i	The dimensionless inner array index

Definition at line 80 of file KokkosJaggedArray.h.

  {
    KOKKOS_ASSERT(i < _dim.stride[inner]);

    return _data[i];
  }

size()

template<typename T, unsigned int inner, LayoutType layout>

KOKKOS_FUNCTION unsigned int Moose::Kokkos::JaggedArrayInnerData< T, inner, layout >::size ( ) const

inline

Get the total inner array size.

Returns

The total inner array size

Definition at line 69 of file KokkosJaggedArray.h.

{ return _dim.stride[inner]; }

Member Data Documentation

_data

template<typename T, unsigned int inner, LayoutType layout>

T* Moose::Kokkos::JaggedArrayInnerData< T, inner, layout >::_data

protected

Pointer to the inner array data.

Definition at line 97 of file KokkosJaggedArray.h.

Referenced by Moose::Kokkos::JaggedArrayInnerData< T, inner, layout >::operator[]().

_dim

template<typename T, unsigned int inner, LayoutType layout>

JaggedArrayInnerDim<inner> Moose::Kokkos::JaggedArrayInnerData< T, inner, layout >::_dim

protected

Inner array dimension information.

Definition at line 101 of file KokkosJaggedArray.h.

Referenced by Moose::Kokkos::JaggedArrayInnerData< T, inner, layout >::n(), Moose::Kokkos::JaggedArrayInnerData< T, inner, layout >::operator[](), and Moose::Kokkos::JaggedArrayInnerData< T, inner, layout >::size().

---

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

• include/kokkos/base/KokkosJaggedArray.h