Struct dual_num::DualNumber

pub struct DualNumber<T>(_, _);

Dual Number structure

Although DualNumber does implement PartialEq and PartialOrd, it only compares the real part.

Additionally, min and max only compare the real parts, and keep the dual parts.

Lastly, the Rem remainder operator is not correctly or fully defined for DualNumber, and will panic.

Methods

impl<T> DualNumber<T>

pub fn new(real: T, dual: T) -> DualNumber<T>

Create a new dual number from its real and dual parts.

pub fn from_real(real: T) -> DualNumber<T> where
    T: Zero, 

Create a new dual number from a real number.

The dual part is set to zero.

pub fn into_tuple(self) -> (T, T)

Returns both real and dual parts as a tuple

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn real_ref(&self) -> &T

Returns a reference to the real part

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn dual_ref(&self) -> &T

Returns a reference to the dual part

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn real_mut(&mut self) -> &mut T

Returns a mutable reference to the real part

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn dual_mut(&mut self) -> &mut T

Returns a mutable reference to the dual part

pub fn map<F>(self, mapper: F) -> Self where
    F: Fn(DualNumber<T>) -> DualNumber<T>, 

Convenience method to take a closure (or any function) that can operate on the dual number in place

pub fn map_parts<F>(self, mapper: F) -> Self where
    F: Fn(T, T) -> DualNumber<T>, 

Convenience method to take a closure (or any function) that can operate on the dual number parts in place

impl<T: Copy> DualNumber<T>

pub fn real(&self) -> T

Returns the real part

pub fn dual(&self) -> T

Returns the dual part

impl<T: Float> DualNumber<T>

pub fn conjugate(self) -> Self

Returns the conjugate of the dual number.

Trait Implementations

impl<T: Debug> Debug for DualNumber<T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Clone> Clone for DualNumber<T>

fn clone(&self) -> DualNumber<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for DualNumber<T>

impl<T: Zero> From<T> for DualNumber<T>

fn from(real: T) -> DualNumber<T>

Performs the conversion.

impl<T: Display> Display for DualNumber<T>

