Trait roots::Convergency

pub trait Convergency<F: FloatType> {
    fn is_root_found(&mut self, y: F) -> bool;
    fn is_converged(&mut self, x1: F, x2: F) -> bool;
    fn is_iteration_limit_reached(&mut self, iter: usize) -> bool;
}

The way to check if the algorithm has finished by either finding a root or reaching the iteration limit.

Required methods

fn is_root_found(&mut self, y: F) -> bool

Return true if the given Y value is close enough to the zero

fn is_converged(&mut self, x1: F, x2: F) -> bool

Return true if given x values are close enough to each other

fn is_iteration_limit_reached(&mut self, iter: usize) -> bool

Return true if no more iterations desired

Loading content...

Implementors

impl<F: FloatType + Display + LowerExp> Convergency<F> for DebugConvergency<F>

fn is_root_found(&mut self, y: F) -> bool

Prints the value being checked

fn is_converged(&mut self, x1: F, x2: F) -> bool

Prints values being checked

fn is_iteration_limit_reached(&mut self, iter: usize) -> bool

Updates internal iteration counter

impl<F: FloatType> Convergency<F> for SimpleConvergency<F>

fn is_root_found(&mut self, y: F) -> bool

fn is_converged(&mut self, x1: F, x2: F) -> bool

fn is_iteration_limit_reached(&mut self, iter: usize) -> bool

impl<F: FloatType> Convergency<F> for F

fn is_root_found(&mut self, y: F) -> bool

Return true if the given Y value is close enough to the zero

fn is_converged(&mut self, x1: F, x2: F) -> bool

Return true if given x values are close enough to each other

fn is_iteration_limit_reached(&mut self, iter: usize) -> bool

Return true if no more iterations desired

Loading content...