Trait arrow_array::ArrowNativeTypeOp

pub trait ArrowNativeTypeOp: ArrowNativeType {
    const ZERO: Self;
    const ONE: Self;
    const MIN_TOTAL_ORDER: Self;
    const MAX_TOTAL_ORDER: Self;
Show 22 methods
    // Required methods
    fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>;
    fn add_wrapping(self, rhs: Self) -> Self;
    fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>;
    fn sub_wrapping(self, rhs: Self) -> Self;
    fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>;
    fn mul_wrapping(self, rhs: Self) -> Self;
    fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>;
    fn div_wrapping(self, rhs: Self) -> Self;
    fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>;
    fn mod_wrapping(self, rhs: Self) -> Self;
    fn neg_checked(self) -> Result<Self, ArrowError>;
    fn neg_wrapping(self) -> Self;
    fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>;
    fn pow_wrapping(self, exp: u32) -> Self;
    fn is_zero(self) -> bool;
    fn compare(self, rhs: Self) -> Ordering;
    fn is_eq(self, rhs: Self) -> bool;

    // Provided methods
    fn is_ne(self, rhs: Self) -> bool { ... }
    fn is_lt(self, rhs: Self) -> bool { ... }
    fn is_le(self, rhs: Self) -> bool { ... }
    fn is_gt(self, rhs: Self) -> bool { ... }
    fn is_ge(self, rhs: Self) -> bool { ... }
}

Expand description

Trait for ArrowNativeType that adds checked and unchecked arithmetic operations, and totally ordered comparison operations

The APIs with _wrapping suffix do not perform overflow-checking. For integer types they will wrap around the boundary of the type. For floating point types they will overflow to INF or -INF preserving the expected sign value

Note div_wrapping and mod_wrapping will panic for integer types if rhs is zero although this may be subject to change https://github.com/apache/arrow-rs/issues/2647

The APIs with _checked suffix perform overflow-checking. For integer types these will return Err instead of wrapping. For floating point types they will overflow to INF or -INF preserving the expected sign value

Comparison of integer types is as per normal integer comparison rules, floating point values are compared as per IEEE 754’s totalOrder predicate see f32::total_cmp

Required Associated Constants§

const ZERO: Self

The additive identity

const ONE: Self

The multiplicative identity

const MIN_TOTAL_ORDER: Self

The minimum value and identity for the max aggregation. Note that the aggregation uses the total order predicate for floating point values, which means that this value is a negative NaN.

const MAX_TOTAL_ORDER: Self

The maximum value and identity for the min aggregation. Note that the aggregation uses the total order predicate for floating point values, which means that this value is a positive NaN.

Required Methods§

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

Checked addition operation

fn add_wrapping(self, rhs: Self) -> Self

Wrapping addition operation

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

Checked subtraction operation

fn sub_wrapping(self, rhs: Self) -> Self

Wrapping subtraction operation

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

Checked multiplication operation

fn mul_wrapping(self, rhs: Self) -> Self

Wrapping multiplication operation

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

Checked division operation

fn div_wrapping(self, rhs: Self) -> Self

Wrapping division operation

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

Checked remainder operation

fn mod_wrapping(self, rhs: Self) -> Self

Wrapping remainder operation

fn neg_checked(self) -> Result<Self, ArrowError>

Checked negation operation

fn neg_wrapping(self) -> Self

Wrapping negation operation

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

Checked exponentiation operation

fn pow_wrapping(self, exp: u32) -> Self

Wrapping exponentiation operation

fn is_zero(self) -> bool

Returns true if zero else false

fn compare(self, rhs: Self) -> Ordering

Compare operation

fn is_eq(self, rhs: Self) -> bool

Equality operation

Provided Methods§

fn is_ne(self, rhs: Self) -> bool

Not equal operation

fn is_lt(self, rhs: Self) -> bool

Less than operation

fn is_le(self, rhs: Self) -> bool

Less than equals operation

fn is_gt(self, rhs: Self) -> bool

Greater than operation

fn is_ge(self, rhs: Self) -> bool

Greater than equals operation

Object Safety§

This trait is not object safe.

Implementations on Foreign Types§

impl ArrowNativeTypeOp for f32

const ZERO: Self = 0f32

const ONE: Self = 1f32

const MIN_TOTAL_ORDER: Self = NaN_f32

const MAX_TOTAL_ORDER: Self = NaN_f32

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn neg_wrapping(self) -> Self

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

