Struct num_dual::DualVec

pub struct DualVec<T, F, const N: usize> {
    pub re: T,
    pub eps: StaticVec<T, N>,
    // some fields omitted
}

A dual number for the calculations of gradients or Jacobians.

Fields

re: T

Real part of the dual number

eps: StaticVec<T, N>

Derivative part of the dual number

Implementations

impl<T, F, const N: usize> DualVec<T, F, N>

pub fn new(re: T, eps: StaticVec<T, N>) -> Self

Create a new dual number from its fields.

impl<T, F> DualVec<T, F, 1_usize>

pub fn new_scalar(re: T, eps: T) -> Self

Create a new scalar dual number from its fields.

impl<T: Copy + Zero + AddAssign, F, const N: usize> DualVec<T, F, N>

pub fn from_re(re: T) -> Self

Create a new dual number from the real part.

impl<T: One, F> DualVec<T, F, 1_usize>

pub fn derive(self) -> Self

Derive a scalar dual number, i.e. set the derivative part to 1.

let x = Dual64::from_re(5.0).derive().powi(2);
assert_eq!(x.re, 25.0);
assert_eq!(x.eps[0], 10.0);

Trait Implementations

impl<T: DualNum<F>, F: Float, const N: usize> Add<&'_ DualVec<T, F, N>> for DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, 'b, T: DualNum<F>, F: Float, const N: usize> Add<&'a DualVec<T, F, N>> for &'b DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: DualNum<F>, F: Float, const N: usize> Add<DualVec<T, F, N>> for &DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: DualNum<F>, F: Float, const N: usize> Add<DualVec<T, F, N>> for DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: AddAssign<F>, F: Float, const N: usize> Add<F> for DualVec<T, F, N>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Copy + AddAssign, F: Float, const N: usize> AddAssign<DualVec<T, F, N>> for DualVec<T, F, N>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T: AddAssign<F>, F: Float, const N: usize> AddAssign<F> for DualVec<T, F, N>

fn add_assign(&mut self, other: F)

Performs the += operation.

impl<T: Clone, F: Clone, const N: usize> Clone for DualVec<T, F, N>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, F: Debug, const N: usize> Debug for DualVec<T, F, N>

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

Formats the value using the given formatter.

impl<T: Display, F, const N: usize> Display for DualVec<T, F, N>

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

Formats the value using the given formatter.

impl<T: DualNum<F>, F: Float, const N: usize> Div<&'_ DualVec<T, F, N>> for DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a, 'b, T: DualNum<F>, F: Float, const N: usize> Div<&'a DualVec<T, F, N>> for &'b DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: DualNum<F>, F: Float, const N: usize> Div<DualVec<T, F, N>> for &DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: DualNum<F>, F: Float, const N: usize> Div<DualVec<T, F, N>> for DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: DualNum<F>, F: DualNumFloat, const N: usize> Div<F> for DualVec<T, F, N>

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: DualNum<F>, F: Float, const N: usize> DivAssign<DualVec<T, F, N>> for DualVec<T, F, N>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<T: DualNum<F>, F: DualNumFloat, const N: usize> DivAssign<F> for DualVec<T, F, N>

fn div_assign(&mut self, other: F)

Performs the /= operation.

impl<T: DualNum<F>, F: DualNumFloat, const N: usize> DualNum<F> for DualVec<T, F, N>

const NDERIV: usize

Highest derivative that can be calculated with this struct

fn re(&self) -> F

Real part (0th derivative) of the number

fn scale(&mut self, f: F)

Multiply the number with the scalar f inplace.

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, const N: usize> FloatConst for DualVec<T, F, N>

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: Add<Self, Output = Self>, 

Return the full circle constant τ.

fn LOG10_2() -> Self where
    Self: Div<Self, Output = Self>, 

Return log10(2.0).

fn LOG2_10() -> Self where
    Self: Div<Self, Output = Self>, 

Return log2(10.0).

impl<T: Copy + Zero + AddAssign + From<F>, F, const N: usize> From<F> for DualVec<T, F, N>

fn from(float: F) -> Self

Performs the conversion.

impl<T: DualNum<F>, F: Float + FromPrimitive, const N: usize> FromPrimitive for DualVec<T, F, N>

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, const N: usize> Inv for DualVec<T, F, N>

type Output = Self

The result after applying the operator.

fn inv(self) -> Self

Returns the multiplicative inverse of self.

