Struct peroxide::numerical::root::NewtonMethod

source ·

pub struct NewtonMethod {
    pub max_iter: usize,
    pub tol: f64,
}

Expand description

Newton method

§Type for `RootFinder`

I: 1
O: 1
T: f64

§Arguments

max_iter: Maximum number of iterations
tol: Absolute tolerance

§Caution

The function should be differentiable
This method highly depends on the initial guess
This method is not guaranteed to converge

Fields§

§max_iter: usize§tol: f64

Trait Implementations§

source §

fn find<P: RootFindingProblem<1, 1, f64>>( &self, problem: &P, ) -> Result<[f64; 1]>

Auto Trait Implementations§

§

impl Freeze for NewtonMethod

§

impl RefUnwindSafe for NewtonMethod

§

impl Send for NewtonMethod

§

impl Sync for NewtonMethod

§

impl Unpin for NewtonMethod

§

impl UnwindSafe for NewtonMethod

Blanket Implementations§

source §

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

source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source §

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

source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source §

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

source §

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

Mutably borrows from an owned value. Read more

source §

impl<T> From<T> for T

source §

fn from(t: T) -> T

Returns the argument unchanged.

source §

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

source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source §

impl<T> IntoEither for T

source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§