Struct simba::scalar::FixedI8

#[repr(transparent)]pub struct FixedI8<Fract>(pub FixedI8<Fract>);

Signed fixed-point number with a generic number of bits for the fractional part.

Implementations

impl<Fract: LeEqU8> FixedI8<Fract>

pub fn from_num<N: ToFixed>(val: N) -> Self

Creates a fixed-point number from another number.

impl<Fract> FixedI8<Fract>

pub const fn from_bits(bits: i8) -> Self

Creates a fixed-point number that has a bitwise representation identical to the given integer.

pub const fn to_bits(self) -> i8

Creates an integer that has a bitwise representation identical to the given fixed-point number.

Trait Implementations

impl<Fract: LeEqU8> AbsDiffEq<FixedI8<Fract>> for FixedI8<Fract>

type Epsilon = Self

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

pub fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<Fract: LeEqU8> Add<FixedI8<Fract>> for FixedI8<Fract>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<Fract: LeEqU8> AddAssign<FixedI8<Fract>> for FixedI8<Fract>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<Fract: LeEqU8> Bounded for FixedI8<Fract>

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<Fract: Clone> Clone for FixedI8<Fract>

fn clone(&self) -> FixedI8<Fract>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Fract: Send + Sync + 'static> ComplexField for FixedI8<Fract> where
    Fract: Unsigned + LeEqU8 + IsLessOrEqual<U7, Output = True> + IsLessOrEqual<U6, Output = True> + IsLessOrEqual<U5, Output = True> + IsLessOrEqual<U4, Output = True>, 

type RealField = Self

fn from_real(re: Self::RealField) -> Self

Builds a pure-real complex number from the given value.

fn real(self) -> Self::RealField

The real part of this complex number.

fn imaginary(self) -> Self::RealField

The imaginary part of this complex number.

fn norm1(self) -> Self::RealField

The sum of the absolute value of this complex number’s real and imaginary part.

fn modulus(self) -> Self::RealField

The modulus of this complex number.

fn modulus_squared(self) -> Self::RealField

The squared modulus of this complex number.

fn argument(self) -> Self::RealField

The argument of this complex number.

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

The exponential form of this complex number: (modulus, e^{i arg})

fn recip(self) -> Self

fn conjugate(self) -> Self

fn scale(self, factor: Self::RealField) -> Self

Multiplies this complex number by factor.

fn unscale(self, factor: Self::RealField) -> Self

Divides this complex number by factor.

fn floor(self) -> Self

fn ceil(self) -> Self

fn round(self) -> Self

fn trunc(self) -> Self

fn fract(self) -> Self

fn abs(self) -> Self

The absolute value of this complex number: self / self.signum().

fn signum(self) -> Self

The exponential part of this complex number: self / self.modulus()

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

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

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

fn powc(self, _n: Self) -> Self

fn sqrt(self) -> Self

fn try_sqrt(self) -> Option<Self>

fn exp(self) -> Self

fn exp2(self) -> Self

fn exp_m1(self) -> Self

fn ln_1p(self) -> Self

fn ln(self) -> Self

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

fn log2(self) -> Self

fn log10(self) -> Self

fn cbrt(self) -> Self

fn hypot(self, _other: Self) -> Self::RealField

Computes (self.conjugate() * self + other.conjugate() * other).sqrt()

fn sin(self) -> Self

fn cos(self) -> Self

fn tan(self) -> Self

fn asin(self) -> Self

fn acos(self) -> Self

fn atan(self) -> Self

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

fn sinh(self) -> Self

fn cosh(self) -> Self

fn tanh(self) -> Self

fn asinh(self) -> Self

fn acosh(self) -> Self

fn atanh(self) -> Self

fn is_finite(&self) -> bool

fn to_polar(self) -> (Self::RealField, Self::RealField)

The polar form of this complex number: (modulus, arg)

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

fn sinc(self) -> Self

Cardinal sine

fn sinhc(self) -> Self