impl ArrowNativeTypeOp for f64

const ZERO: Self = 0f64

const ONE: Self = 1f64

const MIN_TOTAL_ORDER: Self = NaN_f64

const MAX_TOTAL_ORDER: Self = NaN_f64

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn neg_wrapping(self) -> Self

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

impl ArrowNativeTypeOp for i8

const ZERO: Self = 0i8

const ONE: Self = 1i8

const MIN_TOTAL_ORDER: Self = -128i8

const MAX_TOTAL_ORDER: Self = 127i8

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn neg_wrapping(self) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

impl ArrowNativeTypeOp for i16

const ZERO: Self = 0i16

const ONE: Self = 1i16

const MIN_TOTAL_ORDER: Self = -32_768i16

const MAX_TOTAL_ORDER: Self = 32_767i16

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn neg_wrapping(self) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

impl ArrowNativeTypeOp for i32

const ZERO: Self = 0i32

const ONE: Self = 1i32

const MIN_TOTAL_ORDER: Self = -2_147_483_648i32

const MAX_TOTAL_ORDER: Self = 2_147_483_647i32

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn neg_wrapping(self) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

impl ArrowNativeTypeOp for i64

const ZERO: Self = 0i64

const ONE: Self = 1i64

const MIN_TOTAL_ORDER: Self = -9_223_372_036_854_775_808i64

const MAX_TOTAL_ORDER: Self = 9_223_372_036_854_775_807i64

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn neg_wrapping(self) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

impl ArrowNativeTypeOp for i128

const ZERO: Self = 0i128

const ONE: Self = 1i128

const MIN_TOTAL_ORDER: Self = -170_141_183_460_469_231_731_687_303_715_884_105_728i128

const MAX_TOTAL_ORDER: Self = 170_141_183_460_469_231_731_687_303_715_884_105_727i128

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn neg_wrapping(self) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

impl ArrowNativeTypeOp for u8

const ZERO: Self = 0u8

const ONE: Self = 1u8

const MIN_TOTAL_ORDER: Self = 0u8

const MAX_TOTAL_ORDER: Self = 255u8

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn neg_wrapping(self) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

impl ArrowNativeTypeOp for u16

const ZERO: Self = 0u16

const ONE: Self = 1u16

const MIN_TOTAL_ORDER: Self = 0u16

const MAX_TOTAL_ORDER: Self = 65_535u16

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn neg_wrapping(self) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

impl ArrowNativeTypeOp for u32

const ZERO: Self = 0u32

const ONE: Self = 1u32

const MIN_TOTAL_ORDER: Self = 0u32

const MAX_TOTAL_ORDER: Self = 4_294_967_295u32

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn neg_wrapping(self) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

impl ArrowNativeTypeOp for u64

const ZERO: Self = 0u64

const ONE: Self = 1u64

const MIN_TOTAL_ORDER: Self = 0u64

const MAX_TOTAL_ORDER: Self = 18_446_744_073_709_551_615u64

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn neg_wrapping(self) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

impl ArrowNativeTypeOp for i256

const ZERO: Self = i256::ZERO

const ONE: Self = i256::ONE

const MIN_TOTAL_ORDER: Self = i256::MIN

const MAX_TOTAL_ORDER: Self = i256::MAX

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn neg_wrapping(self) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

impl ArrowNativeTypeOp for f16

const ZERO: Self = f16::ZERO

const ONE: Self = f16::ONE

const MIN_TOTAL_ORDER: Self = _

const MAX_TOTAL_ORDER: Self = _

fn add_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn add_wrapping(self, rhs: Self) -> Self

fn sub_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn sub_wrapping(self, rhs: Self) -> Self

fn mul_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mul_wrapping(self, rhs: Self) -> Self

fn div_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn div_wrapping(self, rhs: Self) -> Self

fn mod_checked(self, rhs: Self) -> Result<Self, ArrowError>

fn mod_wrapping(self, rhs: Self) -> Self

fn neg_checked(self) -> Result<Self, ArrowError>

fn neg_wrapping(self) -> Self

fn pow_checked(self, exp: u32) -> Result<Self, ArrowError>

fn pow_wrapping(self, exp: u32) -> Self

fn is_zero(self) -> bool

fn compare(self, rhs: Self) -> Ordering

fn is_eq(self, rhs: Self) -> bool

Implementors§