Struct ADFn 

pub struct ADFn<F> { /* private fields */ }

Generic AD function wrapper.

Lifts a function F: Fn(Jet<2>) -> Jet<2> to operate at multiple levels:

• call_stable(f64) → f64: evaluate function value, first derivative, or second derivative
• call_stable(Jet<2>) → Jet<2>: pass through

For vector functions, also lifts F: Fn(Vec<Jet<1>>) -> Vec<Jet<1>>.

Examples

use peroxide::fuga::*;

let f_ad = ADFn::new(|x: Jet<2>| x.powi(2));

// Value: f(3) = 9
assert_eq!(f_ad.call_stable(3.0), 9.0);

// Gradient: f'(3) = 6  (2*3)
let df = f_ad.grad();
assert_eq!(df.call_stable(3.0), 6.0);

// Hessian: f''(3) = 2
let ddf = df.grad();
assert_eq!(ddf.call_stable(3.0), 2.0);

Implementations

impl<F: Clone> ADFn<F>

pub fn new(f: F) -> Self

Create a new ADFn wrapping function f at gradient level 0 (function evaluation).

pub fn grad(&self) -> Self

Produce the gradient version of this function (increments grad_level by 1). Panics if grad_level >= 2.

Trait Implementations

impl<'a, F: Fn(&Vec<Jet<1>>) -> Vec<Jet<1>>> StableFn<&'a Vec<Jet<1>>> for ADFn<F>

Vector version: F works with &Vec<Jet<1>>, target is &Vec<Jet<1>>.

type Output = Vec<Jet<1>>

fn call_stable(&self, target: &'a Vec<Jet<1>>) -> Vec<Jet<1>>

impl<'a, F: Fn(&Vec<Jet<1>>) -> Vec<Jet<1>>> StableFn<&'a Vec<f64>> for ADFn<F>

Vector version: F works with &Vec<Jet<1>>, target is &Vec<f64>.

type Output = Vec<f64>

fn call_stable(&self, target: &'a Vec<f64>) -> Vec<f64>

impl<F: Fn(Jet<2>) -> Jet<2>> StableFn<Jet<2>> for ADFn<F>

Scalar version: F works with Jet<2>, target is Jet<2>.

type Output = Jet<2>

fn call_stable(&self, target: Jet<2>) -> Jet<2>

impl<F: Fn(Vec<Jet<1>>) -> Vec<Jet<1>>> StableFn<Vec<Jet<1>>> for ADFn<F>

Vector version: F works with Vec<Jet<1>>, target is Vec<Jet<1>>.

type Output = Vec<Jet<1>>

fn call_stable(&self, target: Vec<Jet<1>>) -> Vec<Jet<1>>

impl<F: Fn(Vec<Jet<1>>) -> Vec<Jet<1>>> StableFn<Vec<f64>> for ADFn<F>

Vector version: F works with Vec<Jet<1>>, target is Vec<f64>.

type Output = Vec<f64>

fn call_stable(&self, target: Vec<f64>) -> Vec<f64>

impl<F: Fn(Jet<2>) -> Jet<2>> StableFn<f64> for ADFn<F>

Scalar version: F works with Jet<2>, target is f64.

type Output = f64

fn call_stable(&self, target: f64) -> f64