org.bytedeco.arrow.global

Enum arrow.RoundMode

java.lang.Object

java.lang.Enum<arrow.RoundMode>

org.bytedeco.arrow.global.arrow.RoundMode

All Implemented Interfaces:

Serializable, Comparable<arrow.RoundMode>

Enclosing class:

arrow

@Namespace(value="arrow::compute")
public static enum arrow.RoundMode
extends Enum<arrow.RoundMode>

Rounding and tie-breaking modes for round compute functions. Additional details and examples are provided in compute.rst.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN Round to nearest integer less than or equal in magnitude (aka "floor")
HALF_DOWN Round ties with DOWN rule
HALF_TO_EVEN Round ties to nearest even integer
HALF_TO_ODD Round ties to nearest odd integer
HALF_TOWARDS_INFINITY Round ties with TOWARDS_INFINITY rule
HALF_TOWARDS_ZERO Round ties with TOWARDS_ZERO rule
HALF_UP Round ties with UP rule
TOWARDS_INFINITY Round negative values with DOWN rule and positive values with UP rule
TOWARDS_ZERO Get the integral part without fractional digits (aka "trunc")
UP Round to nearest integer greater than or equal in magnitude (aka "ceil")

Field Summary

Fields

Modifier and Type	Field and Description
byte	value

Method Summary

Modifier and Type	Method and Description
arrow.RoundMode	intern()
String	toString()
static arrow.RoundMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static arrow.RoundMode[]	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

DOWN

public static final arrow.RoundMode DOWN

Round to nearest integer less than or equal in magnitude (aka "floor")

UP

public static final arrow.RoundMode UP

Round to nearest integer greater than or equal in magnitude (aka "ceil")

TOWARDS_ZERO

public static final arrow.RoundMode TOWARDS_ZERO

Get the integral part without fractional digits (aka "trunc")

TOWARDS_INFINITY

public static final arrow.RoundMode TOWARDS_INFINITY

Round negative values with DOWN rule and positive values with UP rule

HALF_DOWN

public static final arrow.RoundMode HALF_DOWN

Round ties with DOWN rule

HALF_UP

public static final arrow.RoundMode HALF_UP

Round ties with UP rule

HALF_TOWARDS_ZERO

public static final arrow.RoundMode HALF_TOWARDS_ZERO

Round ties with TOWARDS_ZERO rule

HALF_TOWARDS_INFINITY

public static final arrow.RoundMode HALF_TOWARDS_INFINITY

Round ties with TOWARDS_INFINITY rule

HALF_TO_EVEN

public static final arrow.RoundMode HALF_TO_EVEN

Round ties to nearest even integer

HALF_TO_ODD

public static final arrow.RoundMode HALF_TO_ODD

Round ties to nearest odd integer

Field Detail

value

public final byte value

Method Detail

values

public static arrow.RoundMode[] 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 (arrow.RoundMode c : arrow.RoundMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static arrow.RoundMode 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 arrow.RoundMode intern()

toString

public String toString()

Overrides:

toString in class Enum<arrow.RoundMode>