Struct NumVector 

#[repr(transparent)]
pub struct NumVector<V: GenericVector>(pub V);

Wraps a generic vector to provide implementations of num_traits traits.

num_traits is a widely used crate that provides numeric traits for Rust types. However, unless you want to use these, implementing them on all vector types would cause conflicts with more inherent methods provided by this library.

Therefore, this wrapper type allows you to opt-in to using num_traits when needed, without causing conflicts in the main vector types.

Notably, the implementation of MulAdd uses mul_adde under the hood, which may fall back to separate multiply and add operations if a fused multiply-add is not available for the target architecture.

Tuple Fields

0: V

Trait Implementations

impl<V: NumericVector> Add for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<V: NumericVector> AddAssign for NumVector<V>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<V: BitwiseVector> BitAnd for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<V: BitwiseVector> BitAndAssign for NumVector<V>

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<V: BitwiseVector> BitOr for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<V: BitwiseVector> BitOrAssign for NumVector<V>

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<V: BitwiseVector> BitXor for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<V: BitwiseVector> BitXorAssign for NumVector<V>

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<V: NumericVector> Bounded for NumVector<V>

fn min_value() -> Self

Returns the smallest finite number this type can represent

fn max_value() -> Self

Returns the largest finite number this type can represent

impl<V: GenericVector> Clone for NumVector<V>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<V: NumericVector> ConstOne for NumVector<V>

const ONE: Self

The multiplicative identity element of Self, 1.

impl<V: NumericVector> ConstZero for NumVector<V>

const ZERO: Self

The additive identity element of Self, 0.

impl<V: GenericVector> Copy for NumVector<V>

impl<V: GenericVector> Deref for NumVector<V>

type Target = V

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<V: NumericVector> Div for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<V: NumericVector> DivAssign for NumVector<V>

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<V> Float for NumVector<V>

where V::Element: Float + FloatCore, V: RealMath + FloatVector,

Available on crate feature std only.

fn classify(self) -> FpCategory

Follows the logic of most important classification in the order: NaN (any) > Infinite (any) > Zero (all) > Subnormal (any) > Normal

fn is_sign_negative(self) -> bool

Returns true if any lane is negative, false otherwise.

fn is_sign_positive(self) -> bool

Returns true if all lanes are positive, false otherwise.

fn is_subnormal(self) -> bool

Returns true if the number is subnormal.

fn to_degrees(self) -> Self

Converts radians to degrees.

fn to_radians(self) -> Self

Converts degrees to radians.

fn clamp(self, min: Self, max: Self) -> Self

Clamps a value between a min and max.

fn copysign(self, sign: Self) -> Self

Returns a number composed of the magnitude of self and the sign of sign.

fn infinity() -> Self

Returns the infinite value.

fn neg_infinity() -> Self

Returns the negative infinite value.

fn nan() -> Self

Returns the NaN value.

fn neg_zero() -> Self

Returns -0.0.

fn min_value() -> Self

Returns the smallest finite value that this type can represent.

fn min_positive_value() -> Self

Returns the smallest positive, normalized value that this type can represent.

fn epsilon() -> Self

Returns epsilon, a small positive value.

fn max_value() -> Self

Returns the largest finite value that this type can represent.

fn is_nan(self) -> bool

Returns true if this value is NaN and false otherwise.

fn is_infinite(self) -> bool

Returns true if this value is positive infinity or negative infinity and false otherwise.

fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, subnormal, or NaN.

fn floor(self) -> Self

Returns the largest integer less than or equal to a number.

fn ceil(self) -> Self

Returns the smallest integer greater than or equal to a number.

fn round(self) -> Self

Returns the nearest integer to a number. Round half-way cases away from 0.0.

fn trunc(self) -> Self

Return the integer part of a number.

fn fract(self) -> Self

Returns the fractional part of a number.

fn abs(self) -> Self

Computes the absolute value of self. Returns Float::nan() if the number is Float::nan().

fn signum(self) -> Self

Returns a number that represents the sign of self.

fn mul_add(self, a: Self, b: Self) -> Self

Fused multiply-add. Computes (self * a) + b with only one rounding error, yielding a more accurate result than an unfused multiply-add.

fn recip(self) -> Self

Take the reciprocal (inverse) of a number, 1/x.

fn powi(self, n: i32) -> Self

Raise a number to an integer power.

fn powf(self, n: Self) -> Self

Raise a number to a floating point power.

fn sqrt(self) -> Self

Take the square root of a number.

fn exp(self) -> Self

Returns e^(self), (the exponential function).

fn exp2(self) -> Self

Returns 2^(self).

fn ln(self) -> Self

