org.bytedeco.arrow

Class KernelContext

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.KernelContext

All Implemented Interfaces:

AutoCloseable

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

\brief Context/state for the execution of a particular kernel.

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
KernelContext(ExecContext exec_ctx)
KernelContext(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
ResizableResult	Allocate(long nbytes) \brief Allocate buffer from the context's memory pool.
ExecContext	exec_context() \brief Configuration related to function execution that is to be shared across multiple kernels.
boolean	HasError() \brief Return true if an error has occurred.
MemoryPool	memory_pool() \brief The memory pool to use for allocations.
void	ResetStatus() \brief Clear any error status.
void	SetState(KernelState state) \brief Assign the active KernelState to be utilized for each stage of kernel execution.
void	SetStatus(Status status) \brief Indicate that an error has occurred, to be checked by a exec caller
KernelState	state()
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, 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

KernelContext

public KernelContext(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

KernelContext

public KernelContext(ExecContext exec_ctx)

Method Detail

Allocate

@ByVal
public ResizableResult Allocate(@Cast(value="int64_t")
                                       long nbytes)

\brief Allocate buffer from the context's memory pool. The contents are not initialized.

SetStatus

public void SetStatus(@Const @ByRef
                      Status status)

\brief Indicate that an error has occurred, to be checked by a exec 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 ExecContext::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.

SetState

public void SetState(KernelState state)

\brief Assign the active KernelState to be utilized for each stage of kernel execution. Ownership and memory lifetime of the KernelState must be minded separately.

state

public KernelState state()

exec_context

public ExecContext exec_context()

\brief Configuration related to function execution that is to be shared across multiple kernels.

memory_pool

public MemoryPool memory_pool()

\brief The memory pool to use for allocations. For now, it uses the MemoryPool contained in the ExecContext used to create the KernelContext.