alpaka::onHost::DeviceSelector< T_Api, T_DeviceKind > Struct Template Reference

#include <DeviceSelector.hpp>

Public Member Functions
constexpr	DeviceSelector (alpaka::concepts::DeviceSpec auto deviceSpec)
constexpr	DeviceSelector (T_Api api, T_DeviceKind devType)
uint32_t	getDeviceCount () const
	Get the number of available devices for the given api and device kind.
DeviceProperties	getDeviceProperties (uint32_t idx) const
bool	isAvailable () const
auto	makeDevice (uint32_t idx)
	Get a device.

Private Member Functions
	ALPAKA_TYPEOF (internal::makePlatform(T_Api{}, T_DeviceKind{})) m_platform

Private Attributes
DeviceSpec< T_Api, T_DeviceKind >	m_deviceSpec

Detailed Description

template<alpaka::concepts::Api T_Api, alpaka::concepts::DeviceKind T_DeviceKind>
struct alpaka::onHost::DeviceSelector< T_Api, T_DeviceKind >

Definition at line 15 of file DeviceSelector.hpp.

Constructor & Destructor Documentation

DeviceSelector() [1/2]

template<alpaka::concepts::Api T_Api, alpaka::concepts::DeviceKind T_DeviceKind>

alpaka::onHost::DeviceSelector< T_Api, T_DeviceKind >::DeviceSelector ( alpaka::concepts::DeviceSpec auto deviceSpec )

inlineconstexpr

Definition at line 23 of file DeviceSelector.hpp.

DeviceSelector() [2/2]

template<alpaka::concepts::Api T_Api, alpaka::concepts::DeviceKind T_DeviceKind>

alpaka::onHost::DeviceSelector< T_Api, T_DeviceKind >::DeviceSelector ( T_Api api, T_DeviceKind devType )

inlineconstexpr

Definition at line 29 of file DeviceSelector.hpp.

Member Function Documentation

ALPAKA_TYPEOF()

template<alpaka::concepts::Api T_Api, alpaka::concepts::DeviceKind T_DeviceKind>

alpaka::onHost::DeviceSelector< T_Api, T_DeviceKind >::ALPAKA_TYPEOF ( internal::makePlatform(T_Api{}, T_DeviceKind{}) )

private

getDeviceCount()

template<alpaka::concepts::Api T_Api, alpaka::concepts::DeviceKind T_DeviceKind>

uint32_t alpaka::onHost::DeviceSelector< T_Api, T_DeviceKind >::getDeviceCount ( ) const

inline

Get the number of available devices for the given api and device kind.

Attention

In case the compiler flags you used to build your application were wrong, kernels for the given deviceKind cannot be built and the number of available devices will be zero. This can happen, e.g., if you compile for OneAPI SYCL: you can compile the application, but whether you can run on a device is evaluated at runtime.

Returns

number of devices

Definition at line 42 of file DeviceSelector.hpp.

getDeviceProperties()

template<alpaka::concepts::Api T_Api, alpaka::concepts::DeviceKind T_DeviceKind>

DeviceProperties alpaka::onHost::DeviceSelector< T_Api, T_DeviceKind >::getDeviceProperties ( uint32_t idx ) const

inline

Definition at line 52 of file DeviceSelector.hpp.

isAvailable()

template<alpaka::concepts::Api T_Api, alpaka::concepts::DeviceKind T_DeviceKind>

bool alpaka::onHost::DeviceSelector< T_Api, T_DeviceKind >::isAvailable ( ) const

inline

Definition at line 47 of file DeviceSelector.hpp.

makeDevice()

template<alpaka::concepts::Api T_Api, alpaka::concepts::DeviceKind T_DeviceKind>

auto alpaka::onHost::DeviceSelector< T_Api, T_DeviceKind >::makeDevice ( uint32_t idx )

inline

Get a device.

Parameters

idx	device index (range [0;number of devices), invalid index will throw an exception

Returns

See also

onHost::Device

Definition at line 62 of file DeviceSelector.hpp.

Member Data Documentation

m_deviceSpec

template<alpaka::concepts::Api T_Api, alpaka::concepts::DeviceKind T_DeviceKind>

DeviceSpec<T_Api, T_DeviceKind> alpaka::onHost::DeviceSelector< T_Api, T_DeviceKind >::m_deviceSpec

private

Definition at line 69 of file DeviceSelector.hpp.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/alpaka3/checkouts/latest/include/alpaka/onHost/DeviceSelector.hpp