Trait SimdScalar

Source

pub trait SimdScalar:
    Sealed
    + Copy
    + Default
    + Send
    + Sync
    + 'static
    + PartialOrd
    + PartialEq
    + Debug
    + Add<Output = Self>
    + AddAssign
    + Sub<Output = Self>
    + SubAssign
    + Mul<Output = Self>
    + MulAssign
    + Div<Output = Self>
    + CastFrom<i32> {
    const ZERO: Self;
    const ONE: Self;
    const NAN: Self;
    const INFINITY: Self;
    const BYTE_WIDTH: usize;
    const ALL_ONES: Self;
    const SIGN_MASK: Self;
    const MIN_VALUE: Self;
    const MAX_VALUE: Self;
Show 16 methods
    // Required methods
    fn abs(self) -> Self;
    fn scalar_fmadd(self, b: Self, c: Self) -> Self;
    fn sqrt(self) -> Self;
    fn is_finite(self) -> bool;
    fn is_nan(self) -> bool;
    fn to_f64(self) -> f64;
    fn bitand(self, rhs: Self) -> Self;
    fn bitor(self, rhs: Self) -> Self;
    fn bitxor(self, rhs: Self) -> Self;
    fn count_ones(self) -> u32;

    // Provided methods
    fn min_scalar(self, other: Self) -> Self
       where Self: PartialOrd { ... }
    fn max_scalar(self, other: Self) -> Self
       where Self: PartialOrd { ... }
    fn saturating_add(self, rhs: Self) -> Self { ... }
    fn saturating_mul(self, rhs: Self) -> Self { ... }
    fn checked_add(self, rhs: Self) -> Option<Self> { ... }
    fn checked_mul(self, rhs: Self) -> Option<Self> { ... }
}

Expand description

Core numeric element trait. The main extension point for monomorphized operations across all precisions.

§Source constructors

from_f64 lives on FloatElement (precision-correct for F16 and Bf16). Integer callers use the literal v as Self truncating cast natively. There is no generic from_usize on NumericElement for the same reason — the per-type route is selected explicitly so callers express precision-correct construction (literal cast for ints, FloatElement::from_f64(v as f64) round-trip for floats).

Required Associated Constants§

Source

const ZERO: Self

Additive identity.

Source

const ONE: Self

Multiplicative identity.

Source

const NAN: Self

IEEE 754 not-a-number sentinel.

Source

const INFINITY: Self

IEEE 754 positive infinity.

Source

const BYTE_WIDTH: usize

Number of bytes per element.

Source

const ALL_ONES: Self

Bitwise representation with all bits set to 1.

Source

const SIGN_MASK: Self

IEEE 754 sign-bit mask: only the most-significant bit is set.

XOR-ing any value with this mask negates it (flips the sign bit). Used by the default SimdKernel::neg implementation (hermes-simd-core) to avoid subtraction, which is not universally available across SIMD backends.

Source

const MIN_VALUE: Self

The minimum representable finite value (negative infinity or i32::MIN).

Used as the identity element for Max reductions.

Source

const MAX_VALUE: Self

The maximum representable finite value (positive infinity or i32::MAX).

Used as the identity element for Min reductions.

Required Methods§

Source

fn abs(self) -> Self

Absolute value.

Source

fn scalar_fmadd(self, b: Self, c: Self) -> Self

Scalar fused multiply-add: (self * b) + c.

Source

fn sqrt(self) -> Self

Square root. Floats follow IEEE 754 (NaN for negative inputs); integers return the exact floor integer square root (isqrt), with negative signed inputs defined to return 0 (integers have no NaN to signal the domain error). No f64 round-trip, so the integer result is exact for all operands.

Source

fn is_finite(self) -> bool

Returns true if finite.

Source

fn is_nan(self) -> bool

Returns true if NaN.

Source

fn to_f64(self) -> f64

Cast to f64.

Source

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

Bitwise AND.

Source

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

Bitwise OR.

Source

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

Bitwise XOR.

Source

fn count_ones(self) -> u32

Count set bits (population count).

Provided Methods§

Source

fn min_scalar(self, other: Self) -> Self
where Self: PartialOrd,

Elementwise minimum: returns self if self <= other, else other.

Default: uses PartialOrd comparison. Concrete impls (e.g. f32, f64) may override with a hardware intrinsic.

Source

fn max_scalar(self, other: Self) -> Self
where Self: PartialOrd,

Elementwise maximum: returns self if self >= other, else other.

Default: uses PartialOrd comparison. Concrete impls (e.g. f32, f64) may override with a hardware intrinsic.

Source

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

Saturating addition.

