Struct Portable 

#[repr(transparent)]
pub struct Portable(pub f64);

A transparent binary64 value used for portable nalgebra operations.

Tuple Fields

0: f64

Implementations

impl Portable

pub const fn new(value: f64) -> Self

pub const fn get(self) -> f64

Trait Implementations

impl AbsDiffEq for Portable

type Epsilon = Portable

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.

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

The inverse of AbsDiffEq::abs_diff_eq.

impl Add for Portable

type Output = Portable

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Portable

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Portable

fn clone(&self) -> Portable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComplexField for Portable

type RealField = Portable

fn from_real(re: Self) -> Self

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

fn real(self) -> Self

The real part of this complex number.

fn imaginary(self) -> Self

The imaginary part of this complex number.

fn norm1(self) -> Self

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

fn modulus(self) -> Self

The modulus of this complex number.

fn modulus_squared(self) -> Self

The squared modulus of this complex number.

fn argument(self) -> Self

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) -> Self

Multiplies this complex number by factor.

fn unscale(self, factor: Self) -> 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 mul_add(self, a: Self, b: Self) -> Self

fn abs(self) -> Self

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

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

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

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

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

fn powc(self, exponent: 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 sin(self) -> Self

fn cos(self) -> Self

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

fn tan(self) -> Self

fn asin(self) -> Self

fn acos(self) -> Self

fn atan(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 signum(self) -> Self

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

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 Copy for Portable

impl Debug for Portable

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

Formats the value using the given formatter.

impl Default for Portable

fn default() -> Portable

Returns the “default value” for a type.

impl Display for Portable

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

Formats the value using the given formatter.

impl Div for Portable

type Output = Portable

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for Portable

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl Field for Portable

impl From<Portable> for f64

fn from(value: Portable) -> Self

Converts to this type from the input type.

impl From<f64> for Portable

fn from(value: f64) -> Self

Converts to this type from the input type.

impl FromPrimitive for Portable

fn from_i64(value: 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(value: 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_f64(value: 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.

fn from_f32(value: 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_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_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.

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_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 FromStr for Portable

type Err = ParseFloatError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Mul for Portable

type Output = Portable

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Portable

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Portable

type Output = Portable

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Num for Portable

type FromStrRadixErr = ParseFloatError

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

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

impl One for Portable

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.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl PartialEq for Portable

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Portable

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

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

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 PrimitiveSimdValue for Portable

impl RealField for Portable

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 sign to self.

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 min_value() -> Option<Self>

The smallest finite positive value representable using this type.

fn max_value() -> Option<Self>

The largest finite positive value representable using this type.

fn pi() -> Self

fn two_pi() -> Self

fn frac_pi_2() -> Self

fn frac_pi_3() -> Self

fn frac_pi_4() -> Self

fn frac_pi_6() -> Self

fn frac_pi_8() -> Self

fn frac_1_pi() -> Self

fn frac_2_pi() -> Self

fn frac_2_sqrt_pi() -> Self

fn e() -> Self

fn log2_e() -> Self

fn log10_e() -> Self

fn ln_2() -> Self

fn ln_10() -> Self

impl RelativeEq for Portable

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.

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

The inverse of RelativeEq::relative_eq.

impl Rem for Portable

type Output = Portable

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign for Portable

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl Signed for Portable

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 SimdValue for Portable

const LANES: usize = 1

The number of lanes of this SIMD value.

type Element = Portable

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 splat(value: 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, value: Self::Element)

Replaces the i-th lane of self by val.

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

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

fn select(self, condition: bool, 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 StructuralPartialEq for Portable

impl Sub for Portable

type Output = Portable

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Portable

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl SubsetOf<Portable> for f64

fn to_superset(&self) -> Portable

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

fn from_superset_unchecked(element: &Portable) -> Self

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

fn is_in_subset(_: &Portable) -> bool

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

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

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

impl SubsetOf<Portable> for f32

fn to_superset(&self) -> Portable

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

fn from_superset_unchecked(element: &Portable) -> Self

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

fn is_in_subset(_: &Portable) -> bool

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

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

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

impl SubsetOf<Portable> for Portable

fn to_superset(&self) -> Self

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

fn from_superset_unchecked(element: &Self) -> Self

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

fn is_in_subset(_: &Self) -> bool

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

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

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

impl SubsetOf<f32> for Portable

fn to_superset(&self) -> f32

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

fn from_superset_unchecked(element: &f32) -> Self

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

fn is_in_subset(_: &f32) -> bool

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

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

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

impl SubsetOf<f64> for Portable

fn to_superset(&self) -> f64

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

fn from_superset_unchecked(element: &f64) -> Self

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

fn is_in_subset(_: &f64) -> bool

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

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

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

impl ToPrimitive for Portable

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.

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_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_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.

impl UlpsEq for Portable

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.

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

The inverse of UlpsEq::ulps_eq.

impl Zero for Portable

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.

fn set_zero(&mut self)

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