impl<T: DualNum<F>, F: Float, const N: usize> Mul<&'_ DualVec<T, F, N>> for DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, 'b, T: DualNum<F>, F: Float, const N: usize> Mul<&'a DualVec<T, F, N>> for &'b DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: DualNum<F>, F: Float, const N: usize> Mul<DualVec<T, F, N>> for &DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: DualNum<F>, F: Float, const N: usize> Mul<DualVec<T, F, N>> for DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: DualNum<F>, F: DualNumFloat, const N: usize> Mul<F> for DualVec<T, F, N>

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: DualNum<F>, F: Float, const N: usize> MulAssign<DualVec<T, F, N>> for DualVec<T, F, N>

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<T: DualNum<F>, F: DualNumFloat, const N: usize> MulAssign<F> for DualVec<T, F, N>

fn mul_assign(&mut self, other: F)

Performs the *= operation.

impl<T: Copy + Neg<Output = T>, F: Float, const N: usize> Neg for DualVec<T, F, N>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: Copy + Neg<Output = T>, F: Float, const N: usize> Neg for &DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: DualNum<F> + Signed, F: Float, const N: usize> Num for DualVec<T, F, N>

type FromStrRadixErr = F::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, const N: usize> One for DualVec<T, F, N>

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: PartialEq, F: PartialEq, const N: usize> PartialEq<DualVec<T, F, N>> for DualVec<T, F, N>

fn eq(&self, other: &DualVec<T, F, N>) -> bool

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

fn ne(&self, other: &DualVec<T, F, N>) -> bool

This method tests for !=.

impl<'a, T: DualNum<F>, F: Float, const N: usize> Product<&'a DualVec<T, F, N>> for DualVec<T, F, N>

fn product<I>(iter: I) -> Self where
    I: Iterator<Item = &'a DualVec<T, F, N>>, 

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

impl<T: DualNum<F>, F: Float, const N: usize> Product<DualVec<T, F, N>> for DualVec<T, F, N>

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: DualNum<F>, F: Float, const N: usize> Rem<&'_ DualVec<T, F, N>> for DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<'a, 'b, T, F, const N: usize> Rem<&'a DualVec<T, F, N>> for &'b DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T: DualNum<F>, F: Float, const N: usize> Rem<DualVec<T, F, N>> for &DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T: DualNum<F>, F: Float, const N: usize> Rem<DualVec<T, F, N>> for DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T, F: Float, const N: usize> Rem<F> for DualVec<T, F, N>

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T, F: Float, const N: usize> RemAssign<DualVec<T, F, N>> for DualVec<T, F, N>

fn rem_assign(&mut self, _other: Self)

Performs the %= operation.

impl<T, F: Float, const N: usize> RemAssign<F> for DualVec<T, F, N>

fn rem_assign(&mut self, _other: F)

Performs the %= operation.

impl<T: DualNum<F>, F: DualNumFloat, const N: usize> Signed for DualVec<T, F, N>

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: DualNum<F>, F: Float, const N: usize> Sub<&'_ DualVec<T, F, N>> for DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, 'b, T: DualNum<F>, F: Float, const N: usize> Sub<&'a DualVec<T, F, N>> for &'b DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: DualNum<F>, F: Float, const N: usize> Sub<DualVec<T, F, N>> for &DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: DualNum<F>, F: Float, const N: usize> Sub<DualVec<T, F, N>> for DualVec<T, F, N>

type Output = DualVec<T, F, N>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: SubAssign<F>, F: Float, const N: usize> Sub<F> for DualVec<T, F, N>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Copy + SubAssign, F: Float, const N: usize> SubAssign<DualVec<T, F, N>> for DualVec<T, F, N>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T: SubAssign<F>, F: Float, const N: usize> SubAssign<F> for DualVec<T, F, N>

fn sub_assign(&mut self, other: F)

Performs the -= operation.

impl<'a, T: DualNum<F>, F: Float, const N: usize> Sum<&'a DualVec<T, F, N>> for DualVec<T, F, N>

fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = &'a DualVec<T, F, N>>, 

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

impl<T: DualNum<F>, F: Float, const N: usize> Sum<DualVec<T, F, N>> for DualVec<T, F, N>

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<T: DualNum<F>, F: Float, const N: usize> Zero for DualVec<T, F, N>

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: Copy, F: Copy, const N: usize> Copy for DualVec<T, F, N>

impl<T, F, const N: usize> StructuralPartialEq for DualVec<T, F, N>