Available on crate feature
compute_arithmetics only.Expand description
Defines basic arithmetic kernels for PrimitiveArrays.
The Arithmetics module is composed by basic arithmetics operations that can
be performed on PrimitiveArray.
Whenever possible, each operation declares variations of the basic operation that offers different guarantees:
- plain: panics on overflowing and underflowing.
- checked: turns an overflowing to a null.
- saturating: turns the overflowing to the MAX or MIN value respectively.
- overflowing: returns an extra
Bitmapdenoting whether the operation overflowed. - adaptive: for
Decimalonly, adjusts the precision and scale to make the resulting value fit.
Modules§
- basic
- Contains arithemtic functions for
PrimitiveArrays. - decimal
compute_arithmetics_decimal - Defines the arithmetic kernels for Decimal
PrimitiveArrays. TheDecimaltype specifies the precision and scale parameters. These affect the arithmetic operations and need to be considered while doing operations with Decimal numbers. - time
- Defines the arithmetic kernels for adding a Duration to a Timestamp, Time32, Time64, Date32 and Date64.
Traits§
- Array
Add - Defines basic addition operation for primitive arrays
- Array
Checked Add - Defines checked addition operation for primitive arrays
- Array
Checked Div - Defines checked division operation for primitive arrays
- Array
Checked Mul - Defines checked multiplication operation for primitive arrays
- Array
Checked Rem - Defines checked reminder operation for primitive arrays
- Array
Checked Sub - Defines checked subtraction operation for primitive arrays
- Array
Div - Defines basic division operation for primitive arrays
- Array
Mul - Defines basic multiplication operation for primitive arrays
- Array
Overflowing Add - Defines Overflowing addition operation for primitive arrays
- Array
Overflowing Mul - Defines Overflowing multiplication operation for primitive arrays
- Array
Overflowing Sub - Defines Overflowing subtraction operation for primitive arrays
- Array
Rem - Defines basic reminder operation for primitive arrays
- Array
Saturating Add - Defines saturating addition operation for primitive arrays
- Array
Saturating Mul - Defines saturating multiplication operation for primitive arrays
- Array
Saturating Sub - Defines saturating subtraction operation for primitive arrays
- Array
Sub - Defines basic subtraction operation for primitive arrays
- Array
Wrapping Add - Defines wrapping addition operation for primitive arrays
- Array
Wrapping Mul - Defines wrapping multiplication operation for primitive arrays
- Array
Wrapping Sub - Defines wrapping subtraction operation for primitive arrays
Functions§
- add
- Adds two
Arrays. - add_
scalar - Adds an
Arrayand aScalar. - can_add
- Returns whether two
DataTypes can be added byadd. - can_div
- Returns whether two
DataTypes can be divided bydiv. - can_mul
- Returns whether two
DataTypes can be multiplied bymul. - can_neg
- Whether
negis supported for a givenDataType - can_rem
- Returns whether two
DataTypes “can be remainder” byrem. - can_sub
- Returns whether two
DataTypes can be subtracted bysub. - div
- Divide of two
Arrays. - div_
scalar - Divide an
Arraywith aScalar. - mul
- Multiply two
Arrays. - mul_
scalar - Multiply an
Arraywith aScalar. - neg
- Negates an
Array. - rem
- Remainder of two
Arrays. - sub
- Subtracts two
Arrays. - sub_
scalar - Adds an
Arrayand aScalar.