Implements the Buffer interface using malloc and free. More...
#include <MallocBuffer.hpp>
Public Types | |
| using | value_type = T |
| Alias used in the bufferManipulation functions. | |
Public Member Functions | |
| constexpr | MallocBuffer (bool=true) |
| Constructor for creating an empty or uninitialized buffer. More... | |
| MallocBuffer (MallocBuffer const &)=default | |
| Copy constructor, creates a shallow copy. | |
| MallocBuffer (MallocBuffer const &src, std::ptrdiff_t) | |
| Sized copy constructor, creates a shallow copy. More... | |
| constexpr | MallocBuffer (MallocBuffer &&src) |
| Move constructor, creates a shallow copy. More... | |
| template<typename U > | |
| constexpr | MallocBuffer (MallocBuffer< U > const &src) |
Create a shallow copy of src but with a different type. More... | |
| LVARRAY_INTEL_CONSTEXPR MallocBuffer & | operator= (MallocBuffer const &src) |
| Copy assignment operator, creates a shallow copy. More... | |
| LVARRAY_INTEL_CONSTEXPR MallocBuffer & | operator= (MallocBuffer &&src) |
| Move assignment operator, creates a shallow copy. More... | |
| void | reallocate (std::ptrdiff_t const size, MemorySpace const space, std::ptrdiff_t const newCapacity) |
| Reallocate the buffer to the new capacity. More... | |
| void | free () |
| Free the data in the buffer but does not destroy any values. More... | |
| std::ptrdiff_t | capacity () const |
| constexpr T * | data () const |
| template<typename INDEX_TYPE > | |
| constexpr T & | operator[] (INDEX_TYPE const i) const |
 Public Member Functions inherited from LvArray::bufferManipulation::VoidBuffer | |
| void | moveNested (MemorySpace const space, std::ptrdiff_t const size, bool const touch) const |
| Move the buffer to the given execution space, optionally touching it. More... | |
| void | move (MemorySpace const space, bool const touch) const |
| Move the buffer to the given execution space, optionally touching it. More... | |
| MemorySpace | getPreviousSpace () const |
| void | registerTouch (MemorySpace const space) const |
| Touch the buffer in the given space. More... | |
| template<typename = VoidBuffer> | |
| void | setName (std::string const &name) |
| Set the name associated with this buffer. More... | |
Static Public Attributes | |
| static constexpr bool | hasShallowCopy = true |
| Signifies that the MallocBuffer's copy semantics are shallow. | |
Detailed Description
template<typename T>
class LvArray::MallocBuffer< T >
Implements the Buffer interface using malloc and free.
- Template Parameters
-
T type of data that is contained in the buffer.
Both the copy constructor and copy assignment constructor perform a shallow copy of the source. Similarly the destructor does not free the allocation.
- Note
- The parent class bufferManipulation::VoidBuffer provides the default execution space related methods.
Definition at line 35 of file MallocBuffer.hpp.
Constructor & Destructor Documentation
◆ MallocBuffer() [1/4]
|
inline |
Constructor for creating an empty or uninitialized buffer.
- Note
- An uninitialized MallocBuffer is equivalent to an empty MallocBuffer and does not need to be free'd.
Definition at line 51 of file MallocBuffer.hpp.
◆ MallocBuffer() [2/4]
|
inline |
Sized copy constructor, creates a shallow copy.
- Parameters
-
src The buffer to be coppied.
Definition at line 65 of file MallocBuffer.hpp.
◆ MallocBuffer() [3/4]
|
inline |
Move constructor, creates a shallow copy.
- Parameters
-
src The buffer to be moved from, is empty after the move.
Definition at line 74 of file MallocBuffer.hpp.
◆ MallocBuffer() [4/4]
|
inline |
Create a shallow copy of src but with a different type.
- Template Parameters
-
U The type to convert from.
- Parameters
-
src The buffer to copy.
Definition at line 89 of file MallocBuffer.hpp.
Member Function Documentation
◆ capacity()
|
inline |
- Returns
- Return the capacity of the buffer.
Definition at line 160 of file MallocBuffer.hpp.
◆ data()
|
inline |
- Returns
- Return a pointer to the beginning of the buffer.
Definition at line 167 of file MallocBuffer.hpp.
◆ free()
|
inline |
Free the data in the buffer but does not destroy any values.
- Note
- To destroy the values and free the data call bufferManipulation::free.
Definition at line 149 of file MallocBuffer.hpp.
◆ operator=() [1/2]
|
inline |
Copy assignment operator, creates a shallow copy.
- Parameters
-
src The buffer to be copied.
- Returns
- *this.
Definition at line 100 of file MallocBuffer.hpp.
◆ operator=() [2/2]
|
inline |
Move assignment operator, creates a shallow copy.
- Parameters
-
src The buffer to be moved from, is empty after the move.
- Returns
- *this.
Definition at line 113 of file MallocBuffer.hpp.
◆ operator[]()
|
inline |
- Template Parameters
-
INDEX_TYPE the type used to index into the values.
- Returns
- The value at position
i.
- Parameters
-
i The position of the value to access.
- Note
- No bounds checks are performed.
Definition at line 178 of file MallocBuffer.hpp.
◆ reallocate()
|
inline |
Reallocate the buffer to the new capacity.
- Parameters
-
size The number of values that are initialized in the buffer. space The space to perform the reallocation in, not used. newCapacity The new capacity of the buffer.
Definition at line 128 of file MallocBuffer.hpp.
The documentation for this class was generated from the following file:
- coreComponents/LvArray/src/MallocBuffer.hpp
