Struct num_dual::DualVec

pub struct DualVec<T: DualNum<F>, F, D: Dim>
where
    DefaultAllocator: Allocator<T, D>,
{
    pub re: T,
    pub eps: Derivative<T, F, D, U1>,
    /* private fields */
}

A vector dual number for the calculations of gradients or Jacobians.

Fields

re: T

Real part of the dual number

eps: Derivative<T, F, D, U1>

Derivative part of the dual number

Implementations

impl<T: DualNum<F>, F, D: Dim> DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D>,

pub fn new(re: T, eps: Derivative<T, F, D, U1>) -> Self

Create a new dual number from its fields.

impl<T: DualNum<F> + Zero, F, D: Dim> DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D>,

pub fn from_re(re: T) -> Self

Create a new dual number from the real part.

Trait Implementations

impl<T: DualNum<F> + AbsDiffEq<Epsilon = T>, F: Float, D: Dim> AbsDiffEq for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D>,

Like PartialEq, comparisons are only made based on the real part. This allows the code to follow the same execution path as real-valued code would.

type Epsilon = DualVec<T, F, D>

Used for specifying relative comparisons.

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 default_epsilon() -> Self::Epsilon

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

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

The inverse of AbsDiffEq::abs_diff_eq.

impl<'a, 'b, T: DualNum<F>, F: Float, D: Dim> Add<&'a DualVec<T, F, D>> for &'b DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the + operator.

fn add(self, other: &DualVec<T, F, D>) -> DualVec<T, F, D>

Performs the + operation.

impl<T: DualNum<F>, F: Float, D: Dim> Add<&DualVec<T, F, D>> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the + operator.

fn add(self, rhs: &DualVec<T, F, D>) -> Self::Output

Performs the + operation.

impl<T: DualNum<F>, F: Float, D: Dim> Add<DualVec<T, F, D>> for &DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the + operator.

fn add(self, rhs: DualVec<T, F, D>) -> Self::Output

Performs the + operation.

impl<T: DualNum<F>, F, D: Dim> Add<F> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the + operator.

fn add(self, other: F) -> Self

Performs the + operation.

impl<T: DualNum<F>, F: Float, D: Dim> Add for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the + operator.

fn add(self, rhs: DualVec<T, F, D>) -> Self::Output

Performs the + operation.

impl<T: DualNum<F>, F, D: Dim> AddAssign<F> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn add_assign(&mut self, other: F)

Performs the += operation.

impl<T: DualNum<F>, F, D: Dim> AddAssign for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T: Clone + DualNum<F>, F: Clone, D: Clone + Dim> Clone for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D>,

fn clone(&self) -> DualVec<T, F, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, D: Dim> ComplexField for DualVec<T, T::Element, D>

where T: DualNum<T::Element> + SupersetOf<T> + AbsDiffEq<Epsilon = T> + Sync + Send + SupersetOf<T::Element> + SupersetOf<f64> + SimdPartialOrd + PartialOrd + SimdValue<Element = T, SimdBool = bool> + RelativeEq + UlpsEq + AbsDiffEq, T::Element: DualNum<T::Element> + Scalar + DualNumFloat + Sync + Send, DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, U1> + Allocator<T, D, D>, <DefaultAllocator as Allocator<T, D>>::Buffer: Sync + Send,

type RealField = DualVec<T, <T as SimdValue>::Element, D>

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 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 norm1(self) -> Self::RealField

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

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

fn abs(self) -> Self::RealField

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

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

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

fn recip(self) -> Self

