Struct peroxide::numerical::root::RootFinder

pub struct RootFinder<F: Fn(AD) -> AD> { /* private fields */ }

Structure for Root finding

Implementations

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

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::new(init, Bisection, f)?;
    let x = a.find_root()?;
    x.print();
    Ok(())
}

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

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

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 get_times(&self) -> usize

Get max iteration times

pub fn get_tol(&self) -> f64

Get tolerance

pub fn get_method(&self) -> RootFind

Get method

pub fn get_curr(&self) -> &RootState

Get current RootState

pub fn check_find(&self) -> RootBool

Check if find root

pub fn update(&mut self)

Update RootFinder

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

Find Root

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.