org.bytedeco.arrow

Class MemoryPool

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.MemoryPool

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

LoggingMemoryPool, ProxyMemoryPool

@Namespace(value="arrow")
 @Properties(inherit=arrow.class)
public class MemoryPool
extends Pointer

Base class for memory allocation on the CPU. Besides tracking the number of allocated bytes, the allocator also should take care of the required 64-byte alignment.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
MemoryPool(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Allocate(long size, byte[] out)
Status	Allocate(long size, ByteBuffer out)
Status	Allocate(long size, BytePointer out)
Status	Allocate(long size, PointerPointer out) Allocate a new memory region of at least size bytes.
String	backend_name() The name of the backend used by this MemoryPool (e.g.
long	bytes_allocated() The number of bytes that were allocated and not yet free'd through this allocator.
static MemoryPool	CreateDefault() \brief EXPERIMENTAL.
void	Free(byte[] buffer, long size)
void	Free(ByteBuffer buffer, long size)
void	Free(BytePointer buffer, long size) Free an allocated region.
long	max_memory() Return peak memory allocation in this memory pool
Status	Reallocate(long old_size, long new_size, byte[] ptr)
Status	Reallocate(long old_size, long new_size, ByteBuffer ptr)
Status	Reallocate(long old_size, long new_size, BytePointer ptr)
Status	Reallocate(long old_size, long new_size, PointerPointer ptr) Resize an already allocated memory section.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MemoryPool

public MemoryPool(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

CreateDefault

@UniquePtr
public static MemoryPool CreateDefault()

\brief EXPERIMENTAL. Create a new instance of the default MemoryPool

Allocate

@ByVal
public Status Allocate(@Cast(value="int64_t")
                              long size,
                              @Cast(value="uint8_t**")
                              PointerPointer out)

Allocate a new memory region of at least size bytes. The allocated region shall be 64-byte aligned.

Allocate

@ByVal
public Status Allocate(@Cast(value="int64_t")
                              long size,
                              @Cast(value="uint8_t**") @ByPtrPtr
                              BytePointer out)

Allocate

@ByVal
public Status Allocate(@Cast(value="int64_t")
                              long size,
                              @Cast(value="uint8_t**") @ByPtrPtr
                              ByteBuffer out)

Allocate

@ByVal
public Status Allocate(@Cast(value="int64_t")
                              long size,
                              @Cast(value="uint8_t**") @ByPtrPtr
                              byte[] out)

Reallocate

@ByVal
public Status Reallocate(@Cast(value="int64_t")
                                long old_size,
                                @Cast(value="int64_t")
                                long new_size,
                                @Cast(value="uint8_t**")
                                PointerPointer ptr)

Resize an already allocated memory section. As by default most default allocators on a platform don't support aligned reallocation, this function can involve a copy of the underlying data.

Reallocate

@ByVal
public Status Reallocate(@Cast(value="int64_t")
                                long old_size,
                                @Cast(value="int64_t")
                                long new_size,
                                @Cast(value="uint8_t**") @ByPtrPtr
                                BytePointer ptr)

Reallocate

@ByVal
public Status Reallocate(@Cast(value="int64_t")
                                long old_size,
                                @Cast(value="int64_t")
                                long new_size,
                                @Cast(value="uint8_t**") @ByPtrPtr
                                ByteBuffer ptr)

Reallocate

@ByVal
public Status Reallocate(@Cast(value="int64_t")
                                long old_size,
                                @Cast(value="int64_t")
                                long new_size,
                                @Cast(value="uint8_t**") @ByPtrPtr
                                byte[] ptr)

Free

public void Free(@Cast(value="uint8_t*")
                 BytePointer buffer,
                 @Cast(value="int64_t")
                 long size)

Free an allocated region.

Parameters:

buffer - Pointer to the start of the allocated memory region

size - Allocated size located at buffer. An allocator implementation may use this for tracking the amount of allocated bytes as well as for faster deallocation if supported by its backend.

Free

public void Free(@Cast(value="uint8_t*")
                 ByteBuffer buffer,
                 @Cast(value="int64_t")
                 long size)

Free

public void Free(@Cast(value="uint8_t*")
                 byte[] buffer,
                 @Cast(value="int64_t")
                 long size)

bytes_allocated

@Cast(value="int64_t")
public long bytes_allocated()

The number of bytes that were allocated and not yet free'd through this allocator.

max_memory

@Cast(value="int64_t")
public long max_memory()

Return peak memory allocation in this memory pool

Returns:

Maximum bytes allocated. If not known (or not implemented), returns -1

backend_name

@StdString
public String backend_name()

The name of the backend used by this MemoryPool (e.g. "system" or "jemalloc").