Shortcuts

Template Struct StaticExecParams

Struct Documentation

template<size_t SizeX, size_t SizeY, size_t SizeZ, size_t Padding, typename Shared>
struct ripple::StaticExecParams

The StaticExecParams struct defines the parameters of an execution space for which the size is static, and known at compile time.

Template Parameters
  • SizeX: The number of threads to execute in the x dimension.

  • SizeY: The number of threads to execute in the y dimension..

  • SizeZ: The number of threads to execute in the z dimension.

  • Padding: The amount of padding for each size of each dimension.

  • Shared: A type for tile local shared memory.

Public Functions

template<size_t Dims>
constexpr auto size() const noexcept -> size_t

Computes the total size of the execution space, for Dims dimensions.

Return

The total number of elements in the space, including padding.

Template Parameters
  • Dims: The number of dimensions to get the size for.

template<typename Dim>
constexpr auto size(Dim &&dim) const noexcept -> size_t

Computes the size of the space in the given dimension, including padding.

Return

The number of elements in the dimension, including padding.

Parameters
  • dim: The dimension to get the size of the space for.

Template Parameters
  • Dim: The type of the dimension specifier.

constexpr auto padding() const noexcept -> size_t

Gets the amount of padding for the execution space.

Return

The amount of padding of a single size of a single dimension in the space.

template<size_t Dims, typename T>
auto iterator(T *data) const noexcept -> BlockIterator<Value, Space<Dims>>

Gets an iterator over a memory space pointed to by data pointer, for the number of specified dimensions.

Return

An iterator over the memory space.

Parameters
  • data: A pointer to the memory space data.

Template Parameters
  • Dims: The number of dimensions for the iterator.

  • T: The type of the data.

template<size_t Dims>
constexpr auto allocation_size() const noexcept -> size_t

Gets the number of bytes required to allocator data for the space.

Return

The number of bytes required to allocate data for the space.

Template Parameters
  • Dims: The number of dimensions to allocate for.

Docs

Access comprehensive developer documentation for Ripple

View Docs

Tutorials

Get tutorials to help with understand all features

View Tutorials

Examples

Find examples to help get started

View Examples