fn cosc(self) -> Self

Cardinal cos

fn coshc(self) -> Self

impl<Fract: Copy> Copy for FixedI8<Fract>

impl<Fract: LeEqU8> Debug for FixedI8<Fract>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, Fract: LeEqU8> Deserialize<'de> for FixedI8<Fract>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<Fract: LeEqU8> Display for FixedI8<Fract>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Fract: LeEqU8> Div<FixedI8<Fract>> for FixedI8<Fract>

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<Fract: LeEqU8> Div<i8> for FixedI8<Fract>

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<Fract: LeEqU8> DivAssign<FixedI8<Fract>> for FixedI8<Fract>

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<Fract: LeEqU8> DivAssign<i8> for FixedI8<Fract>

fn div_assign(&mut self, rhs: i8)

Performs the /= operation.

impl<Fract: LeEqU8> Eq for FixedI8<Fract>

impl<Fract: LeEqU8> Field for FixedI8<Fract>

impl<Fract: LeEqU8> FromPrimitive for FixedI8<Fract>

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl<Fract: LeEqU8> Hash for FixedI8<Fract>

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<Fract: LeEqU8> Mul<FixedI8<Fract>> for FixedI8<Fract>

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<Fract: LeEqU8> Mul<i8> for FixedI8<Fract>

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<Fract: LeEqU8> MulAssign<FixedI8<Fract>> for FixedI8<Fract>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<Fract: LeEqU8> MulAssign<i8> for FixedI8<Fract>

fn mul_assign(&mut self, rhs: i8)

Performs the *= operation.

impl<Fract: LeEqU8> Neg for FixedI8<Fract>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<Fract: LeEqU8> Num for FixedI8<Fract>

type FromStrRadixErr = ()

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

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

impl<Fract: LeEqU8> One for FixedI8<Fract>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

pub fn set_one(&mut self)

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

pub fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl<Fract: LeEqU8> Ord for FixedI8<Fract>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<Fract: LeEqU8> PartialEq<FixedI8<Fract>> for FixedI8<Fract>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<Fract: LeEqU8> PartialOrd<FixedI8<Fract>> for FixedI8<Fract>

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

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<Fract: LeEqU8> PrimitiveSimdValue for FixedI8<Fract>

impl<Fract: Send + Sync + 'static> RealField for FixedI8<Fract> where
    Fract: Unsigned + LeEqU8 + IsLessOrEqual<U7, Output = True> + IsLessOrEqual<U6, Output = True> + IsLessOrEqual<U5, Output = True> + IsLessOrEqual<U4, Output = True>, 

fn is_sign_positive(self) -> bool

Is the sign of this real number positive?

fn is_sign_negative(self) -> bool

Is the sign of this real number negative?

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

Copies the sign of self to to.

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

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

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

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

fn pi() -> Self

Archimedes’ constant.

fn two_pi() -> Self

2.0 * pi.

fn frac_pi_2() -> Self

pi / 2.0.

fn frac_pi_3() -> Self

pi / 3.0.

fn frac_pi_4() -> Self

pi / 4.0.

fn frac_pi_6() -> Self

pi / 6.0.

fn frac_pi_8() -> Self

pi / 8.0.

fn frac_1_pi() -> Self

1.0 / pi.

fn frac_2_pi() -> Self

2.0 / pi.

fn frac_2_sqrt_pi() -> Self

2.0 / sqrt(pi).

fn e() -> Self

Euler’s number.

fn log2_e() -> Self

log2(e).

fn log10_e() -> Self

log10(e).

fn ln_2() -> Self

ln(2.0).

fn ln_10() -> Self

ln(10.0).

impl<Fract: LeEqU8> RelativeEq<FixedI8<Fract>> for FixedI8<Fract>

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

A test for equality that uses a relative comparison if the values are far apart.

pub fn relative_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of RelativeEq::relative_eq.

