Struct RootFinderBuilder

Source
pub struct RootFinderBuilder<'a> { /* private fields */ }
Expand description

Builder pattern for RootFinder configuration.

Implementations§

Source§

impl<'a> RootFinderBuilder<'a>

Source

pub fn new(method: RootFindingMethod) -> Self

Creates a new instance of RootFinderBuilder.

Source

pub fn initial_guess(self, guess: f64) -> Self

Sets the initial guess for methods that require one (e.g., Newton-Raphson).

Source

pub fn boundaries(self, x0: f64, x1: f64) -> Self

Sets the boundaries for methods that require bounded intervals (e.g., Bisection).

Source

pub fn tolerance(self, tol: f64) -> Self

Sets the tolerance for the root-finding process.

Source

pub fn max_iterations(self, max: usize) -> Self

Sets the maximum number of iterations.

Source

pub fn log_convergence(self, log: bool) -> Self

Enables or disables logging of convergence steps.

Source

pub fn function(self, function: &'a dyn Fn(f64) -> f64) -> Self

Sets the target function to be used by the root finder.

Source

pub fn derivative(self, derivative: &'a dyn Fn(f64) -> f64) -> Self

Sets the derivative of the target function (required for Newton-Raphson).

Source

pub fn build(self) -> Result<RootFindingIterationDecorator<'a>, String>

Builds and returns the RootFinder instance.

Auto Trait Implementations§

§

impl<'a> Freeze for RootFinderBuilder<'a>

§

impl<'a> !RefUnwindSafe for RootFinderBuilder<'a>

§

impl<'a> !Send for RootFinderBuilder<'a>

§

impl<'a> !Sync for RootFinderBuilder<'a>

§

impl<'a> Unpin for RootFinderBuilder<'a>

§

impl<'a> !UnwindSafe for RootFinderBuilder<'a>

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<U> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.