interface.hpp File Reference

#include "alpaka/api/trait.hpp"
#include "alpaka/concepts.hpp"
#include "alpaka/onHost/DeviceSelector.hpp"
#include "alpaka/onHost/concepts.hpp"
#include "alpaka/tag.hpp"
#include "alpaka/trait.hpp"

Go to the source code of this file.

Namespaces
namespace	alpaka
	main alpaka namespace.
namespace	alpaka::onHost
	Functionality which is usable on the host CPU controller thread.

Functions
template<alpaka::concepts::Api... T_Apis>
consteval auto	alpaka::onHost::allBackends (std::tuple< T_Apis... > const &usedApis, auto const listOfExecutors)
	Generate the full set of backend dictionaries for a set of APIs.
template<concepts::DeviceSpec... T_DevicesSpecs>
consteval auto	alpaka::onHost::allBackends (std::tuple< T_DevicesSpecs... > const &usedDeviceSpecs, auto const &listOfExecutors)
	Generate the full set of backend dictionaries for a set of device kinds.
constexpr auto	alpaka::onHost::createBackendList (auto const devSpecList, auto const listOfExecutors)
	Create the complete backend list for all device specifications and executors.
constexpr auto	alpaka::onHost::createBackendsFor (auto const deviceSpec, auto const listOfExecutors)
	Build a tuple of backends for a single device specification.
constexpr auto	alpaka::onHost::getDeviceSpecsFor (auto const api)
	Create a tuple of device specifications for a single API.
template<alpaka::concepts::Api... T_Apis>
constexpr auto	alpaka::onHost::getDeviceSpecsFor (std::tuple< T_Apis... > const apiList)
	Create a flattened tuple of device specification objects for a list of APIs.
auto	alpaka::onHost::getNativeHandle (auto const &handle)
	Get the native handle of an handle.
void	alpaka::onHost::wait (alpaka::concepts::HasGet auto &handle)
	wait for all work to be finished
Query extents
decltype(auto)	alpaka::onHost::getExtents (alpaka::concepts::HasGet auto &&handle)
	Handle extents.
decltype(auto)	alpaka::onHost::getExtents (auto &&any)
	Object extents.
Query multi-dimensional pitches
decltype(auto)	alpaka::onHost::getPitches (alpaka::concepts::HasGet auto &&handle)
	Handle pitches.
decltype(auto)	alpaka::onHost::getPitches (auto &&any)
	Object pitches.
Query the name
std::convertible_to< std::string > auto	alpaka::onHost::getName (auto &&any)
	Runtime name for a given object.
std::convertible_to< std::string > auto	alpaka::onHost::getName (concepts::NameHandle auto const &handle)
	Runtime name for a given handle.
std::convertible_to< std::string > auto	alpaka::onHost::getStaticName (auto const &any)
	Compile‑time available name for a given object.
std::convertible_to< std::string > auto	alpaka::onHost::getStaticName (concepts::StaticNameHandle auto const &handle)
	Compile‑time available name of an handle.
Query raw pointer
decltype(auto)	alpaka::onHost::data (alpaka::concepts::HasGet auto &&handle)
	pointer to data of an handle
decltype(auto)	alpaka::onHost::data (auto &&any)
	pointer to data of an object
Host allocations
template<typename T_ValueType>
auto	alpaka::onHost::allocHost (alpaka::concepts::VectorOrScalar auto const &extents)
	Allocate host memory for a given element type and extents.
auto	alpaka::onHost::allocHostLike (auto const &view)
	Allocate host memory with the same value type and extents as an existing view.
Device selection utilities
constexpr auto	alpaka::onHost::getExecutorsList (auto const deviceSpec, auto const listOfExecutors)
	Resolve the list of executors supported for a device specification.