culite::PinnedBuffer< T > Class Template Reference

A RAII wrapper for pinned host memory allocation. More...

Public Member Functions
	PinnedBuffer ()
	Default constructor.
	PinnedBuffer (std::size_t n)
	Constructs a pinned buffer with specified capacity.
	~PinnedBuffer ()
	Destructor.
void	reserve (std::size_t n)
	Reserves pinned memory for at least the specified number of elements.
void	clear () noexcept
	Frees the allocated pinned memory.
T *	data () noexcept
	Returns a pointer to the pinned memory buffer.
const T *	data () const noexcept
	Returns a const pointer to the pinned memory buffer.
std::size_t	size () const noexcept
	Returns the number of elements in the buffer.

Detailed Description

template<typename T>
class culite::PinnedBuffer< T >

A RAII wrapper for pinned host memory allocation.

This class manages a dynamically allocated buffer in pinned host memory. It automatically handles memory allocation and deallocation following RAII principles, ensuring that pinned memory is properly freed when the buffer goes out of scope.

Template Parameters

T	The type of elements stored in the pinned buffer.

Constructor & Destructor Documentation

PinnedBuffer() [1/2]

template<typename T>

culite::PinnedBuffer< T >::PinnedBuffer ( )

inline

Default constructor.

Constructs an empty pinned buffer with no allocated memory.

PinnedBuffer() [2/2]

template<typename T>

culite::PinnedBuffer< T >::PinnedBuffer ( std::size_t n )

inlineexplicit

Constructs a pinned buffer with specified capacity.

Constructs a pinned buffer and reserves memory for n elements on the host.

Parameters

[in]

n

The number of elements to allocate.

~PinnedBuffer()

template<typename T>

culite::PinnedBuffer< T >::~PinnedBuffer ( )

inline

Destructor.

Automatically frees the allocated pinned memory.

Member Function Documentation

reserve()

template<typename T>

void culite::PinnedBuffer< T >::reserve ( std::size_t n )

inline

Reserves pinned memory for at least the specified number of elements.

If n is greater than the current size, the existing memory is freed and new memory is allocated. If the allocation fails, the buffer is left empty.

Parameters

[in]

n

The number of elements to reserve.

clear()

template<typename T>

void culite::PinnedBuffer< T >::clear ( )

inlinenoexcept

Frees the allocated pinned memory.

Releases all pinned memory and resets the buffer to an empty state.

Note

This function is marked noexcept and is guaranteed not to throw exceptions.

data() [1/2]

template<typename T>

T * culite::PinnedBuffer< T >::data ( )

inlinenoexcept

Returns a pointer to the pinned memory buffer.

Provides direct access to the underlying pinned memory.

Returns

A pointer to the pinned buffer.

data() [2/2]

template<typename T>

const T * culite::PinnedBuffer< T >::data ( ) const

inlinenoexcept

Returns a const pointer to the pinned memory buffer.

Provides direct read-only access to the underlying pinned memory.

Returns

A const pointer to the pinned buffer.

size()

template<typename T>

std::size_t culite::PinnedBuffer< T >::size ( ) const

inlinenoexcept

Returns the number of elements in the buffer.

Returns the capacity of the buffer (number of elements allocated).

Returns

The number of elements the buffer can hold.