|
Lunchbox
1.11.0
|
|
Lunchbox
1.11.0
|
A simple memory buffer with some helper functions. More...
#include <buffer.h>
Collaboration diagram for lunchbox::Buffer< T >:Public Member Functions | |
| Buffer () | |
| Construct a new, empty buffer. More... | |
| Buffer (const uint64_t size) | |
| Construct a new buffer of the given size. More... | |
| Buffer (Buffer &from) | |
| "Move" constructor, transfers ownership to new Buffer. More... | |
| ~Buffer () | |
| Destruct the buffer. More... | |
| void | clear () |
| Flush the buffer, deleting all data. More... | |
| T * | pack () |
| Tighten the allocated memory to the size of the buffer. More... | |
| Buffer & | operator= (const Buffer &from) |
| Assignment operator, copies data from Buffer. More... | |
| T & | operator[] (const uint64_t position) |
| Direct access to the element at the given index. More... | |
| const T & | operator[] (const uint64_t position) const |
| Direct const access to an element. More... | |
| T * | resize (const uint64_t newSize) |
| Ensure that the buffer contains at least newSize elements. More... | |
| void | grow (const uint64_t newSize) |
| Ensure that the buffer contains at least newSize elements. More... | |
| T * | reserve (const uint64_t newSize) |
| Ensure that the buffer contains at least newSize elements. More... | |
| T * | reset (const uint64_t newSize) |
| Set the buffer size and malloc enough memory. More... | |
| void | setZero () |
| Set the buffer content to 0. More... | |
| void | append (const T *data, const uint64_t size) |
| Append elements to the buffer, increasing the size. More... | |
| void | append (const T &element) |
| Append one element to the buffer. More... | |
| void | replace (const void *data, const uint64_t size) |
| Replace the existing data with new data. More... | |
| void | replace (const Buffer &from) |
| Replace the existing data. More... | |
| void | swap (Buffer &buffer) |
| Swap the buffer contents with another Buffer. More... | |
| T * | getData () |
| const T * | getData () const |
| bool | setSize (const uint64_t size) |
| Set the size of the buffer without changing its allocation. More... | |
| uint64_t | getSize () const |
| uint64_t | getNumBytes () const |
| bool | isEmpty () const |
| uint64_t | getMaxSize () const |
A simple memory buffer with some helper functions.
std::vector does not implement optimizations for growing bitwise-movable vectors, i.e., it copy-constructs each element on growth.
This buffer just memcpy's elements, i.e., it should only be used for PODs since the copy constructor or assignment operator is not called on the copied elements. Primarily used for binary data, e.g., in eq::Image. The implementation works like a pool, that is, data is only released when the buffer is deleted or clear() is called.
|
inline |
|
inlineexplicit |
Construct a new buffer of the given size.
Definition at line 50 of file buffer.h.
References lunchbox::Buffer< T >::reset().
Here is the call graph for this function:
|
explicit |
"Move" constructor, transfers ownership to new Buffer.
Definition at line 21 of file buffer.ipp.
|
inline |
Destruct the buffer.
Definition at line 57 of file buffer.h.
References lunchbox::Buffer< T >::clear().
Here is the call graph for this function:| void lunchbox::Buffer< T >::append | ( | const T * | data, |
| const uint64_t | size | ||
| ) |
Append elements to the buffer, increasing the size.
Definition at line 82 of file buffer.ipp.
| void lunchbox::Buffer< T >::append | ( | const T & | element | ) |
|
inline |
Flush the buffer, deleting all data.
Definition at line 60 of file buffer.h.
Referenced by lunchbox::Buffer< T >::~Buffer().
Here is the caller graph for this function:
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
| void lunchbox::Buffer< T >::grow | ( | const uint64_t | newSize | ) |
Ensure that the buffer contains at least newSize elements.
Existing data is retained. The size is increased, if necessary.
Definition at line 58 of file buffer.ipp.
|
inline |
| Buffer< T > & lunchbox::Buffer< T >::operator= | ( | const Buffer< T > & | from | ) |
|
inline |
|
inline |
| T * lunchbox::Buffer< T >::pack | ( | ) |
Tighten the allocated memory to the size of the buffer.
Definition at line 27 of file buffer.ipp.
| void lunchbox::Buffer< T >::replace | ( | const void * | data, |
| const uint64_t | size | ||
| ) |
|
inline |
Replace the existing data.
Definition at line 128 of file buffer.h.
References lunchbox::Buffer< T >::replace().
Referenced by lunchbox::Buffer< T >::replace().
Here is the call graph for this function: Here is the caller graph for this function:| T * lunchbox::Buffer< T >::reserve | ( | const uint64_t | newSize | ) |
Ensure that the buffer contains at least newSize elements.
Existing data is preserved.
Definition at line 64 of file buffer.ipp.
| T * lunchbox::Buffer< T >::reset | ( | const uint64_t | newSize | ) |
Set the buffer size and malloc enough memory.
Existing data may be deleted.
Definition at line 74 of file buffer.ipp.
Referenced by lunchbox::Buffer< T >::Buffer().
Here is the caller graph for this function:| T * lunchbox::Buffer< T >::resize | ( | const uint64_t | newSize | ) |
Ensure that the buffer contains at least newSize elements.
Existing data is retained. The size is set.
Definition at line 44 of file buffer.ipp.
| bool lunchbox::Buffer< T >::setSize | ( | const uint64_t | size | ) |
Set the size of the buffer without changing its allocation.
This method only modifies the size parameter. If the current allocation of the buffer is too small, it asserts, returns false and does not change the size.
Definition at line 124 of file buffer.ipp.
|
inline |
| void lunchbox::Buffer< T >::swap | ( | Buffer< T > & | buffer | ) |
1.8.6 