fn conjugate(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 log(self, base: Self::RealField) -> Self

fn log2(self) -> Self

fn log10(self) -> Self

fn ln(self) -> Self

fn ln_1p(self) -> Self

fn sqrt(self) -> Self

fn exp(self) -> Self

fn exp2(self) -> Self

fn exp_m1(self) -> Self

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

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

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

fn cbrt(self) -> Self

fn is_finite(&self) -> bool

fn try_sqrt(self) -> Option<Self>

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

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

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

The exponential form of this complex number: (modulus, e^{i 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<T: Debug + DualNum<F>, F: Debug, D: Debug + Dim> Debug for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D>,

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

Formats the value using the given formatter.

impl<T: DualNum<F>, F, D: Dim> Display for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D>,

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

Formats the value using the given formatter.

impl<'a, 'b, T: DualNum<F>, F: Float, D: Dim> Div<&'a DualVec<T, F, D>> for &'b DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the / operator.

fn div(self, other: &DualVec<T, F, D>) -> DualVec<T, F, D>

Performs the / operation.

impl<T: DualNum<F>, F: Float, D: Dim> Div<&DualVec<T, F, D>> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the / operator.

fn div(self, rhs: &DualVec<T, F, D>) -> Self::Output

Performs the / operation.

impl<T: DualNum<F>, F: Float, D: Dim> Div<DualVec<T, F, D>> for &DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the / operator.

fn div(self, rhs: DualVec<T, F, D>) -> Self::Output

Performs the / operation.

impl<T: DualNum<F>, F: DualNumFloat, D: Dim> Div<F> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the / operator.

fn div(self, other: F) -> Self

Performs the / operation.

impl<T: DualNum<F>, F: Float, D: Dim> Div for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the / operator.

fn div(self, rhs: DualVec<T, F, D>) -> Self::Output

Performs the / operation.

impl<T: DualNum<F>, F: DualNumFloat, D: Dim> DivAssign<F> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn div_assign(&mut self, other: F)

Performs the /= operation.

impl<T: DualNum<F>, F: Float, D: Dim> DivAssign for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<T: DualNum<F>, F: DualNumFloat, D: Dim> DualNum<F> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

const NDERIV: usize = _

Highest derivative that can be calculated with this struct

fn re(&self) -> F

Real part (0th derivative) of the number

fn recip(&self) -> Self

Reciprocal (inverse) of a number 1/x.

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

Power with integer exponent x^n

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

Power with real exponent x^n

fn sqrt(&self) -> Self

Square root

fn cbrt(&self) -> Self

Cubic root

fn exp(&self) -> Self

Exponential e^x

fn exp2(&self) -> Self

Exponential with base 2 2^x

fn exp_m1(&self) -> Self

Exponential minus 1 e^x-1

fn ln(&self) -> Self

Natural logarithm

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

Logarithm with arbitrary base

fn log2(&self) -> Self

Logarithm with base 2

fn log10(&self) -> Self

Logarithm with base 10

fn ln_1p(&self) -> Self

Logarithm on x plus one ln(1+x)

fn sin(&self) -> Self

Sine

fn cos(&self) -> Self

Cosine

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

Calculate sine and cosine simultaneously

fn tan(&self) -> Self

Tangent

fn asin(&self) -> Self

Arcsine

fn acos(&self) -> Self

Arccosine

fn atan(&self) -> Self

Arctangent

fn sinh(&self) -> Self

Hyperbolic sine

fn cosh(&self) -> Self

Hyperbolic cosine

fn tanh(&self) -> Self

Hyperbolic tangent

fn asinh(&self) -> Self

Area hyperbolic sine

fn acosh(&self) -> Self

Area hyperbolic cosine

fn atanh(&self) -> Self

Area hyperbolic tangent

fn sph_j0(&self) -> Self

0th order spherical Bessel function of the first kind

fn sph_j1(&self) -> Self

1st order spherical Bessel function of the first kind

fn sph_j2(&self) -> Self

2nd order spherical Bessel function of the first kind

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

Fused multiply-add

fn powd(&self, exp: Self) -> Self

Power with dual exponent x^n

impl<T: DualNum<F>, F: Float + FloatConst, D: Dim> FloatConst for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn E() -> Self

Return Euler’s number.

fn FRAC_1_PI() -> Self

Return 1.0 / π.

fn FRAC_1_SQRT_2() -> Self

Return 1.0 / sqrt(2.0).

fn FRAC_2_PI() -> Self

Return 2.0 / π.

fn FRAC_2_SQRT_PI() -> Self

Return 2.0 / sqrt(π).

fn FRAC_PI_2() -> Self

Return π / 2.0.

fn FRAC_PI_3() -> Self

Return π / 3.0.

fn FRAC_PI_4() -> Self

Return π / 4.0.

fn FRAC_PI_6() -> Self

Return π / 6.0.

fn FRAC_PI_8() -> Self

Return π / 8.0.

fn LN_10() -> Self

Return ln(10.0).

fn LN_2() -> Self

Return ln(2.0).

fn LOG10_E() -> Self

Return log10(e).

fn LOG2_E() -> Self

Return log2(e).

fn PI() -> Self

Return Archimedes’ constant π.

fn SQRT_2() -> Self

Return sqrt(2.0).

fn TAU() -> Self

where Self: Sized + Add<Output = Self>,

Return the full circle constant τ.

fn LOG10_2() -> Self

where Self: Sized + Div<Output = Self>,

Return log10(2.0).

fn LOG2_10() -> Self

where Self: Sized + Div<Output = Self>,

Return log2(10.0).

impl<T: DualNum<F>, F, D: Dim> From<F> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn from(float: F) -> Self

Converts to this type from the input type.

impl<T: DualNum<F>, F: Float + FromPrimitive, D: Dim> FromPrimitive for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

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

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.

impl<T: DualNum<F>, F: DualNumFloat, D: Dim> Inv for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The result after applying the operator.

fn inv(self) -> Self

Returns the multiplicative inverse of self.

impl<'a, 'b, T: DualNum<F>, F: Float, D: Dim> Mul<&'a DualVec<T, F, D>> for &'b DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the * operator.

fn mul(self, other: &DualVec<T, F, D>) -> Self::Output

Performs the * operation.

impl<T: DualNum<F>, F: Float, D: Dim> Mul<&DualVec<T, F, D>> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the * operator.

fn mul(self, rhs: &DualVec<T, F, D>) -> Self::Output

Performs the * operation.

impl<T: DualNum<F>, F: Float, D: Dim> Mul<DualVec<T, F, D>> for &DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the * operator.

fn mul(self, rhs: DualVec<T, F, D>) -> Self::Output

Performs the * operation.

impl<T: DualNum<F>, F: DualNumFloat, D: Dim> Mul<F> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the * operator.

fn mul(self, other: F) -> Self

Performs the * operation.

impl<T: DualNum<F>, F: Float, D: Dim> Mul for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the * operator.

fn mul(self, rhs: DualVec<T, F, D>) -> Self::Output

Performs the * operation.

impl<T: DualNum<F>, F: DualNumFloat, D: Dim> MulAssign<F> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn mul_assign(&mut self, other: F)

Performs the *= operation.

impl<T: DualNum<F>, F: Float, D: Dim> MulAssign for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<T: DualNum<F>, F: Float, D: Dim> Neg for &DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: DualNum<F>, F: Float, D: Dim> Neg for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: DualNum<F> + Signed, F: Float, D: Dim> Num for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type FromStrRadixErr = <F 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<T: DualNum<F>, F: Float, D: Dim> One for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

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

impl<T: DualNum<F> + PartialEq, F: Float, D: Dim> PartialEq for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D>,

Comparisons are only made based on the real part. This allows the code to follow the same execution path as real-valued code would.

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: DualNum<F> + PartialOrd, F: Float, D: Dim> PartialOrd for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D>,

Like PartialEq, comparisons are only made based on the real part. This allows the code to follow the same execution path as real-valued code would.

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

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

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

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

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

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

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<'a, T: DualNum<F>, F: Float, D: Dim> Product<&'a DualVec<T, F, D>> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn product<I>(iter: I) -> Self

where I: Iterator<Item = &'a DualVec<T, F, D>>,

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<T: DualNum<F>, F: Float, D: Dim> Product for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn product<I>(iter: I) -> Self

where I: Iterator<Item = Self>,

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<T, D: Dim> RealField for DualVec<T, T::Element, D>

where T: DualNum<T::Element> + SupersetOf<T> + Sync + Send + SupersetOf<T::Element> + SupersetOf<f64> + SimdPartialOrd + PartialOrd + RelativeEq + AbsDiffEq<Epsilon = T> + SimdValue<Element = T, SimdBool = bool> + UlpsEq + AbsDiffEq, T::Element: DualNum<T::Element> + Scalar + DualNumFloat, DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, U1> + Allocator<T, D, D>, <DefaultAllocator as Allocator<T, D>>::Buffer: Sync + Send,

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

Got to be careful using this, because it throws away the derivatives of the one not chosen

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

Got to be careful using this, because it throws away the derivatives of the one not chosen

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

If the min/max values are constants and the clamping has an effect, you lose your gradients.

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

Copies the sign of sign to self.

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

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

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

impl<T: DualNum<F> + RelativeEq<Epsilon = T>, F: Float, D: Dim> RelativeEq for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D>,

Like PartialEq, comparisons are only made based on the real part. This allows the code to follow the same execution path as real-valued code would.

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: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon ) -> bool

The inverse of RelativeEq::relative_eq.

impl<'a, 'b, T: DualNum<F>, F, D: Dim> Rem<&'a DualVec<T, F, D>> for &'b DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the % operator.

fn rem(self, _other: &DualVec<T, F, D>) -> DualVec<T, F, D>

Performs the % operation.

impl<T: DualNum<F>, F: Float, D: Dim> Rem<&DualVec<T, F, D>> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the % operator.

fn rem(self, rhs: &DualVec<T, F, D>) -> Self::Output

Performs the % operation.

impl<T: DualNum<F>, F: Float, D: Dim> Rem<DualVec<T, F, D>> for &DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the % operator.

fn rem(self, rhs: DualVec<T, F, D>) -> Self::Output

Performs the % operation.

impl<T: DualNum<F>, F, D: Dim> Rem<F> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the % operator.

fn rem(self, _other: F) -> Self

Performs the % operation.

impl<T: DualNum<F>, F: Float, D: Dim> Rem for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the % operator.

fn rem(self, rhs: DualVec<T, F, D>) -> Self::Output

Performs the % operation.

impl<T: DualNum<F>, F, D: Dim> RemAssign<F> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn rem_assign(&mut self, _other: F)

Performs the %= operation.

impl<T: DualNum<F>, F, D: Dim> RemAssign for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn rem_assign(&mut self, _other: Self)

Performs the %= operation.

impl<T: DualNum<F>, F: DualNumFloat, D: Dim> Signed for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

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<T, D: Dim> SimdValue for DualVec<T, T::Element, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T::Element, D>, T: DualNum<T::Element> + SimdValue + Scalar, T::Element: DualNum<T::Element> + Scalar,

The SimdValue trait is for rearranging data into a form more suitable for Simd, and rearranging it back into a usable form. It is not documented particularly well.

The primary job of this SimdValue impl is to allow people to use simba::simd::f32x4 etc, instead of f32/f64. Those types implement nalgebra::SimdRealField/ComplexField, so they behave like scalars. When we use them, we would have DualVec<f32x4, f32, N> etc, with our F parameter set to <T as SimdValue>::Element. We will need to be able to split up that type into four of DualVec in order to get out of simd-land. That’s what the SimdValue trait is for.

Ultimately, someone will have to to implement SimdRealField on DualVec and call the simd_ functions of <T as SimdRealField>. That’s future work for someone who finds num_dual is not fast enough.

Unfortunately, doing anything with SIMD is blocked on https://github.com/dimforge/simba/issues/44.

type Element = DualVec<<T as SimdValue>::Element, <T as SimdValue>::Element, D>

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

type SimdBool = <T as SimdValue>::SimdBool

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, i: usize) -> Self::Element

Extracts the i-th lane of self.

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

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

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

Replaces the i-th lane of self by val.

unsafe fn replace_unchecked(&mut self, i: 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<'a, 'b, T: DualNum<F>, F: Float, D: Dim> Sub<&'a DualVec<T, F, D>> for &'b DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the - operator.

fn sub(self, other: &DualVec<T, F, D>) -> DualVec<T, F, D>

Performs the - operation.

impl<T: DualNum<F>, F: Float, D: Dim> Sub<&DualVec<T, F, D>> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the - operator.

fn sub(self, rhs: &DualVec<T, F, D>) -> Self::Output

Performs the - operation.

impl<T: DualNum<F>, F: Float, D: Dim> Sub<DualVec<T, F, D>> for &DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the - operator.

fn sub(self, rhs: DualVec<T, F, D>) -> Self::Output

Performs the - operation.

impl<T: DualNum<F>, F, D: Dim> Sub<F> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the - operator.

fn sub(self, other: F) -> Self

Performs the - operation.

impl<T: DualNum<F>, F: Float, D: Dim> Sub for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

type Output = DualVec<T, F, D>

The resulting type after applying the - operator.

fn sub(self, rhs: DualVec<T, F, D>) -> Self::Output

Performs the - operation.

impl<T: DualNum<F>, F, D: Dim> SubAssign<F> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn sub_assign(&mut self, other: F)

Performs the -= operation.

impl<T: DualNum<F>, F, D: Dim> SubAssign for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<TSuper, FSuper, T, F, D: Dim> SubsetOf<DualVec<TSuper, FSuper, D>> for DualVec<T, F, D>

where TSuper: DualNum<FSuper> + SupersetOf<T>, T: DualNum<F>, DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, U1> + Allocator<T, D, D> + Allocator<TSuper, D> + Allocator<TSuper, U1, D> + Allocator<TSuper, D, U1> + Allocator<TSuper, D, D>,

fn to_superset(&self) -> DualVec<TSuper, FSuper, D>

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

fn from_superset(element: &DualVec<TSuper, FSuper, D>) -> Option<Self>

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

fn from_superset_unchecked(element: &DualVec<TSuper, FSuper, D>) -> Self

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

fn is_in_subset(element: &DualVec<TSuper, FSuper, D>) -> bool

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

impl<'a, T: DualNum<F>, F: Float, D: Dim> Sum<&'a DualVec<T, F, D>> for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = &'a DualVec<T, F, D>>,

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<T: DualNum<F>, F: Float, D: Dim> Sum for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = Self>,

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<TSuper, FSuper, D: Dim> SupersetOf<f32> for DualVec<TSuper, FSuper, D>

where TSuper: DualNum<FSuper> + SupersetOf<f32>, DefaultAllocator: Allocator<TSuper, D> + Allocator<TSuper, U1, D> + Allocator<TSuper, D, U1> + Allocator<TSuper, D, D>,

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> f32

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

fn from_subset(element: &f32) -> Self

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

fn to_subset(&self) -> Option<T>

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

impl<TSuper, FSuper, D: Dim> SupersetOf<f64> for DualVec<TSuper, FSuper, D>

where TSuper: DualNum<FSuper> + SupersetOf<f64>, DefaultAllocator: Allocator<TSuper, D> + Allocator<TSuper, U1, D> + Allocator<TSuper, D, U1> + Allocator<TSuper, D, D>,

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> f64

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

fn from_subset(element: &f64) -> Self

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

fn to_subset(&self) -> Option<T>

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

impl<T: DualNum<F> + UlpsEq<Epsilon = T>, F: Float, D: Dim> UlpsEq for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D>,

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: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<T: DualNum<F>, F: Float, D: Dim> Zero for DualVec<T, F, D>

where DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, D>,

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.

impl<T: DualNum<F> + Copy, F: Copy, const N: usize> Copy for DualVec<T, F, Const<N>>

impl<T, D: Dim> Field for DualVec<T, T::Element, D>

where T: DualNum<T::Element> + SimdValue, T::Element: DualNum<T::Element> + Scalar + Float, DefaultAllocator: Allocator<T, D> + Allocator<T, U1, D> + Allocator<T, D, U1> + Allocator<T, D, D> + Allocator<T::Element, D> + Allocator<T::Element, U1, D> + Allocator<T::Element, D, U1> + Allocator<T::Element, D, D>,