Class PaddleBuf¶

Defined in File paddle_api.h

Class Documentation¶

class paddle::PaddleBuf¶

Memory manager for PaddleTensor.

The PaddleBuf holds a buffer for data input or output. The memory can be allocated by user or by PaddleBuf itself, but in any case, the PaddleBuf should be reused for better performance.

For user allocated memory, the following API can be used:

PaddleBuf(void* data, size_t length) to set an external memory by specifying the memory address and length.
Reset(void* data, size_t length) to reset the PaddleBuf with an external memory. ATTENTION, for user allocated memory, deallocation should be done by users externally after the program finished. The PaddleBuf won’t do any allocation or deallocation.

To have the PaddleBuf allocate and manage the memory:

PaddleBuf(size_t length) will allocate a memory of size length.
Resize(size_t length) resize the memory to no less than length, ATTENTION if the allocated memory is larger than length, nothing will done.

Usage:

Let PaddleBuf manage the memory internally.

const int num_elements = 128;
PaddleBuf buf(num_elements/// sizeof(float));

Or

PaddleBuf buf;
buf.Resize(num_elements/// sizeof(float));

Works the exactly the same.

One can also make the PaddleBuf use the external memory.

PaddleBuf buf;
void* external_memory = new float[num_elements];
buf.Reset(external_memory, num_elements*sizeof(float));
...
delete[] external_memory; // manage the memory lifetime outside.

Public Functions

PaddleBuf(size_t length)¶

PaddleBuf allocate memory internally, and manage it.

Parameters

[in] length: The length of data.

PaddleBuf(void *data, size_t length)¶

Set external memory, the PaddleBuf won’t manage it.

Parameters

[in] data: The start address of the external memory.
[in] length: The length of data.

PaddleBuf(const PaddleBuf &other)¶

Copy only available when memory is managed externally.

Parameters

[in] other: another PaddleBuf

void Resize(size_t length)¶

Resize the memory.

Parameters

[in] length: The length of data.

void Reset(void *data, size_t length)¶

Reset to external memory, with address and length set.

Parameters

[in] data: The start address of the external memory.
[in] length: The length of data.

bool empty() const¶: Tell whether the buffer is empty.

void *data() const¶: Get the data’s memory address.

size_t length() const¶: Get the memory length.

~PaddleBuf()¶

PaddleBuf &operator=(const PaddleBuf&)¶

PaddleBuf &operator=(PaddleBuf&&)¶

PaddleBuf() = default¶

PaddleBuf(PaddleBuf &&other)¶