org.bytedeco.arrow

Class OutputType

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.OutputType

All Implemented Interfaces:

AutoCloseable

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

\brief Container to capture both exact and input-dependent output types. The value shape returned by Resolve will be determined by broadcasting the shapes of the input arguments, otherwise this is handled by the user-defined resolver function: * Any ARRAY shape -> output shape is ARRAY * All SCALAR shapes -> output shape is SCALAR

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutputType.ResolveKind \brief An enum indicating whether the value type is an invariant fixed value or one that's computed by a kernel-defined resolver function.

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
OutputType(DataType type) \brief Output an exact type, but with shape determined by promoting the shapes of the inputs (any ARRAY argument yields ARRAY).
OutputType(OutputType other)
OutputType(Pointer resolver)
OutputType(ValueDescr descr) \brief Output the exact type and shape provided by a ValueDescr

Method Summary

Modifier and Type	Method and Description
OutputType.ResolveKind	kind() \brief Return the kind of type resolution of this output type, whether fixed/invariant or computed by a resolver.
ValueDescrResult	Resolve(KernelContext ctx, ValueDescrVector args) \brief Return the shape and type of the expected output value of the kernel given the value descriptors (shapes and types) of the input arguments.
Pointer	resolver() \brief For use with COMPUTED resolution strategy.
ValueDescr.Shape	shape() \brief If the shape is ANY, then Resolve will compute the shape based on the input arguments.
String	ToString() \brief Render a human-readable string representation.
DataType	type() \brief The exact output value type for the FIXED kind.

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

OutputType

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

\brief Output an exact type, but with shape determined by promoting the shapes of the inputs (any ARRAY argument yields ARRAY).

OutputType

public OutputType(@ByVal
                  ValueDescr descr)

\brief Output the exact type and shape provided by a ValueDescr

OutputType

public OutputType(@ByVal @Cast(value="arrow::compute::OutputType::Resolver*")
                  Pointer resolver)

OutputType

public OutputType(@Const @ByRef
                  OutputType other)

Method Detail

Resolve

@ByVal
public ValueDescrResult Resolve(KernelContext ctx,
                                        @Const @ByRef
                                        ValueDescrVector args)

\brief Return the shape and type of the expected output value of the kernel given the value descriptors (shapes and types) of the input arguments. The resolver may make use of state information kept in the KernelContext.

type

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

\brief The exact output value type for the FIXED kind.

resolver

@Cast(value="const arrow::compute::OutputType::Resolver*")
 @ByRef
public Pointer resolver()

\brief For use with COMPUTED resolution strategy. It may be more convenient to invoke this with OutputType::Resolve returned from this method.

ToString

@StdString
public String ToString()

\brief Render a human-readable string representation.

kind

public OutputType.ResolveKind kind()

\brief Return the kind of type resolution of this output type, whether fixed/invariant or computed by a resolver.

shape

public ValueDescr.Shape shape()

\brief If the shape is ANY, then Resolve will compute the shape based on the input arguments.