org.bytedeco.arrow

Class FunctionRegistry

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FunctionRegistry

All Implemented Interfaces:

AutoCloseable

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

\brief A mutable central function registry for built-in functions as well as user-defined functions. Functions are implementations of arrow::compute::Function. Generally, each function contains kernels which are implementations of a function for a specific argument signature. After looking up a function in the registry, one can either execute it eagerly with Function::Execute or use one of the function's dispatch methods to pick a suitable kernel for lower-level function execution.

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

Method Summary

Modifier and Type	Method and Description
Status	AddAlias(BytePointer target_name, BytePointer source_name)
Status	AddAlias(String target_name, String source_name) \brief Add aliases for the given function name.
Status	AddFunction(Function function)
Status	AddFunction(Function function, boolean allow_overwrite) \brief Add a new function to the registry.
FunctionResult	GetFunction(BytePointer name)
FunctionResult	GetFunction(String name) \brief Retrieve a function by name from the registry
StringVector	GetFunctionNames() \brief Return vector of all entry names in the registry.
static FunctionRegistry	Make() \brief Construct a new registry.
int	num_functions() \brief The number of currently registered functions

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

FunctionRegistry

public FunctionRegistry(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Make

@UniquePtr
public static FunctionRegistry Make()

\brief Construct a new registry. Most users only need to use the global registry

AddFunction

@ByVal
public Status AddFunction(@SharedPtr
                                 Function function,
                                 @Cast(value="bool")
                                 boolean allow_overwrite)

\brief Add a new function to the registry. Returns Status::KeyError if a function with the same name is already registered

AddFunction

@ByVal
public Status AddFunction(@SharedPtr
                                 Function function)

AddAlias

@ByVal
public Status AddAlias(@StdString
                              String target_name,
                              @StdString
                              String source_name)

\brief Add aliases for the given function name. Returns Status::KeyError if the function with the given name is not registered

AddAlias

@ByVal
public Status AddAlias(@StdString
                              BytePointer target_name,
                              @StdString
                              BytePointer source_name)

GetFunction

@ByVal
public FunctionResult GetFunction(@StdString
                                         String name)

\brief Retrieve a function by name from the registry

GetFunction

@ByVal
public FunctionResult GetFunction(@StdString
                                         BytePointer name)

GetFunctionNames

@ByVal
public StringVector GetFunctionNames()

\brief Return vector of all entry names in the registry. Helpful for displaying a manifest of available functions

num_functions

public int num_functions()

\brief The number of currently registered functions