org.bytedeco.arrow

Class ScalarFunction

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Function

org.bytedeco.arrow.ScalarFunction

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::compute")
 @Properties(inherit=arrow.class)
public class ScalarFunction
extends Function

\brief A function that executes elementwise operations on arrays or scalars, and therefore whose results generally do not depend on the order of the values in the arguments. Accepts and returns arrays that are all of the same size. These functions roughly correspond to the functions used in SQL expressions.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.arrow.Function

Function.Kind

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
ScalarFunction(BytePointer name, Arity arity, FunctionDoc doc)
ScalarFunction(BytePointer name, Arity arity, FunctionDoc doc, FunctionOptions default_options)
ScalarFunction(Pointer p) Pointer cast constructor.
ScalarFunction(String name, Arity arity, FunctionDoc doc)
ScalarFunction(String name, Arity arity, FunctionDoc doc, FunctionOptions default_options)

Method Summary

Modifier and Type	Method and Description
Status	AddKernel(InputType in_types, OutputType out_type, Pointer exec)
Status	AddKernel(InputType in_types, OutputType out_type, Pointer exec, Pointer init) \brief Add a kernel with given input/output types, no required state initialization, preallocation for fixed-width types, and default null handling (intersect validity bitmaps of inputs).
Status	AddKernel(ScalarKernel kernel) \brief Add a kernel (function implementation).
KernelResult	DispatchExact(ValueDescrVector values) \brief Return a kernel that can execute the function given the exact argument types (without implicit type casts or scalar->array promotions).

Methods inherited from class org.bytedeco.arrow.Function

arity, default_options, doc, Execute, kind, name, num_kernels, Validate

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, 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

ScalarFunction

public ScalarFunction(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

ScalarFunction

public ScalarFunction(@StdString
                      String name,
                      @Const @ByRef
                      Arity arity,
                      @Const
                      FunctionDoc doc,
                      @Const
                      FunctionOptions default_options)

ScalarFunction

public ScalarFunction(@StdString
                      String name,
                      @Const @ByRef
                      Arity arity,
                      @Const
                      FunctionDoc doc)

ScalarFunction

public ScalarFunction(@StdString
                      BytePointer name,
                      @Const @ByRef
                      Arity arity,
                      @Const
                      FunctionDoc doc,
                      @Const
                      FunctionOptions default_options)

ScalarFunction

public ScalarFunction(@StdString
                      BytePointer name,
                      @Const @ByRef
                      Arity arity,
                      @Const
                      FunctionDoc doc)

Method Detail

AddKernel

@ByVal
public Status AddKernel(@StdVector
                                InputType in_types,
                                @ByVal
                                OutputType out_type,
                                @ByVal @Cast(value="arrow::compute::ArrayKernelExec*")
                                Pointer exec,
                                @ByVal(nullValue="arrow::compute::KernelInit(nullptr)") @Cast(value="arrow::compute::KernelInit*")
                                Pointer init)

\brief Add a kernel with given input/output types, no required state initialization, preallocation for fixed-width types, and default null handling (intersect validity bitmaps of inputs).

AddKernel

@ByVal
public Status AddKernel(@StdVector
                                InputType in_types,
                                @ByVal
                                OutputType out_type,
                                @ByVal @Cast(value="arrow::compute::ArrayKernelExec*")
                                Pointer exec)

AddKernel

@ByVal
public Status AddKernel(@ByVal
                                ScalarKernel kernel)

\brief Add a kernel (function implementation). Returns error if the kernel's signature does not match the function's arity.

DispatchExact

@ByVal
 @Cast(value="arrow::Result<const arrow::compute::Kernel*>*")
public KernelResult DispatchExact(@Const @ByRef
                                                                                                         ValueDescrVector values)

Description copied from class: Function

\brief Return a kernel that can execute the function given the exact argument types (without implicit type casts or scalar->array promotions). NB: This function is overridden in CastFunction.

Overrides:

DispatchExact in class Function