Struct peroxide::numerical::root::RootFinder

source · [−]

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

Expand description

Structure for Root finding

Fields

curr: RootState

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 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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<F> RefUnwindSafe for RootFinder<F> where
F: RefUnwindSafe,

impl<F> Send for RootFinder<F> where
F: Send,

impl<F> Sync for RootFinder<F> where
F: Sync,

impl<F> Unpin for RootFinder<F>

impl<F> UnwindSafe for RootFinder<F> where
F: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V