Skip to main content

DualNum

Trait DualNum

pub trait DualNum:
    NumOps
    + for<'r> NumOps<&'r Self>
    + Signed
    + NumOps<Self::Primitive>
    + NumAssignOps
    + NumAssignOps<Self::Primitive>
    + Clone
    + Inv<Output = Self>
    + Sum
    + Product
    + FromPrimitive
    + From<Self::Primitive>
    + DualStruct<Real = Self::Primitive>
    + Mappable<Self>
    + Display
    + PartialOrd
    + PartialOrd<Self::Primitive>
    + Debug
    + 'static {
    type Primitive: DualNumFloat;
    type InnerDual: DualNum;

    const NDERIV: usize;
Show 33 methods
    // Required methods
    fn from_re(re: Self::InnerDual) -> Self;
    fn recip(&self) -> Self;
    fn powi(&self, n: i32) -> Self;
    fn powf(&self, n: Self::Primitive) -> Self;
    fn sqrt(&self) -> Self;
    fn cbrt(&self) -> Self;
    fn exp(&self) -> Self;
    fn exp2(&self) -> Self;
    fn exp_m1(&self) -> Self;
    fn ln(&self) -> Self;
    fn log(&self, base: Self::Primitive) -> Self;
    fn log2(&self) -> Self;
    fn log10(&self) -> Self;
    fn ln_1p(&self) -> Self;
    fn sin(&self) -> Self;
    fn cos(&self) -> Self;
    fn tan(&self) -> Self;
    fn sin_cos(&self) -> (Self, Self);
    fn asin(&self) -> Self;
    fn acos(&self) -> Self;
    fn atan(&self) -> Self;
    fn atan2(&self, other: 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 sph_j0(&self) -> Self;
    fn sph_j1(&self) -> Self;
    fn sph_j2(&self) -> Self;

    // Provided methods
    fn mul_add(&self, a: Self, b: Self) -> Self { ... }
    fn powd(&self, exp: Self) -> Self { ... }
}

Expand description

A generalized (hyper) dual number.

Required Associated Constants§

const NDERIV: usize

Highest derivative that can be calculated with this struct

Required Associated Types§

type Primitive: DualNumFloat

The underlying primitive data type (mostly f64 or f32)

type InnerDual: DualNum

The type of the individual elements of this dual number

Required Methods§

fn from_re(re: Self::InnerDual) -> Self

Build a dual number from its real part, setting all other values to 0

fn recip(&self) -> Self

Reciprocal (inverse) of a number 1/x

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

Power with integer exponent x^n

fn powf(&self, n: Self::Primitive) -> 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: Self::Primitive) -> 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 tan(&self) -> Self

Tangent

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

Calculate sine and cosine simultaneously

fn asin(&self) -> Self

Arcsine

fn acos(&self) -> Self

Arccosine

fn atan(&self) -> Self

Arctangent

fn atan2(&self, other: 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

Provided Methods§

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

Fused multiply-add

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

Power with dual exponent x^n

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types§

impl DualNum for f32

const NDERIV: usize = 0

type Primitive = f32

type InnerDual = f32

fn from_re(re: f32) -> Self

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

fn recip(&self) -> Self

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

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

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

fn sqrt(&self) -> Self

fn exp(&self) -> Self

fn exp2(&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 tan(&self) -> Self

fn asin(&self) -> Self

fn acos(&self) -> Self

fn atan(&self) -> Self

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

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

fn exp_m1(&self) -> Self

fn ln_1p(&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 sph_j0(&self) -> Self

fn sph_j1(&self) -> Self

fn sph_j2(&self) -> Self

impl DualNum for f64

const NDERIV: usize = 0

type Primitive = f64

type InnerDual = f64

fn from_re(re: f64) -> Self

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

fn recip(&self) -> Self

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

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

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

fn sqrt(&self) -> Self

fn exp(&self) -> Self

fn exp2(&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 tan(&self) -> Self

fn asin(&self) -> Self

fn acos(&self) -> Self

fn atan(&self) -> Self

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

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

fn exp_m1(&self) -> Self

fn ln_1p(&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 sph_j0(&self) -> Self

fn sph_j1(&self) -> Self

fn sph_j2(&self) -> Self

Implementors§

impl<T: DualNum<Primitive = F>, F: DualNumFloat, D: Dim> DualNum for Dual2Vec<T, D>
where DefaultAllocator: Allocator<U1, D> + Allocator<D, D>,

const NDERIV: usize

type Primitive = F

type InnerDual = T

impl<T: DualNum<Primitive = F>, F: DualNumFloat, D: Dim> DualNum for DualVec<T, D>
where DefaultAllocator: Allocator<D>,

const NDERIV: usize

type Primitive = F

type InnerDual = T

impl<T: DualNum<Primitive = F>, F: DualNumFloat, M: Dim, N: Dim> DualNum for HyperDualVec<T, M, N>
where DefaultAllocator: Allocator<M> + Allocator<M, N> + Allocator<U1, N>,

const NDERIV: usize

type Primitive = F

type InnerDual = T

impl<T: DualNum<Primitive = F>, F: DualNumFloat> DualNum for Dual2<T>

const NDERIV: usize

type Primitive = F

type InnerDual = T

impl<T: DualNum<Primitive = F>, F: DualNumFloat> DualNum for Dual3<T>

const NDERIV: usize

type Primitive = F

type InnerDual = T

impl<T: DualNum<Primitive = F>, F: DualNumFloat> DualNum for Dual<T>

const NDERIV: usize

type Primitive = F

type InnerDual = T

impl<T: DualNum<Primitive = F>, F: DualNumFloat> DualNum for HyperDual<T>

const NDERIV: usize

type Primitive = F

type InnerDual = T

impl<T: DualNum<Primitive = F>, F: DualNumFloat> DualNum for HyperHyperDual<T>

const NDERIV: usize

type Primitive = F

type InnerDual = T

impl<T: DualNum<Primitive = F>, F: DualNumFloat> DualNum for Real<T>

const NDERIV: usize

type Primitive = F

type InnerDual = T