Module arrow::compute::kernels::arithmetic

Defines basic arithmetic kernels for PrimitiveArrays.

These kernels can leverage SIMD if available on your system. Currently no runtime detection is provided, you should enable the specific SIMD intrinsics using RUSTFLAGS="-C target-feature=+avx2" for example. See the documentation here for more information.

Functions

add

Perform left + right operation on two arrays. If either left or right value is null then the result is also null.

add_dyn

Perform left + right operation on two arrays. If either left or right value is null then the result is also null.

add_scalar

Add every value in an array by a scalar. If any value in the array is null then the result is also null.

add_scalar_dyn

Add every value in an array by a scalar. If any value in the array is null then the result is also null. The given array must be a PrimitiveArray of the type same as the scalar, or a DictionaryArray of the value type same as the scalar.

divide

Perform left / right operation on two arrays. If either left or right value is null then the result is also null. If any right hand value is zero then the result of this operation will be Err(ArrowError::DivideByZero).

divide_dyn

Perform left / right operation on two arrays. If either left or right value is null then the result is also null. If any right hand value is zero then the result of this operation will be Err(ArrowError::DivideByZero).

divide_scalar

Divide every value in an array by a scalar. If any value in the array is null then the result is also null. If the scalar is zero then the result of this operation will be Err(ArrowError::DivideByZero).

divide_scalar_dyn

Divide every value in an array by a scalar. If any value in the array is null then the result is also null. If the scalar is zero then the result of this operation will be Err(ArrowError::DivideByZero). The given array must be a PrimitiveArray of the type same as the scalar, or a DictionaryArray of the value type same as the scalar.

divide_unchecked

Perform left / right operation on two arrays without checking for division by zero. The result of dividing by zero follows normal floating point rules. If either left or right value is null then the result is also null. If any right hand value is zero then the result of this

math_op

Helper function to perform math lambda function on values from two arrays. If either left or right value is null then the output value is also null, so 1 + null is null.

modulus

Perform left % right operation on two arrays. If either left or right value is null then the result is also null. If any right hand value is zero then the result of this operation will be Err(ArrowError::DivideByZero).

modulus_scalar

Modulus every value in an array by a scalar. If any value in the array is null then the result is also null. If the scalar is zero then the result of this operation will be Err(ArrowError::DivideByZero).

multiply

Perform left * right operation on two arrays. If either left or right value is null then the result is also null.

multiply_dyn

Perform left * right operation on two arrays. If either left or right value is null then the result is also null.

multiply_scalar

Multiply every value in an array by a scalar. If any value in the array is null then the result is also null.

multiply_scalar_dyn

Multiply every value in an array by a scalar. If any value in the array is null then the result is also null. The given array must be a PrimitiveArray of the type same as the scalar, or a DictionaryArray of the value type same as the scalar.

negate

Perform - operation on an array. If value is null then the result is also null.

powf_scalar

Raise array with floating point values to the power of a scalar.

subtract

Perform left - right operation on two arrays. If either left or right value is null then the result is also null.

subtract_dyn

Perform left - right operation on two arrays. If either left or right value is null then the result is also null.

subtract_scalar

Subtract every value in an array by a scalar. If any value in the array is null then the result is also null.

subtract_scalar_dyn

Subtract every value in an array by a scalar. If any value in the array is null then the result is also null. The given array must be a PrimitiveArray of the type same as the scalar, or a DictionaryArray of the value type same as the scalar.