Struct peroxide::structure::dual::Dual

pub struct Dual { /* fields omitted */ }

Dual - Structure for AD

Fields

x: f64 : value dx: f64 : slope at x

But they are private fields. You should use value or slope function to extract them.

Methods

impl Dual

pub fn new<T: Into<f64> + Copy>(x: T, dx: T) -> Dual

Syntactic sugar to declare dual

Type

(T, T) -> Dual where T: Into<f64> + Copy

Examples

extern crate peroxide;
use peroxide::*;

let a = Dual::new(2, 1); // y = x at x = 2
a.print();

pub fn value(&self) -> f64

Just extract value

pub fn slope(&self) -> f64

Just extract slope

pub fn extract(&self) -> (f64, f64)

Just extract both

Trait Implementations

impl Printable for Dual

fn print(&self)

impl PowOps for Dual

Power for Dual

type Output = Dual

fn pow(&self, n: usize) -> Dual

fn powf(&self, f: f64) -> Dual

fn sqrt(&self) -> Dual

impl TrigOps for Dual

Trigonometric function with Dual

type Output = Dual

fn sin(&self) -> Dual

fn cos(&self) -> Dual

fn tan(&self) -> Dual

impl ExpLogOps for Dual

Exponential & Logarithm for Dual

type Output = Dual

fn exp(&self) -> Dual

fn ln(&self) -> Dual

impl Copy for Dual

impl Default for Dual

fn default() -> Dual

Returns the "default value" for a type.

impl Clone for Dual

fn clone(&self) -> Dual

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Dual

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

Formats the value using the given formatter.

impl Debug for Dual

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

Formats the value using the given formatter.

impl Sub<Dual> for Dual

Sub for Dual

type Output = Dual

The resulting type after applying the - operator.

fn sub(self, other: Dual) -> Dual

Performs the - operation.

impl Sub<f64> for Dual

type Output = Dual

The resulting type after applying the - operator.

fn sub(self, other: f64) -> Dual

Performs the - operation.

impl Sub<Dual> for f64

type Output = Dual

The resulting type after applying the - operator.

fn sub(self, other: Dual) -> Dual

Performs the - operation.

impl Add<Dual> for Dual

Add for Dual

type Output = Dual

The resulting type after applying the + operator.

fn add(self, other: Dual) -> Dual

Performs the + operation.

impl Add<f64> for Dual

type Output = Dual

The resulting type after applying the + operator.

fn add(self, other: f64) -> Dual

Performs the + operation.

impl Add<Dual> for f64

type Output = Dual

The resulting type after applying the + operator.

fn add(self, other: Dual) -> Dual

Performs the + operation.

impl Mul<Dual> for Dual

Mul for Dual

type Output = Dual

The resulting type after applying the * operator.

fn mul(self, other: Dual) -> Dual

Performs the * operation.

impl Mul<f64> for Dual

type Output = Dual

The resulting type after applying the * operator.

fn mul(self, other: f64) -> Dual

Performs the * operation.

impl Mul<Dual> for f64

type Output = Dual

The resulting type after applying the * operator.

fn mul(self, other: Dual) -> Dual

Performs the * operation.

impl Div<Dual> for Dual

Div for Dual

type Output = Dual

The resulting type after applying the / operator.

fn div(self, other: Dual) -> Dual

Performs the / operation.

impl Div<f64> for Dual

type Output = Dual

The resulting type after applying the / operator.

fn div(self, other: f64) -> Dual

Performs the / operation.

impl Div<Dual> for f64

type Output = Dual

The resulting type after applying the / operator.

fn div(self, other: Dual) -> Dual

Performs the / operation.

impl Neg for Dual

Neg for Dual

type Output = Dual

The resulting type after applying the - operator.

fn neg(self) -> Dual

Performs the unary - operation.