fn fmt(&self, f: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq<Self> for DualNumber<T>

fn eq(&self, rhs: &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 !=.

impl<T: PartialOrd> PartialOrd<Self> for DualNumber<T>

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

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

fn lt(&self, rhs: &Self) -> bool

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

fn le(&self, rhs: &Self) -> bool

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

fn gt(&self, rhs: &Self) -> bool

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

fn ge(&self, rhs: &Self) -> bool

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

impl<T: PartialEq> PartialEq<T> for DualNumber<T>

fn eq(&self, rhs: &T) -> 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 !=.

impl<T: PartialOrd> PartialOrd<T> for DualNumber<T>

fn partial_cmp(&self, rhs: &T) -> Option<Ordering>

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

fn lt(&self, rhs: &T) -> bool

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

fn le(&self, rhs: &T) -> bool

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

fn gt(&self, rhs: &T) -> bool

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

fn ge(&self, rhs: &T) -> bool

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

impl<T: ToPrimitive> ToPrimitive for DualNumber<T>

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32.

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize.

fn to_u8(&self) -> Option<u8>

Converts the value of self to an u8.

fn to_u16(&self) -> Option<u16>

Converts the value of self to an u16.

fn to_u32(&self) -> Option<u32>

Converts the value of self to an u32.

fn to_u64(&self) -> Option<u64>

Converts the value of self to an u64.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64.

impl<T: FromPrimitive> FromPrimitive for DualNumber<T> where
    T: Zero, 

fn from_isize(n: isize) -> Option<DualNumber<T>>

Convert an isize to return an optional value of this type. If the value cannot be represented by this value, the None is returned.

fn from_i8(n: i8) -> Option<DualNumber<T>>

Convert an i8 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_i16(n: i16) -> Option<DualNumber<T>>

Convert an i16 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_i32(n: i32) -> Option<DualNumber<T>>

Convert an i32 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_i64(n: i64) -> Option<DualNumber<T>>

Convert an i64 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_usize(n: usize) -> Option<DualNumber<T>>

Convert a usize to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_u8(n: u8) -> Option<DualNumber<T>>

Convert an u8 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_u16(n: u16) -> Option<DualNumber<T>>

Convert an u16 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_u32(n: u32) -> Option<DualNumber<T>>

Convert an u32 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_u64(n: u64) -> Option<DualNumber<T>>

Convert an u64 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_f32(n: f32) -> Option<DualNumber<T>>

Convert a f32 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_f64(n: f64) -> Option<DualNumber<T>>

Convert a f64 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

impl<T: Num + Copy> Add<T> for DualNumber<T>

type Output = DualNumber<T>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> DualNumber<T>

Performs the + operation.

impl<T: Num + Copy> Sub<T> for DualNumber<T>

type Output = DualNumber<T>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> DualNumber<T>

Performs the - operation.

impl<T: Num + Copy> Mul<T> for DualNumber<T>

type Output = DualNumber<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> DualNumber<T>

Performs the * operation.

impl<T: Num + Copy> Div<T> for DualNumber<T>

type Output = DualNumber<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> DualNumber<T>

Performs the / operation.

impl<T: Signed + Copy> Neg for DualNumber<T>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: Num + Copy> Add<Self> for DualNumber<T>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Num + Copy> Sub<Self> for DualNumber<T>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Num + Copy> Mul<Self> for DualNumber<T>

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Num + Copy> Div<Self> for DualNumber<T>

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Num + Copy> Rem<Self> for DualNumber<T>

type Output = Self

The resulting type after applying the % operator.

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

UNIMPLEMENTED!!!

As far as I know, remainder is not a valid operation on dual numbers, but is required for the Float trait to be implemented.

impl<T> Signed for DualNumber<T> where
    T: Signed + Copy + PartialOrd, 

fn abs(&self) -> Self

Computes the absolute value.

fn abs_sub(&self, rhs: &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: Unsigned> Unsigned for DualNumber<T> where
    Self: Num, 

impl<T: Num + Zero + Copy> Zero for DualNumber<T>

fn zero() -> DualNumber<T>

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

impl<T: Num + One + Copy> One for DualNumber<T>

fn one() -> DualNumber<T>

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl<T: Num + Copy> Num for DualNumber<T>

type FromStrRadixErr = <T as Num>::FromStrRadixErr

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

Convert from a string and radix <= 36.

impl<T: Float> NumCast for DualNumber<T>

fn from<N: ToPrimitive>(n: N) -> Option<DualNumber<T>>

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait.

impl<T: FloatConst + Zero> FloatConst for DualNumber<T>

fn E() -> DualNumber<T>

Return Euler’s number.

fn FRAC_1_PI() -> DualNumber<T>

Return 1.0 / π.

fn FRAC_1_SQRT_2() -> DualNumber<T>

Return 1.0 / sqrt(2.0).

fn FRAC_2_PI() -> DualNumber<T>

Return 2.0 / π.

fn FRAC_2_SQRT_PI() -> DualNumber<T>

Return 2.0 / sqrt(π).

fn FRAC_PI_2() -> DualNumber<T>

Return π / 2.0.

fn FRAC_PI_3() -> DualNumber<T>

Return π / 3.0.

fn FRAC_PI_4() -> DualNumber<T>

Return π / 4.0.

fn FRAC_PI_6() -> DualNumber<T>

Return π / 6.0.

fn FRAC_PI_8() -> DualNumber<T>

Return π / 8.0.

fn LN_10() -> DualNumber<T>

Return ln(10.0).

fn LN_2() -> DualNumber<T>

Return ln(2.0).

fn LOG10_E() -> DualNumber<T>

Return log10(e).

fn LOG2_E() -> DualNumber<T>

Return log2(e).

fn PI() -> DualNumber<T>

Return Archimedes’ constant.

fn SQRT_2() -> DualNumber<T>

Return sqrt(2.0).

impl<T> Float for DualNumber<T> where
    T: Float + Signed + FloatConst, 

fn nan() -> Self

Returns the NaN value.

fn infinity() -> Self

Returns the infinite value.

fn neg_infinity() -> Self

Returns the negative infinite value.

fn neg_zero() -> Self

Returns -0.0.

fn min_positive_value() -> Self

Returns the smallest positive, normalized value that this type can represent.

fn epsilon() -> Self

Returns epsilon, a small positive value.

fn min_value() -> Self

Returns the smallest finite value that this type can represent.

fn max_value() -> Self

Returns the largest finite value that this type can represent.

fn is_nan(self) -> bool

Returns true if this value is NaN and false otherwise.

fn is_infinite(self) -> bool

Returns true if this value is positive infinity or negative infinity and false otherwise.

fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, [subnormal][subnormal], or NaN.

fn is_sign_positive(self) -> bool

Returns true if self is positive, including +0.0, Float::infinity(), and since Rust 1.20 also Float::nan().

fn is_sign_negative(self) -> bool

Returns true if self is negative, including -0.0, Float::neg_infinity(), and since Rust 1.20 also -Float::nan().

fn classify(self) -> FpCategory

Returns the floating point category of the number. If only one property is going to be tested, it is generally faster to use the specific predicate instead.

fn floor(self) -> Self

Returns the largest integer less than or equal to a number.

fn ceil(self) -> Self

Returns the smallest integer greater than or equal to a number.

fn round(self) -> Self

Returns the nearest integer to a number. Round half-way cases away from 0.0.

fn trunc(self) -> Self

Return the integer part of a number.

fn fract(self) -> Self

Returns the fractional part of a number.

fn signum(self) -> Self

Returns a number that represents the sign of self.

fn abs(self) -> Self

Computes the absolute value of self. Returns Float::nan() if the number is Float::nan().

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

Returns the maximum of the two numbers.

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

Returns the minimum of the two numbers.

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

The positive difference of two numbers.

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

Fused multiply-add. Computes (self * a) + b with only one rounding error. This produces a more accurate result with better performance than a separate multiplication operation followed by an add.

fn recip(self) -> Self

Take the reciprocal (inverse) of a number, 1/x.

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

Raise a number to an integer power.

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

Raise a number to a floating point power.

fn exp(self) -> Self

Returns e^(self), (the exponential function).

fn exp2(self) -> Self

Returns 2^(self).

fn ln(self) -> Self

Returns the natural logarithm of the number.

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

Returns the logarithm of the number with respect to an arbitrary base.

fn log2(self) -> Self

Returns the base 2 logarithm of the number.

fn log10(self) -> Self

Returns the base 10 logarithm of the number.

fn sqrt(self) -> Self

Take the square root of a number.

fn cbrt(self) -> Self

Take the cubic root of a number.

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

Calculate the length of the hypotenuse of a right-angle triangle given legs of length x and y.

fn sin(self) -> Self

Computes the sine of a number (in radians).

fn cos(self) -> Self

Computes the cosine of a number (in radians).

fn tan(self) -> Self

Computes the tangent of a number (in radians).

fn asin(self) -> Self

Computes the arcsine of a number. Return value is in radians in the range [-pi/2, pi/2] or NaN if the number is outside the range [-1, 1].

fn acos(self) -> Self

Computes the arccosine of a number. Return value is in radians in the range [0, pi] or NaN if the number is outside the range [-1, 1].

fn atan(self) -> Self

Computes the arctangent of a number. Return value is in radians in the range [-pi/2, pi/2];

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

Computes the four quadrant arctangent of self (y) and other (x).

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

Simultaneously computes the sine and cosine of the number, x. Returns (sin(x), cos(x)).

fn exp_m1(self) -> Self

Returns e^(self) - 1 in a way that is accurate even if the number is close to zero.

fn ln_1p(self) -> Self

Returns ln(1+n) (natural logarithm) more accurately than if the operations were performed separately.

fn sinh(self) -> Self

Hyperbolic sine function.

fn cosh(self) -> Self

Hyperbolic cosine function.

fn tanh(self) -> Self

Hyperbolic tangent function.

fn asinh(self) -> Self

Inverse hyperbolic sine function.

fn acosh(self) -> Self

Inverse hyperbolic cosine function.

fn atanh(self) -> Self

Inverse hyperbolic tangent function.

fn integer_decode(self) -> (u64, i16, i8)

Returns the mantissa, base 2 exponent, and sign as integers, respectively. The original number can be recovered by sign * mantissa * 2 ^ exponent.

fn to_degrees(self) -> Self

Converts radians to degrees.

fn to_radians(self) -> Self

Converts degrees to radians.