cuda::experimental::uninitialized_buffer

template<class _Tp, class ..._Properties>
class uninitialized_buffer

Uninitialized type-safe memory storage

uninitialized_buffer provides a typed buffer allocated from a given memory resource. It handles alignment and release of the allocation. The memory is uninitialized, so that a user needs to ensure elements are properly constructed.

In addition to being type-safe, uninitialized_buffer also takes a set of properties to ensure that e.g. execution space constraints are checked at compile time. However, we can only forward stateless properties. If a user wants to use a stateful one, then they need to implement get_property(const device_buffer&, Property).

Template Parameters:

• _Tp – the type to be stored in the buffer

• _Properties... – The properties the allocated memory satisfies

Public Types

using value_type = _Tp

using reference = _Tp&

using const_reference = const _Tp&

using pointer = _Tp*

using const_pointer = const _Tp*

using size_type = size_t

Public Functions

inline uninitialized_buffer(__resource __mr, const size_t __count)

Constructs an uninitialized_buffer and allocates sufficient storage for __count elements through __mr.

Note

Depending on the alignment requirements of T the size of the underlying allocation might be larger than count * sizeof(T).

Note

Only allocates memory when __count > 0

Parameters:

• __mr – The memory resource to allocate the buffer with.

• __count – The desired size of the buffer.

uninitialized_buffer(const uninitialized_buffer&) = delete

uninitialized_buffer &operator=(const uninitialized_buffer&) = delete

inline uninitialized_buffer(uninitialized_buffer &&__other) noexcept

Move-constructs a uninitialized_buffer from __other.

Parameters:

__other – Another uninitialized_buffer Takes ownership of the allocation in __other and resets it

template<class ..._OtherProperties, ::cuda::std::enable_if_t<__properties_match<_OtherProperties...>, int> = 0>
inline uninitialized_buffer(

uninitialized_buffer<_Tp, _OtherProperties...> &&__other,

) noexcept

Move-constructs a uninitialized_buffer from another uninitialized_buffer with matching properties.

Parameters:

__other – Another uninitialized_buffer Takes ownership of the allocation in __other and resets it

inline uninitialized_buffer &operator=(

uninitialized_buffer &&__other,

) noexcept

Move-assigns a uninitialized_buffer from __other.

Parameters:

__other – Another uninitialized_buffer Deallocates the current allocation and then takes ownership of the allocation in __other and resets it

inline void destroy()

Destroys an uninitialized_buffer, deallocates the buffer and destroys the memory resource.

Warning

destroy does not destroy any objects that may or may not reside within the buffer. It is the user’s responsibility to ensure that all objects within the buffer have been properly destroyed.

inline ~uninitialized_buffer()

Destroys an uninitialized_buffer, deallocates the buffer and destroys the memory resource.

Warning

The destructor does not destroy any objects that may or may not reside within the buffer. It is the user’s responsibility to ensure that all objects within the buffer have been properly destroyed.

inline pointer begin() noexcept

Returns an aligned pointer to the first element in the buffer.

inline const_pointer begin() const noexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

inline pointer end() noexcept

Returns an aligned pointer to the element following the last element of the buffer.

This element acts as a placeholder; attempting to access it results in undefined behavior.

inline const_pointer end() const noexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

inline pointer data() noexcept

Returns an aligned pointer to the first element in the buffer.

inline const_pointer data() const noexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

inline constexpr size_type size() const noexcept

Returns the size of the allocation.

inline constexpr size_type size_bytes() const noexcept

Returns the size of the buffer in bytes.

inline const __resource &memory_resource() const noexcept

Returns a c const reference to the any_resource that holds the memory resource used to allocate the buffer