Struct peroxide::numerical::root::RootFinder

pub struct RootFinder<F: Fn(T) -> T, T: AD> {
    pub curr: RootState,
    // some fields omitted
}

Structure for Root finding

• Caution: T $\geq$ AD1

Fields

curr: RootState

Implementations

impl<F: Fn(T) -> T, T: AD> RootFinder<F, T>

pub fn new(init: RootState, method: RootFind, f: F) -> Result<Self, RootError>

Create RootFinder

Default Options

• Times: 100
• Tolerance: 1e-10

Usage

extern crate peroxide;
use peroxide::fuga::*;

fn main() -> Result<(), RootError> {
    let init = RootState::I(1f64, 3f64);
    let mut a = RootFinder::<_, AD1>::new(init, Bisection, f)?;
    let x = a.find_root()?;
    x.print();
    Ok(())
}

fn f<T: AD>(x: T) -> T {
    x.powi(2) - 4f64
}

pub fn f(&self, x: T) -> T

pub fn condition_number(&self) -> f64

Condition number

pub fn set_times(&mut self, times: usize) -> &mut Self

Set max iteration times

pub fn set_tol(&mut self, tol: f64) -> &mut Self

Set tolerance

pub fn update(&mut self)

Update RootFinder

pub fn find_root(&mut self) -> Result<f64, RootError>

Find Root

Trait Implementations

impl<F: Clone + Fn(T) -> T, T: Clone + AD> Clone for RootFinder<F, T>

fn clone(&self) -> RootFinder<F, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Fn(T) -> T, T: Debug + AD> Debug for RootFinder<F, T>

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

Formats the value using the given formatter.