org.bytedeco.arrow

Class ExecBatch

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.ExecBatch

All Implemented Interfaces:

AutoCloseable

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

\brief A unit of work for kernel execution. It contains a collection of Array and Scalar values and an optional SelectionVector indicating that there is an unmaterialized filter that either must be materialized, or (if the kernel supports it) pushed down into the kernel implementation. ExecBatch is semantically similar to RecordBatch in that in a SQL context it represents a collection of records, but constant "columns" are represented by Scalar values rather than having to be converted into arrays with repeated values. TODO: Datum uses arrow/util/variant.h which may be a bit heavier-weight than is desirable for this class. Microbenchmarks would help determine for sure. See ARROW-8928.

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
ExecBatch()
ExecBatch(DatumVector values, long length)
ExecBatch(long size) Native array allocator.
ExecBatch(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
ValueDescrVector	GetDescriptors() \brief A convenience for returning the ValueDescr objects (types and shapes) from the batch.
ExecBatch	getPointer(long i)
long	length() The semantic length of the ExecBatch.
ExecBatch	length(long setter)
int	num_values() \brief A convenience for the number of values / arguments.
ExecBatch	position(long position)
SelectionVector	selection_vector() A deferred filter represented as an array of indices into the values.
ExecBatch	selection_vector(SelectionVector setter)
DatumVector	values() The values representing positional arguments to be passed to a kernel's exec function for processing.
ExecBatch	values(DatumVector setter)

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, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, 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

ExecBatch

public ExecBatch(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

ExecBatch

public ExecBatch(long size)

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

ExecBatch

public ExecBatch()

ExecBatch

public ExecBatch(@ByVal
                 DatumVector values,
                 @Cast(value="int64_t")
                 long length)

Method Detail

position

public ExecBatch position(long position)

Overrides:

position in class Pointer

getPointer

public ExecBatch getPointer(long i)

Overrides:

getPointer in class Pointer

values

@ByRef
public DatumVector values()

The values representing positional arguments to be passed to a kernel's exec function for processing.

values

public ExecBatch values(DatumVector setter)

selection_vector

@SharedPtr
 @ByRef
public SelectionVector selection_vector()

A deferred filter represented as an array of indices into the values. For example, the filter [true, true, false, true] would be represented as the selection vector [0, 1, 3]. When the selection vector is set, ExecBatch::length is equal to the length of this array.

selection_vector

public ExecBatch selection_vector(SelectionVector setter)

length

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

The semantic length of the ExecBatch. When the values are all scalars, the length should be set to 1, otherwise the length is taken from the array values, except when there is a selection vector. When there is a selection vector set, the length of the batch is the length of the selection. If the array values are of length 0 then the length is 0 regardless of whether any values are Scalar. In general ExecBatch objects are produced by ExecBatchIterator which by design does not yield length-0 batches.

length

public ExecBatch length(long setter)

num_values

public int num_values()

\brief A convenience for the number of values / arguments.

GetDescriptors

@ByVal
public ValueDescrVector GetDescriptors()

\brief A convenience for returning the ValueDescr objects (types and shapes) from the batch.