Returns the natural logarithm of the number.

fn log(self, base: Self) -> Self

Returns the logarithm of the number with respect to an arbitrary base.

fn log2(self) -> Self

Returns the base 2 logarithm of the number.

fn log10(self) -> Self

Returns the base 10 logarithm of the number.

fn max(self, other: Self) -> Self

Returns the maximum of the two numbers.

fn min(self, other: Self) -> Self

Returns the minimum of the two numbers.

fn abs_sub(self, other: Self) -> Self

The positive difference of two numbers.

fn sin_cos(self) -> (Self, Self)

Simultaneously computes the sine and cosine of the number, x. Returns (sin(x), cos(x)).

fn cbrt(self) -> Self

Take the cubic root of a number.

fn hypot(self, other: Self) -> Self

Calculate the length of the hypotenuse of a right-angle triangle given legs of length x and y.

fn sin(self) -> Self

Computes the sine of a number (in radians).

fn cos(self) -> Self

Computes the cosine of a number (in radians).

fn tan(self) -> Self

Computes the tangent of a number (in radians).

fn asin(self) -> Self

Computes the arcsine of a number. Return value is in radians in the range [-pi/2, pi/2] or NaN if the number is outside the range [-1, 1].

fn acos(self) -> Self

Computes the arccosine of a number. Return value is in radians in the range [0, pi] or NaN if the number is outside the range [-1, 1].

fn atan(self) -> Self

Computes the arctangent of a number. Return value is in radians in the range [-pi/2, pi/2];

fn atan2(self, other: Self) -> Self

Computes the four quadrant arctangent of self (y) and other (x).

fn exp_m1(self) -> Self

Returns e^(self) - 1 in a way that is accurate even if the number is close to zero.

fn ln_1p(self) -> Self

Returns ln(1+n) (natural logarithm) more accurately than if the operations were performed separately.

fn sinh(self) -> Self

Hyperbolic sine function.

fn cosh(self) -> Self

Hyperbolic cosine function.

fn tanh(self) -> Self

Hyperbolic tangent function.

fn asinh(self) -> Self

Inverse hyperbolic sine function.

fn acosh(self) -> Self

Inverse hyperbolic cosine function.

fn atanh(self) -> Self

Inverse hyperbolic tangent function.

fn integer_decode(self) -> (u64, i16, i8)

Returns the mantissa, base 2 exponent, and sign as integers, respectively. The original number can be recovered by sign * mantissa * 2 ^ exponent.

impl<V: FloatVector> FloatCore for NumVector<V>

where V::Element: FloatCore,

fn classify(self) -> FpCategory

Follows the logic of most important classification in the order: NaN (any) > Infinite (any) > Zero (all) > Subnormal (any) > Normal

fn is_sign_negative(self) -> bool

Returns true if any lane is negative, false otherwise.

fn is_sign_positive(self) -> bool

Returns true if all lanes are positive, false otherwise.

fn recip(self) -> Self

Returns the reciprocal (1/x) of each lane. If you want to use an approximate reciprocal, check the RealMath trait for that.

fn infinity() -> Self

Returns positive infinity.

fn neg_infinity() -> Self

Returns negative infinity.

fn nan() -> Self

Returns NaN.

fn neg_zero() -> Self

Returns -0.0.

fn min_value() -> Self

Returns the smallest finite value that this type can represent.

fn min_positive_value() -> Self

Returns the smallest positive, normalized value that this type can represent.

fn epsilon() -> Self

Returns epsilon, a small positive value.

fn max_value() -> Self

Returns the largest finite value that this type can represent.

fn to_degrees(self) -> Self

Converts to degrees, assuming the number is in radians.

fn to_radians(self) -> Self

Converts to radians, assuming the number is in degrees.

fn integer_decode(self) -> (u64, i16, i8)

Returns the mantissa, base 2 exponent, and sign as integers, respectively. The original number can be recovered by sign * mantissa * 2 ^ exponent.

fn is_nan(self) -> bool

Returns true if the number is NaN.

fn is_finite(self) -> bool

Returns true if the number is neither infinite or NaN.

fn is_infinite(self) -> bool

Returns true if the number is infinite.

fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, subnormal or NaN.

fn is_subnormal(self) -> bool

Returns true if the number is subnormal.

fn floor(self) -> Self

Returns the largest integer less than or equal to a number.

fn ceil(self) -> Self

Returns the smallest integer greater than or equal to a number.

fn round(self) -> Self

Returns the nearest integer to a number. Round half-way cases away from 0.0.

fn trunc(self) -> Self

Return the integer part of a number.

fn fract(self) -> Self

