[−][src]Module peroxide::structure::ad
Taylor mode forward automatic differentiation
Caution: In this documentation, {i} means number i (ex: AD{2} means AD2)
Important Features
- Can automatic differentiate up to 10th order (
AD1~AD10) - All
AD{i}are in stack (Guarantee high performance) - You can see
AD{i}via.print() - You can use n-th derivative value of
AD{i}via.d{i}
Implemented Traits for AD{i}
#[derive(Debug, Copy, Clone, PartialEq, Default)]std::fmt::DisplayFrom<AD{j}>,From<&'a AD{j}>IntoIterator<Item = f64>FromIterator<f64>Index,IndexMutstd::ops::{Neg, Add, Sub, Mul, Div}peroxide::traits::num::{PowOps, ExpLogOps, TrigOps}
Iterator of AD{i}
There are three iterators.
ADIntoIter{i}ADIter{i}<'a>ADIterMut{i}<'a>
Each implements DoubleEndedIterator, ExactSizeIterator also.
Methods
new(d0: f64, ... , d{i}: f64) -> AD{i}print(&self)iter(&self) -> ADIter{i}iter_mut(&self) -> ADIterMut{i}len(&self) -> usize
Implemented Operations
Add, Sub, Mul, Divsin, cos, tansinh, cosh, tanhsin_cos,sinh_coshexp, ln, log, log2, log10powi, powf, sqrt
Not yet implemented
asin,acos,atanasinh,acosh,atanhpow
Usage
Construction
extern crate peroxide; use peroxide::fuga::*; fn main() { // Declare x where x = 2 let a = AD1::new(2f64, 1f64); // Declare x^2 where x = 2 let b = AD2::new(4f64, 4f64, 2f64); // Convert AD1 -> AD2 let c = AD2::from(a); // Zeros let d = AD2::default(); assert_eq!(c, AD2::new(2f64, 1f64, 0f64)); assert_eq!(d, AD2::new(0f64, 0f64, 0f64)); }
Operation
For every binary operation, it returns higher order AD (ex: AD1 + AD2 = AD2)
extern crate peroxide; use peroxide::fuga::*; fn main() { let a = AD1::new(2f64, 1f64); // x at x = 2 let b = AD2::new(4f64, 4f64, 2f64); // x^2 at x = 2 let c = a + b; // x^2 + x at x = 2 let d = a * b; // x^3 at x = 2 let e = a / b; // 1/x at x = 2 assert_eq!(c, AD2::new(6f64, 5f64, 2f64)); assert_eq!(d, AD2::new(8f64, 12f64, 12f64)); assert_eq!(e, AD2::new(0.5, -0.25, 0.25)); }
Generic
- All of
AD{i}implementsADtrait
extern crate peroxide; use peroxide::fuga::*; fn main() { let a = AD1::new(2f64, 1f64); let b = AD2::new(4f64, 4f64, 2f64); assert_eq!(f(a, b), AD1::new(6f64, 5f64)); } fn f<T: AD, S: AD>(x: T, y: S) -> T { T::from(x.to_ad2() + y.to_ad2()) }
Structs
Traits
| AD |