org.bytedeco.arrow

Class KernelSignature

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.KernelSignature

All Implemented Interfaces:

AutoCloseable

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

\brief Holds the input types and output type of the kernel. VarArgs functions with minimum N arguments should pass up to N input types to be used to validate the input types of a function invocation. The first N-1 types will be matched against the first N-1 arguments, and the last type will be matched against the remaining arguments.

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
KernelSignature(InputType in_types, OutputType out_type)
KernelSignature(InputType in_types, OutputType out_type, boolean is_varargs)
KernelSignature(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(KernelSignature other)
boolean	Equals(KernelSignature other) \brief Returns true if the input types of each signature are equal.
long	Hash() \brief Compute a hash code for the signature
InputType	in_types() \brief The input types for the kernel.
boolean	is_varargs()
static KernelSignature	Make(InputType in_types, OutputType out_type)
static KernelSignature	Make(InputType in_types, OutputType out_type, boolean is_varargs) \brief Convenience ctor since make_shared can be awkward
boolean	MatchesInputs(ValueDescrVector descriptors) \brief Return true if the signature if compatible with the list of input value descriptors.
boolean	notEquals(KernelSignature other)
OutputType	out_type() \brief The output type for the kernel.
String	ToString() \brief Render a human-readable string representation

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

KernelSignature

public KernelSignature(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

KernelSignature

public KernelSignature(@StdVector
                       InputType in_types,
                       @ByVal
                       OutputType out_type,
                       @Cast(value="bool")
                       boolean is_varargs)

KernelSignature

public KernelSignature(@StdVector
                       InputType in_types,
                       @ByVal
                       OutputType out_type)

Method Detail

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::compute::KernelSignature>"})
public static KernelSignature Make(@StdVector
                                                                                                                      InputType in_types,
                                                                                                                      @ByVal
                                                                                                                      OutputType out_type,
                                                                                                                      @Cast(value="bool")
                                                                                                                      boolean is_varargs)

\brief Convenience ctor since make_shared can be awkward

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::compute::KernelSignature>"})
public static KernelSignature Make(@StdVector
                                                                                                                      InputType in_types,
                                                                                                                      @ByVal
                                                                                                                      OutputType out_type)

MatchesInputs

@Cast(value="bool")
public boolean MatchesInputs(@Const @ByRef
                                                  ValueDescrVector descriptors)

\brief Return true if the signature if compatible with the list of input value descriptors.

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                           KernelSignature other)

\brief Returns true if the input types of each signature are equal. Well-formed functions should have a deterministic output type given input types, but currently it is the responsibility of the developer to ensure this.

equals

@Cast(value="bool")
 @Name(value="operator ==")
public boolean equals(@Const @ByRef
                                                                        KernelSignature other)

notEquals

@Cast(value="bool")
 @Name(value="operator !=")
public boolean notEquals(@Const @ByRef
                                                                           KernelSignature other)

Hash

@Cast(value="size_t")
public long Hash()

\brief Compute a hash code for the signature

in_types

@StdVector
public InputType in_types()

\brief The input types for the kernel. For VarArgs functions, this should generally contain a single validator to use for validating all of the function arguments.

out_type

@Const
 @ByRef
public OutputType out_type()

\brief The output type for the kernel. Use Resolve to return the exact output given input argument ValueDescrs, since many kernels' output types depend on their input types (or their type metadata).

ToString

@StdString
public String ToString()

\brief Render a human-readable string representation

is_varargs

@Cast(value="bool")
public boolean is_varargs()