Returns the fractional part of a number.

fn abs(self) -> Self

Computes the absolute value of self. Returns FloatCore::nan() if the number is FloatCore::nan().

fn signum(self) -> Self

Returns a number that represents the sign of self.

fn min(self, other: Self) -> Self

Returns the minimum of the two numbers.

fn max(self, other: Self) -> Self

Returns the maximum of the two numbers.

fn clamp(self, min: Self, max: Self) -> Self

A value bounded by a minimum and a maximum

fn powi(self, exp: i32) -> Self

Raise a number to an integer power.

impl<V> GenericSelectable for NumVector<V>

where V: GenericSelectable + GenericVector,

type SelectableMask = <V as GenericSelectable>::SelectableMask

The mask type whose lane count and layout match Self.

fn select<M>(mask: M, t: Self, f: Self) -> Self

where Self::SelectableMask: CastMask<M>,

For each lane, take the value from t where mask is true, otherwise from f.

impl<V: NumericVector> Mul for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<V: FloatVector> MulAdd for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the fused multiply-add.

fn mul_add(self, a: Self, b: Self) -> Self::Output

Performs the fused multiply-add operation (self * a) + b

impl<V: FloatVector> MulAddAssign for NumVector<V>

fn mul_add_assign(&mut self, a: Self, b: Self)

Performs the fused multiply-add assignment operation *self = (*self * a) + b

impl<V: NumericVector> MulAssign for NumVector<V>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<V: SignedVector> Neg for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<V: NumericVector> Num for NumVector<V>

where V::Element: Num,

type FromStrRadixErr = <<V as GenericVector>::Element as Num>::FromStrRadixErr

fn from_str_radix(str: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl<V: NumericVector> NumCast for NumVector<V>

where V::Element: NumCast,

fn from<T: ToPrimitive>(n: T) -> Option<Self>

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait. If the source value cannot be represented by the target type, then None is returned.

impl<V: NumericVector> One for NumVector<V>

fn is_one(&self) -> bool

Returns true if all lanes are one, false otherwise.

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

impl<V: PartialOrdVector> PartialEq for NumVector<V>

fn eq(&self, other: &Self) -> bool

Returns true if all lanes are equal, false otherwise.

fn ne(&self, other: &Self) -> bool

Returns true if any lane is not equal, false otherwise.

impl<V: PartialOrdVector> PartialOrd for NumVector<V>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

Partial comparison between two vectors, returning None if the vectors are not fully ordered. Only returns Some(Ordering) if all lanes are less than, greater than, or equal.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<V: NumericVector> Rem for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl<V: NumericVector> RemAssign for NumVector<V>

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl<V: BitshiftVector> Shl<NumVector<<V as GenericVector>::Unsigned>> for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the << operator.

fn shl(self, rhs: NumVector<V::Unsigned>) -> Self::Output

Performs the << operation.

impl<V: BitshiftVector> Shl<u32> for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the << operator.

fn shl(self, rhs: u32) -> Self::Output

Performs the << operation.

impl<V: BitshiftVector> ShlAssign<NumVector<<V as GenericVector>::Unsigned>> for NumVector<V>

fn shl_assign(&mut self, rhs: NumVector<V::Unsigned>)

Performs the <<= operation.

impl<V: BitshiftVector> ShlAssign<u32> for NumVector<V>

fn shl_assign(&mut self, rhs: u32)

Performs the <<= operation.

impl<V: BitshiftVector> Shr<NumVector<<V as GenericVector>::Unsigned>> for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the >> operator.

fn shr(self, rhs: NumVector<V::Unsigned>) -> Self::Output

Performs the >> operation.

impl<V: BitshiftVector> Shr<u32> for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> Self::Output

Performs the >> operation.

impl<V: BitshiftVector> ShrAssign<NumVector<<V as GenericVector>::Unsigned>> for NumVector<V>

fn shr_assign(&mut self, rhs: NumVector<V::Unsigned>)

Performs the >>= operation.

impl<V: BitshiftVector> ShrAssign<u32> for NumVector<V>

fn shr_assign(&mut self, rhs: u32)

Performs the >>= operation.

impl<V: NumericVector> Sub for NumVector<V>

type Output = NumVector<V>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<V: NumericVector> SubAssign for NumVector<V>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<V: GenericVector> ToPrimitive for NumVector<V>

where V::Element: ToPrimitive,

Implements conversion from NumVector<V> to primitive types by extracting the first lane and converting that. Other lanes are ignored.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

impl<V: NumericVector> Zero for NumVector<V>

fn is_zero(&self) -> bool

Returns true if all lanes are zero, false otherwise.

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.