Traits.hpp File Reference

#include "alpaka/core/Common.hpp"
#include "alpaka/core/Config.hpp"
#include "alpaka/mem/view/Traits.hpp"
#include "alpaka/platform/Traits.hpp"

Go to the source code of this file.

Classes
struct	alpaka::trait::HasAsyncBufSupport< TDim, TDev >
	The stream-ordered memory allocation capability trait. More...
struct	alpaka::trait::HasMappedBufSupport< TPlatform >
	The pinned/mapped memory allocation capability trait. More...

Namespaces
namespace	alpaka
	The alpaka accelerator library.
namespace	alpaka::trait
	The accelerator traits.

Typedefs
template<typename TDev , typename TElem , typename TDim , typename TIdx >
using	alpaka::Buf = typename trait::BufType< alpaka::Dev< TDev >, TElem, TDim, TIdx >::type
	The memory buffer type trait alias template to remove the ::type for a Buffer type.
template<typename TDev , typename TElem , typename TDim , typename TIdx >
using	alpaka::ConstBuf = typename trait::ConstBufType< alpaka::Dev< TDev >, TElem, TDim, TIdx >::type
	The memory buffer type trait alias template to remove the ::type for a ConstBuffer type.

Functions
template<typename TElem , typename TIdx , typename TExtent , typename TQueue >
ALPAKA_FN_HOST auto	alpaka::allocAsyncBuf (TQueue queue, TExtent const &extent=TExtent())
	Allocates stream-ordered memory on the given device.
template<typename TElem , typename TIdx , typename TExtent , typename TQueue >
ALPAKA_FN_HOST auto	alpaka::allocAsyncBufIfSupported (TQueue queue, TExtent const &extent=TExtent())
	If supported, allocates stream-ordered memory on the given queue and the associated device. Otherwise, allocates regular memory on the device associated to the queue. Please note that stream-ordered and regular memory have different semantics: this function is provided for convenience in the cases where the difference is not relevant, and the stream-ordered memory is only used as a performance optimisation.
template<typename TElem , typename TIdx , typename TExtent , typename TDev >
ALPAKA_FN_HOST auto	alpaka::allocBuf (TDev const &dev, TExtent const &extent=TExtent())
	Allocates memory on the given device.
template<typename TElem , typename TIdx , typename TExtent , typename TPlatform >
ALPAKA_FN_HOST auto	alpaka::allocMappedBuf (DevCpu const &host, TPlatform const &platform, TExtent const &extent=TExtent())
	Allocates pinned/mapped host memory, accessible by all devices in the given platform.
template<typename TElem , typename TIdx , typename TExtent , typename TPlatform >
ALPAKA_FN_HOST auto	alpaka::allocMappedBufIfSupported (DevCpu const &host, TPlatform const &platform, TExtent const &extent=TExtent())
	If supported, allocates pinned/mapped host memory, accessible by all devices in the given platform. Otherwise, allocates regular host memory. Please note that pinned/mapped and regular memory may have different semantics: this function is provided for convenience in the cases where the difference is not relevant, and the pinned/mapped memory is only used as a performance optimisation.
template<typename TBuf >
ALPAKA_FN_HOST auto	alpaka::makeConstBuf (TBuf &&buf)
template<typename TBuf >
ALPAKA_FN_HOST auto	alpaka::makeConstBuf (TBuf const &buf)
	Creates a constant buffer from the given mutable buffer.

Variables
template<typename TDev , typename TDim >
constexpr bool	alpaka::hasAsyncBufSupport = trait::HasAsyncBufSupport<TDim, TDev>::value
	Checks if the given device can allocate a stream-ordered memory buffer of the given dimensionality.
template<typename TPlatform >
constexpr bool	alpaka::hasMappedBufSupport = trait::HasMappedBufSupport<TPlatform>::value
	Checks if the host can allocate a pinned/mapped host memory, accessible by all devices in the given platform.