For floats this is identical to + (IEEE 754 already saturates at ±∞). Integer implementations must override this with the native saturating_add; the default self + rhs would silently wrap in release / panic in debug on integer overflow — which is the bug ATLAS-EUNOMIA-044 closed. Every primitive integer and integer-wrapper impl in this crate already overrides; treat that as a hard rule when adding a new NumericElement impl for an integer type.

Source

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

Saturating multiplication.

For floats this is identical to * (IEEE 754 already saturates at ±∞). Integer implementations must override this with the native saturating_mul; see Self::saturating_add for the rationale and the ATLAS-EUNOMIA-044 history.

Source

fn checked_add(self, rhs: Self) -> Option<Self>

Checked addition: returns Some(self + rhs) or None on integer overflow.

Float types always return Some since their arithmetic never overflows to undefined behaviour (they produce ±∞ or NaN instead). Integer implementations must override this with the native checked_add; the default Some(self + rhs) would silently wrap in release / panic in debug on integer overflow. Every primitive integer and integer-wrapper impl in this crate already overrides; treat that as a hard rule when adding a new NumericElement impl for an integer type.

Source

fn checked_mul(self, rhs: Self) -> Option<Self>

Checked multiplication: returns Some(self * rhs) or None on integer overflow.

Float types always return Some (see NumericElement::checked_add). Integer implementations must override with the native checked_mul; see NumericElement::checked_add for the rationale.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Trait SimdScalar Copy item path

§Source constructors

Required Associated Constants§

const ZERO: Self

const ONE: Self

const NAN: Self

const INFINITY: Self

const BYTE_WIDTH: usize

const ALL_ONES: Self

const SIGN_MASK: Self

const MIN_VALUE: Self

const MAX_VALUE: Self

Required Methods§

fn abs(self) -> Self

fn scalar_fmadd(self, b: Self, c: Self) -> Self

fn sqrt(self) -> Self

fn is_finite(self) -> bool

fn is_nan(self) -> bool

fn to_f64(self) -> f64

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

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

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

fn count_ones(self) -> u32

Provided Methods§

fn min_scalar(self, other: Self) -> Selfwhere Self: PartialOrd,

fn max_scalar(self, other: Self) -> Selfwhere Self: PartialOrd,

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

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

fn checked_add(self, rhs: Self) -> Option<Self>

fn checked_mul(self, rhs: Self) -> Option<Self>

Dyn Compatibility§

Implementations on Foreign Types§

impl NumericElement for f32

fn min_scalar(self, other: f32) -> f32

fn max_scalar(self, other: f32) -> f32

const ZERO: f32 = 0.0_f32

const ONE: f32 = 1.0_f32

const NAN: f32 = f32::NAN

const INFINITY: f32 = f32::INFINITY

const BYTE_WIDTH: usize = 4

const ALL_ONES: f32

const SIGN_MASK: f32

const MIN_VALUE: f32 = f32::NEG_INFINITY

const MAX_VALUE: f32 = f32::INFINITY

fn abs(self) -> f32

fn scalar_fmadd(self, b: f32, c: f32) -> f32

fn sqrt(self) -> f32

fn is_finite(self) -> bool

fn is_nan(self) -> bool

fn to_f64(self) -> f64

fn bitand(self, rhs: f32) -> f32

fn bitor(self, rhs: f32) -> f32

fn bitxor(self, rhs: f32) -> f32

fn count_ones(self) -> u32

impl NumericElement for f64

fn min_scalar(self, other: f64) -> f64

fn max_scalar(self, other: f64) -> f64

const ZERO: f64 = 0.0_f64

const ONE: f64 = 1.0_f64

const NAN: f64 = f64::NAN

const INFINITY: f64 = f64::INFINITY

const BYTE_WIDTH: usize = 8

const ALL_ONES: f64

const SIGN_MASK: f64

const MIN_VALUE: f64 = f64::NEG_INFINITY

const MAX_VALUE: f64 = f64::INFINITY

fn abs(self) -> f64

fn scalar_fmadd(self, b: f64, c: f64) -> f64

fn sqrt(self) -> f64

fn is_finite(self) -> bool

fn is_nan(self) -> bool

fn to_f64(self) -> f64

fn bitand(self, rhs: f64) -> f64

fn bitor(self, rhs: f64) -> f64

fn bitxor(self, rhs: f64) -> f64

fn count_ones(self) -> u32

impl NumericElement for i8

const ZERO: i8 = 0

const ONE: i8 = 1

const NAN: i8 = 0

Trait SimdScalar

fn min_scalar(self, other: Self) -> Self
where Self: PartialOrd,

fn max_scalar(self, other: Self) -> Self
where Self: PartialOrd,