org.bytedeco.arrow

Enum Function.Kind

java.lang.Object

java.lang.Enum<Function.Kind>

org.bytedeco.arrow.Function.Kind

All Implemented Interfaces:

Serializable, Comparable<Function.Kind>

Enclosing class:

Function

public static enum Function.Kind
extends Enum<Function.Kind>

\brief The kind of function, which indicates in what contexts it is valid for use.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HASH_AGGREGATE A function that computes grouped summary statistics from array input and an array of group identifiers.
META A function that dispatches to other functions and does not contain its own kernels.
SCALAR A function that performs scalar data operations on whole arrays of data.
SCALAR_AGGREGATE A function that computes scalar summary statistics from array input.
VECTOR A function with array input and output whose behavior depends on the values of the entire arrays passed, rather than the value of each scalar value.

Field Summary

Fields

Modifier and Type	Field and Description
int	value

Method Summary

Modifier and Type	Method and Description
Function.Kind	intern()
String	toString()
static Function.Kind	valueOf(String name) Returns the enum constant of this type with the specified name.
static Function.Kind[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SCALAR

public static final Function.Kind SCALAR

A function that performs scalar data operations on whole arrays of data. Can generally process Array or Scalar values. The size of the output will be the same as the size (or broadcasted size, in the case of mixing Array and Scalar inputs) of the input.

VECTOR

public static final Function.Kind VECTOR

A function with array input and output whose behavior depends on the values of the entire arrays passed, rather than the value of each scalar value.

SCALAR_AGGREGATE

public static final Function.Kind SCALAR_AGGREGATE

A function that computes scalar summary statistics from array input.

HASH_AGGREGATE

public static final Function.Kind HASH_AGGREGATE

A function that computes grouped summary statistics from array input and an array of group identifiers.

META

public static final Function.Kind META

A function that dispatches to other functions and does not contain its own kernels.

Field Detail

value

public final int value

Method Detail

values

public static Function.Kind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Function.Kind c : Function.Kind.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Function.Kind valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

intern

public Function.Kind intern()

toString

public String toString()

Overrides:

toString in class Enum<Function.Kind>