alpaka::core Namespace Reference

Namespaces
namespace	align
	The alignment specifics.
namespace	detail
	Defines implementation details that should not be used directly by the user.
namespace	threads
namespace	vectorization
	Suggests vectorization of the directly following loop to the compiler.

Classes
class	CallbackThread
struct	RoundUpToPowerOfTwo
	Rounds to the next higher power of two (if not already power of two). More...

Functions
ALPAKA_FN_INLINE ALPAKA_FN_HOST auto	alignedAlloc (size_t alignment, size_t size) -> void *
ALPAKA_FN_INLINE ALPAKA_FN_HOST void	alignedFree (size_t alignment, void *ptr)
template<typename TLhs , typename TRhs >
ALPAKA_NO_HOST_ACC_WARNING ALPAKA_FN_HOST_ACC constexpr auto	assertGreaterThan (TRhs const &rhs) -> void
	This function asserts that the integral value TLhs is greater than TRhs.
template<typename TArg >
ALPAKA_NO_HOST_ACC_WARNING ALPAKA_FN_HOST_ACC constexpr auto	assertValueUnsigned (TArg const &arg) -> void
	This method checks integral values if they are greater or equal zero. The implementation prevents warnings for checking this for unsigned types.
template<typename T , typename V >
auto	clipCast (V const &val) -> T
template<typename Integral , typename = std::enable_if_t<std::is_integral_v<Integral>>>
ALPAKA_FN_HOST_ACC constexpr auto	divCeil (Integral a, Integral b) -> Integral
	Returns the ceiling of a / b, as integer.
template<typename Integral , typename = std::enable_if_t<std::is_integral_v<Integral>>>
ALPAKA_FN_HOST_ACC constexpr auto	intPow (Integral base, Integral n) -> Integral
	Computes the nth power of base, in integers.
template<typename Integral , typename = std::enable_if_t<std::is_integral_v<Integral>>>
ALPAKA_FN_HOST_ACC constexpr auto	nthRootFloor (Integral value, Integral n) -> Integral
	Computes the floor of the nth root of value, in integers.

Variables
template<typename T >
constexpr std::string_view	demangled = detail::demangle<T>()

Detailed Description

The following compilers does not use std::source_location therefore we do not include the header. Including the header source_location would lead into compiler issues under the following conditions.

• nvcc is used with clang 15 as host compiler and MDSpan is used too. error: include/c++/11/source_location(53): error: identifier "__builtin_source_location" is undefined

Function Documentation

alignedAlloc()

ALPAKA_FN_INLINE ALPAKA_FN_HOST auto alpaka::core::alignedAlloc	(	size_t	alignment,
		size_t	size
	)		-> void*

Definition at line 14 of file AlignedAlloc.hpp.

alignedFree()

ALPAKA_FN_INLINE ALPAKA_FN_HOST void alpaka::core::alignedFree	(	size_t	alignment,
		void *	ptr
	)

Definition at line 26 of file AlignedAlloc.hpp.

assertGreaterThan()

template<typename TLhs , typename TRhs >

ALPAKA_NO_HOST_ACC_WARNING ALPAKA_FN_HOST_ACC constexpr auto alpaka::core::assertGreaterThan ( TRhs const &  rhs ) -> void

constexpr

This function asserts that the integral value TLhs is greater than TRhs.

Definition at line 101 of file Assert.hpp.

assertValueUnsigned()

template<typename TArg >

ALPAKA_NO_HOST_ACC_WARNING ALPAKA_FN_HOST_ACC constexpr auto alpaka::core::assertValueUnsigned ( TArg const &  arg ) -> void

constexpr

This method checks integral values if they are greater or equal zero. The implementation prevents warnings for checking this for unsigned types.

Definition at line 77 of file Assert.hpp.

clipCast()

template<typename T , typename V >

auto alpaka::core::clipCast

(

V const &

val

)

-> T

Returns

The input casted and clipped to T.

Definition at line 16 of file ClipCast.hpp.

divCeil()

template<typename Integral , typename = std::enable_if_t<std::is_integral_v<Integral>>>

ALPAKA_FN_HOST_ACC constexpr auto alpaka::core::divCeil ( Integral  a, Integral  b  ) -> Integral

constexpr

Returns the ceiling of a / b, as integer.

Definition at line 27 of file Utility.hpp.

intPow()

template<typename Integral , typename = std::enable_if_t<std::is_integral_v<Integral>>>

ALPAKA_FN_HOST_ACC constexpr auto alpaka::core::intPow ( Integral  base, Integral  n  ) -> Integral

constexpr

Computes the nth power of base, in integers.

Definition at line 34 of file Utility.hpp.

nthRootFloor()

template<typename Integral , typename = std::enable_if_t<std::is_integral_v<Integral>>>

ALPAKA_FN_HOST_ACC constexpr auto alpaka::core::nthRootFloor ( Integral  value, Integral  n  ) -> Integral

constexpr

Computes the floor of the nth root of value, in integers.

Definition at line 46 of file Utility.hpp.

Variable Documentation

demangled

template<typename T >

constexpr std::string_view alpaka::core::demangled = detail::demangle<T>()

inlineconstexpr

Definition at line 102 of file DemangleTypeNames.hpp.