org.bytedeco.arrow

Class Function

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Function

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

HashAggregateFunction, MetaFunction, ScalarAggregateFunction, ScalarFunction, VectorFunction

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

\brief Base class for compute functions. Function implementations contain a collection of "kernels" which are implementations of the function for specific argument types. Selecting a viable kernel for executing a function is referred to as "dispatching".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Function.Kind \brief The kind of function, which indicates in what contexts it is valid for use.

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
Function(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Arity	arity() \brief Contains the number of arguments the function requires, or if the function accepts variable numbers of arguments.
FunctionOptions	default_options() \brief Returns a the default options for this function.
KernelResult	DispatchBest(ValueDescrVector values) \brief Return a best-match kernel that can execute the function given the argument types, after implicit casts are applied.
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).
FunctionDoc	doc() \brief Return the function documentation
DatumResult	Execute(DatumVector args, FunctionOptions options, ExecContext ctx) \brief Execute the function eagerly with the passed input arguments with kernel dispatch, batch iteration, and memory allocation details taken care of.
Function.Kind	kind() \brief The kind of kernel, which indicates in what contexts it is valid for use.
String	name() \brief The name of the kernel.
int	num_kernels() \brief Returns the number of registered kernels for this function.
Status	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, 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

Function

public Function(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

name

@StdString
public String name()

\brief The name of the kernel. The registry enforces uniqueness of names.

kind

public Function.Kind kind()

\brief The kind of kernel, which indicates in what contexts it is valid for use.

arity

@Const
 @ByRef
public Arity arity()

\brief Contains the number of arguments the function requires, or if the function accepts variable numbers of arguments.

doc

@Const
 @ByRef
public FunctionDoc doc()

\brief Return the function documentation

num_kernels

public int num_kernels()

\brief Returns the number of registered kernels for this function.

DispatchExact

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

\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.

DispatchBest

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

\brief Return a best-match kernel that can execute the function given the argument types, after implicit casts are applied.

Parameters:

values - [in,out] Argument types. An element may be modified to indicate that the returned kernel only approximately matches the input value descriptors; callers are responsible for casting inputs to the type and shape required by the kernel.

Execute

@ByVal
public DatumResult Execute(@Const @ByRef
                                  DatumVector args,
                                  @Const
                                  FunctionOptions options,
                                  ExecContext ctx)

\brief Execute the function eagerly with the passed input arguments with kernel dispatch, batch iteration, and memory allocation details taken care of. If the options pointer is null, then default_options() will be used. This function can be overridden in subclasses.

default_options

@Const
public FunctionOptions default_options()

\brief Returns a the default options for this function. Whatever option semantics a Function has, implementations must guarantee that default_options() is valid to pass to Execute as options.

Validate

@ByVal
public Status Validate()