Skip to main content

Dual

Struct Dual 

Source
pub struct Dual {
    pub re: Real,
    pub du: Real,
}
Expand description

A dual number a + b * ε where ε² = 0.

Dual numbers support forward-mode automatic differentiation: evaluating f(a + 1*ε) gives f(a) + f'(a)*ε.

Fields§

§re: Real

Real part.

§du: Real

Dual (infinitesimal) part.

Implementations§

Source§

impl Dual

Source

pub fn new(re: Real, du: Real) -> Self

Construct a dual number.

Source

pub fn constant(re: Real) -> Self

Constant (derivative = 0).

Source

pub fn variable(re: Real) -> Self

Variable (derivative = 1).

Source

pub fn sqrt(self) -> Self

Square root: √(a + b*ε) = √a + b/(2√a) * ε.

Source

pub fn sin(self) -> Self

Sine: sin(a + bε) = sin(a) + bcos(a)*ε.

Source

pub fn cos(self) -> Self

Cosine: cos(a + bε) = cos(a) - bsin(a)*ε.

Source

pub fn exp(self) -> Self

Exponential: exp(a + bε) = exp(a) + bexp(a)*ε.

Source

pub fn ln(self) -> Self

Natural log: ln(a + b*ε) = ln(a) + b/a * ε.

Source

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

Raise to integer power: (a+bε)^n = a^n + nb*a^{n-1}*ε.

Trait Implementations§

Source§

impl Add for Dual

Source§

type Output = Dual

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl Clone for Dual

Source§

fn clone(&self) -> Dual

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Dual

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Div for Dual

Source§

type Output = Dual

The resulting type after applying the / operator.
Source§

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

Performs the / operation. Read more
Source§

impl Mul for Dual

Source§

type Output = Dual

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl Neg for Dual

Source§

type Output = Dual

The resulting type after applying the - operator.
Source§

fn neg(self) -> Self

Performs the unary - operation. Read more
Source§

impl PartialEq for Dual

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Sub for Dual

Source§

type Output = Dual

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl Copy for Dual

Source§

impl StructuralPartialEq for Dual

Auto Trait Implementations§

§

impl Freeze for Dual

§

impl RefUnwindSafe for Dual

§

impl Send for Dual

§

impl Sync for Dual

§

impl Unpin for Dual

§

impl UnsafeUnpin for Dual

§

impl UnwindSafe for Dual

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ClosedNeg for T
where T: Neg<Output = T>,

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,