Compute Functions — Apache Arrow v20.0.0 (original) (raw)
Aggregations#
Cumulative Functions#
Cumulative functions are vector functions that perform a running accumulation on their input using a given binary associative operation with an identity element (a monoid) and output an array containing the corresponding intermediate running values. The input is expected to be of numeric type. By default these functions do not detect overflow. They are also available in an overflow-checking variant, suffixed _checked, which throws an ArrowInvalid exception when overflow is detected.
Arithmetic Functions#
By default these functions do not detect overflow. Most functions are also available in an overflow-checking variant, suffixed _checked, which throws an ArrowInvalid exception when overflow is detected.
Bit-wise Functions#
Rounding Functions#
Rounding functions displace numeric inputs to an approximate value with a simpler representation based on the rounding criterion.
Logarithmic Functions#
Logarithmic functions are also supported, and also offer _checkedvariants which detect domain errors.
Trigonometric Functions#
Trigonometric functions are also supported, and also offer _checkedvariants which detect domain errors where appropriate.
Comparisons#
These functions expect two inputs of the same type. If one of the inputs is nullthey return null.
These functions take any number of arguments of a numeric or temporal type.
Logical Functions#
These functions normally emit a null when one of the inputs is null. However, Kleene logic variants are provided (suffixed _kleene). See User Guide for details.
String Predicates#
In these functions an empty string emits false in the output. For ASCII variants (prefixed ascii_) a string element with non-ASCII characters emits false in the output.
The first set of functions emit true if the input contains only characters of a given class.
The second set of functions also consider the order of characters in the string element.
The third set of functions examines string elements on a byte-by-byte basis.