Representation of OpenMP schedule information: kind and chunk size. This class can be used regardless of whether OpenMP is enabled. More...

#include <OmpSchedule.hpp>

Public Types
enum	Kind { NoSchedule , Static = 1u , Dynamic = 2u , Guided = 3u , Auto = 4u , Runtime = 5u }
	Schedule kinds corresponding to arguments of OpenMP schedule clause. More...

Public Member Functions
constexpr ALPAKA_FN_HOST	Schedule (Kind myKind=NoSchedule, int myChunkSize=0)
	Create a schedule with the given kind and chunk size. More...

Public Attributes
int	chunkSize
	Chunk size. Same as in OpenMP, value 0 corresponds to default chunk size. Using int and not a fixed-width type to match OpenMP API. More...

Kind	kind
	Schedule kind. More...

Detailed Description

Representation of OpenMP schedule information: kind and chunk size. This class can be used regardless of whether OpenMP is enabled.

Definition at line 19 of file OmpSchedule.hpp.

Member Enumeration Documentation

◆ Kind

enum alpaka::omp::Schedule::Kind

Schedule kinds corresponding to arguments of OpenMP schedule clause.

Kinds also present in omp_sched_t enum have the same integer values. It is enum, not enum class, for shorter usage as omp::Schedule::[kind] and to keep interface of 0.6.0.

Enumerator
NoSchedule
Static
Dynamic
Guided
Auto
Runtime

Definition at line 25 of file OmpSchedule.hpp.

Constructor & Destructor Documentation

◆ Schedule()

constexpr ALPAKA_FN_HOST alpaka::omp::Schedule::Schedule	(	Kind	myKind = `NoSchedule`,
		int	myChunkSize = `0`
	)

inlineconstexpr

Create a schedule with the given kind and chunk size.

Definition at line 47 of file OmpSchedule.hpp.

Member Data Documentation

◆ chunkSize

int alpaka::omp::Schedule::chunkSize

Chunk size. Same as in OpenMP, value 0 corresponds to default chunk size. Using int and not a fixed-width type to match OpenMP API.

Definition at line 44 of file OmpSchedule.hpp.

◆ kind

Kind alpaka::omp::Schedule::kind

Schedule kind.

Definition at line 40 of file OmpSchedule.hpp.

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

/home/runner/work/alpaka/alpaka/include/alpaka/core/OmpSchedule.hpp

Public Types

Public Member Functions

Public Attributes