Available on crate feature
compute_arithmetics
only.Expand description
Defines basic arithmetic kernels for PrimitiveArray
s.
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
Bitmap
denoting whether the operation overflowed. - adaptive: for
Decimal
only, adjusts the precision and scale to make the resulting value fit.
Modules§
- basic
- Contains arithemtic functions for
PrimitiveArray
s. - decimal
- Defines the arithmetic kernels for Decimal
PrimitiveArrays
. TheDecimal
type 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
Array
s. - add_
scalar - Adds an
Array
and aScalar
. - can_add
- Returns whether two
DataType
s can be added byadd
. - can_div
- Returns whether two
DataType
s can be divided bydiv
. - can_mul
- Returns whether two
DataType
s can be multiplied bymul
. - can_neg
- Whether
neg
is supported for a givenDataType
- can_rem
- Returns whether two
DataType
s “can be remainder” byrem
. - can_sub
- Returns whether two
DataType
s can be subtracted bysub
. - div
- Divide of two
Array
s. - div_
scalar - Divide an
Array
with aScalar
. - mul
- Multiply two
Array
s. - mul_
scalar - Multiply an
Array
with aScalar
. - neg
- Negates an
Array
. - rem
- Remainder of two
Array
s. - sub
- Subtracts two
Array
s. - sub_
scalar - Adds an
Array
and aScalar
.