impl<Fract: LeEqU8> Rem<FixedI8<Fract>> for FixedI8<Fract>

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl<Fract: LeEqU8> Rem<i8> for FixedI8<Fract>

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl<Fract: LeEqU8> RemAssign<FixedI8<Fract>> for FixedI8<Fract>

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl<Fract: LeEqU8> RemAssign<i8> for FixedI8<Fract>

fn rem_assign(&mut self, rhs: i8)

Performs the %= operation.

impl<Fract: LeEqU8> Serialize for FixedI8<Fract>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<Fract: LeEqU8> Signed for FixedI8<Fract>

fn abs(&self) -> Self

Computes the absolute value.

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

The positive difference of two numbers.

fn signum(&self) -> Self

Returns the sign of the number.

fn is_positive(&self) -> bool

Returns true if the number is positive and false if the number is zero or negative.

fn is_negative(&self) -> bool

Returns true if the number is negative and false if the number is zero or positive.

impl<Fract: LeEqU8> SimdValue for FixedI8<Fract>

type Element = Self

The type of the elements of each lane of this SIMD value.

type SimdBool = bool

Type of the result of comparing two SIMD values like self.

fn lanes() -> usize

The number of lanes of this SIMD value.

fn splat(val: Self::Element) -> Self

Initializes an SIMD value with each lanes set to val.

fn extract(&self, _: usize) -> Self::Element

Extracts the i-th lane of self.

unsafe fn extract_unchecked(&self, _: usize) -> Self::Element

Extracts the i-th lane of self without bound-checking.

fn replace(&mut self, _: usize, val: Self::Element)

Replaces the i-th lane of self by val.

unsafe fn replace_unchecked(&mut self, _: usize, val: Self::Element)

Replaces the i-th lane of self by val without bound-checking.

fn select(self, cond: Self::SimdBool, other: Self) -> Self

Merges self and other depending on the lanes of cond.

fn map_lanes(self, f: impl Fn(Self::Element) -> Self::Element) -> Self where
    Self: Clone, 

Applies a function to each lane of self.

fn zip_map_lanes(
    self,
    b: Self,
    f: impl Fn(Self::Element, Self::Element) -> Self::Element
) -> Self where
    Self: Clone, 

Applies a function to each lane of self paired with the corresponding lane of b.

impl<Fract: LeEqU8> Sub<FixedI8<Fract>> for FixedI8<Fract>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<Fract: LeEqU8> SubAssign<FixedI8<Fract>> for FixedI8<Fract>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<Fract: LeEqU8> SubsetOf<FixedI8<Fract>> for f64

fn to_superset(&self) -> FixedI8<Fract>

The inclusion map: converts self to the equivalent element of its superset.

fn from_superset(element: &FixedI8<Fract>) -> Option<Self>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset.

fn from_superset_unchecked(element: &FixedI8<Fract>) -> Self

Use with care! Same as self.to_superset but without any property checks. Always succeeds.

fn is_in_subset(_: &FixedI8<Fract>) -> bool

Checks if element is actually part of the subset Self (and can be converted to it).

impl<Fract: LeEqU8> SubsetOf<FixedI8<Fract>> for FixedI8<Fract>

fn to_superset(&self) -> FixedI8<Fract>

The inclusion map: converts self to the equivalent element of its superset.

fn from_superset(element: &FixedI8<Fract>) -> Option<Self>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset.

fn from_superset_unchecked(element: &FixedI8<Fract>) -> Self

Use with care! Same as self.to_superset but without any property checks. Always succeeds.

fn is_in_subset(_: &FixedI8<Fract>) -> bool

Checks if element is actually part of the subset Self (and can be converted to it).

impl<Fract: LeEqU8> UlpsEq<FixedI8<Fract>> for FixedI8<Fract>

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

pub fn ulps_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_ulps: u32
) -> bool

The inverse of UlpsEq::ulps_eq.

impl<Fract: LeEqU8> Zero for FixedI8<Fract>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

pub fn set_zero(&mut self)

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