org.bytedeco.arrow

Class FunctionContext

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FunctionContext

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::compute")
 @NoOffset
 @Properties(inherit=arrow.class)
public class FunctionContext
extends Pointer

\brief Container for variables and options used by function evaluation

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
FunctionContext()
FunctionContext(long size) Native array allocator.
FunctionContext(MemoryPool pool)
FunctionContext(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Allocate(long nbytes, ArrowBuffer out) \brief Allocate buffer from the context's memory pool
CpuInfo	cpu_info()
boolean	HasError() \brief Return true if an error has occurred
MemoryPool	memory_pool()
FunctionContext	position(long position)
void	ResetStatus() \brief Clear any error status
void	SetStatus(Status status) \brief Indicate that an error has occurred, to be checked by a parent caller
Status	status() \brief Return the current status of the context

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, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionContext

public FunctionContext(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

FunctionContext

public FunctionContext(long size)

Native array allocator. Access with Pointer.position(long).

FunctionContext

public FunctionContext(MemoryPool pool)

FunctionContext

public FunctionContext()

Method Detail

position

public FunctionContext position(long position)

Overrides:

position in class Pointer

memory_pool

public MemoryPool memory_pool()

Allocate

@ByVal
public Status Allocate(@Cast(value="const int64_t")
                              long nbytes,
                              @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Buffer>*"})
                              ArrowBuffer out)

\brief Allocate buffer from the context's memory pool

SetStatus

public void SetStatus(@Const @ByRef
                      Status status)

\brief Indicate that an error has occurred, to be checked by a parent caller

Parameters:

status - [in] a Status instance \note Will not overwrite a prior set Status, so we will have the first error that occurred until FunctionContext::ResetStatus is called

ResetStatus

public void ResetStatus()

\brief Clear any error status

HasError

@Cast(value="bool")
public boolean HasError()

\brief Return true if an error has occurred

status

@Const
 @ByRef
public Status status()

\brief Return the current status of the context

cpu_info

public CpuInfo cpu_info()