org.bytedeco.arrow

Class Kernel

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.Kernel

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ArrayKernel, ScalarAggregateKernel

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

\brief Base type for kernels. Contains the function signature and optionally the state initialization function, along with some common attributes

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
Kernel()
Kernel(InputType in_types, OutputType out_type, Pointer init)
Kernel(KernelSignature sig, Pointer init)
Kernel(long size) Native array allocator.
Kernel(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Kernel	getPointer(long i)
Pointer	init() \brief Create a new KernelState for invocations of this kernel, e.g.
Kernel	init(Pointer setter)
boolean	parallelizable() \brief Indicates whether execution can benefit from parallelization (splitting large chunks into smaller chunks and using multiple threads).
Kernel	parallelizable(boolean setter)
Kernel	position(long position)
KernelSignature	signature() \brief The "signature" of the kernel containing the InputType input argument validators and OutputType output type and shape resolver.
Kernel	signature(KernelSignature setter)
SimdLevel.type	simd_level() \brief Indicates the level of SIMD instruction support in the host CPU is required to use the function.
Kernel	simd_level(SimdLevel.type setter)

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

Kernel

public Kernel(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Kernel

public Kernel(long size)

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

Kernel

public Kernel()

Kernel

public Kernel(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::compute::KernelSignature>"})
              KernelSignature sig,
              @ByVal @Cast(value="arrow::compute::KernelInit*")
              Pointer init)

Kernel

public Kernel(@StdVector
              InputType in_types,
              @ByVal
              OutputType out_type,
              @ByVal @Cast(value="arrow::compute::KernelInit*")
              Pointer init)

Method Detail

position

public Kernel position(long position)

Overrides:

position in class Pointer

getPointer

public Kernel getPointer(long i)

Overrides:

getPointer in class Pointer

signature

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::compute::KernelSignature>"})
public KernelSignature signature()

\brief The "signature" of the kernel containing the InputType input argument validators and OutputType output type and shape resolver.

signature

public Kernel signature(KernelSignature setter)

init

@ByRef
 @Cast(value="arrow::compute::KernelInit*")
public Pointer init()

\brief Create a new KernelState for invocations of this kernel, e.g. to set up any options or state relevant for execution.

init

public Kernel init(Pointer setter)

parallelizable

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

\brief Indicates whether execution can benefit from parallelization (splitting large chunks into smaller chunks and using multiple threads). Some kernels may not support parallel execution at all. Synchronization and concurrency-related issues are currently the responsibility of the Kernel's implementation.

parallelizable

public Kernel parallelizable(boolean setter)

simd_level

public SimdLevel.type simd_level()

\brief Indicates the level of SIMD instruction support in the host CPU is required to use the function. The intention is for functions to be able to contain multiple kernels with the same signature but different levels of SIMD, so that the most optimized kernel supported on a host's processor can be chosen.

simd_level

public Kernel simd_level(SimdLevel.type setter)