org.bytedeco.arrow

Class InputType

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.InputType

All Implemented Interfaces:

AutoCloseable

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

\brief An object used for type- and shape-checking arguments to be passed to a kernel and stored in a KernelSignature. Distinguishes between ARRAY and SCALAR arguments using ValueDescr::Shape. The type-checking rule can be supplied either with an exact DataType instance or a custom TypeMatcher.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InputType.Kind \brief The kind of type-checking rule that the InputType contains.

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
InputType()
InputType(DataType type)
InputType(DataType type, int shape)
InputType(DataType type, ValueDescr.Shape shape) \brief Accept an exact value type.
InputType(InputType other)
InputType(int shape)
InputType(int type_id, int shape)
InputType(int type_id, ValueDescr.Shape shape) \brief Match any type with the given Type::type.
InputType(long size) Native array allocator.
InputType(Pointer p) Pointer cast constructor.
InputType(TypeMatcher type_matcher)
InputType(TypeMatcher type_matcher, int shape)
InputType(TypeMatcher type_matcher, ValueDescr.Shape shape) \brief Use the passed TypeMatcher to type check.
InputType(ValueDescr.Shape shape) \brief Accept any value type but with a specific shape (e.g.
InputType(ValueDescr descr) \brief Accept an exact value type and shape provided by a ValueDescr.

Method Summary

Modifier and Type	Method and Description
static InputType	Array(DataType type)
static InputType	Array(int id)
boolean	equals(InputType other)
boolean	Equals(InputType other) \brief Return true if this input type matches the same type cases as the other.
InputType	getPointer(long i)
long	Hash() \brief Return hash code.
InputType.Kind	kind() \brief The type matching rule that this InputType uses.
boolean	Matches(Datum value) \brief Return true if the value matches this argument kind in type and shape.
boolean	Matches(ValueDescr value) \brief Return true if the value descriptor matches this argument kind in type and shape.
boolean	notEquals(InputType other)
InputType	position(long position)
void	put(InputType other)
static InputType	Scalar(DataType type)
static InputType	Scalar(int id)
ValueDescr.Shape	shape() \brief Indicates whether this InputType matches Array (ValueDescr::ARRAY), Scalar (ValueDescr::SCALAR) values, or both (ValueDescr::ANY).
String	ToString() \brief Render a human-readable string representation.
TypeMatcher	type_matcher() \brief For InputType::USE_TYPE_MATCHER, the TypeMatcher to be used for checking the type of a value.
DataType	type() \brief For InputType::EXACT_TYPE kind, the exact type that this InputType must match.

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

InputType

public InputType(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

InputType

public InputType(long size)

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

InputType

public InputType(ValueDescr.Shape shape)

\brief Accept any value type but with a specific shape (e.g. any Array or any Scalar).

InputType

public InputType()

InputType

public InputType(@Cast(value="arrow::ValueDescr::Shape")
                 int shape)

InputType

public InputType(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                 DataType type,
                 ValueDescr.Shape shape)

\brief Accept an exact value type.

InputType

public InputType(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                 DataType type)

InputType

public InputType(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                 DataType type,
                 @Cast(value="arrow::ValueDescr::Shape")
                 int shape)

InputType

public InputType(@Const @ByRef
                 ValueDescr descr)

\brief Accept an exact value type and shape provided by a ValueDescr.

InputType

public InputType(@SharedPtr
                 TypeMatcher type_matcher,
                 ValueDescr.Shape shape)

\brief Use the passed TypeMatcher to type check.

InputType

public InputType(@SharedPtr
                 TypeMatcher type_matcher)

InputType

public InputType(@SharedPtr
                 TypeMatcher type_matcher,
                 @Cast(value="arrow::ValueDescr::Shape")
                 int shape)

InputType

public InputType(@Cast(value="arrow::Type::type")
                 int type_id,
                 ValueDescr.Shape shape)

\brief Match any type with the given Type::type. Uses a TypeMatcher for its implementation.

InputType

public InputType(@Cast(value="arrow::Type::type")
                 int type_id,
                 @Cast(value="arrow::ValueDescr::Shape")
                 int shape)

InputType

public InputType(@Const @ByRef
                 InputType other)

Method Detail

position

public InputType position(long position)

Overrides:

position in class Pointer

getPointer

public InputType getPointer(long i)

Overrides:

getPointer in class Pointer

put

@Name(value="operator =")
public void put(@Const @ByRef
                                           InputType other)

Array

@ByVal
public static InputType Array(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                      DataType type)

Scalar

@ByVal
public static InputType Scalar(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::DataType>"})
                                       DataType type)

Array

@ByVal
public static InputType Array(@Cast(value="arrow::Type::type")
                                      int id)

Scalar

@ByVal
public static InputType Scalar(@Cast(value="arrow::Type::type")
                                       int id)

Equals

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

\brief Return true if this input type matches the same type cases as the other.

equals

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

notEquals

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

Hash

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

\brief Return hash code.

ToString

@StdString
public String ToString()

\brief Render a human-readable string representation.

Matches

@Cast(value="bool")
public boolean Matches(@Const @ByRef
                                            Datum value)

\brief Return true if the value matches this argument kind in type and shape.

Matches

@Cast(value="bool")
public boolean Matches(@Const @ByRef
                                            ValueDescr value)

\brief Return true if the value descriptor matches this argument kind in type and shape.

kind

public InputType.Kind kind()

\brief The type matching rule that this InputType uses.

shape

public ValueDescr.Shape shape()

\brief Indicates whether this InputType matches Array (ValueDescr::ARRAY), Scalar (ValueDescr::SCALAR) values, or both (ValueDescr::ANY).

type

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::DataType>"})
public DataType type()

\brief For InputType::EXACT_TYPE kind, the exact type that this InputType must match. Otherwise this function should not be used and will assert in debug builds.

type_matcher

@Const
 @ByRef
public TypeMatcher type_matcher()

\brief For InputType::USE_TYPE_MATCHER, the TypeMatcher to be used for checking the type of a value. Otherwise this function should not be used and will assert in debug builds.