Struct newton_rootfinder::residuals::ResidualsValues

pub struct ResidualsValues<D>where
    D: Dim,
    DefaultAllocator: Allocator<f64, D>,{ /* private fields */ }

Residuals values outputs of the model

This is the expected output of the model in order to be able to interact with the solver

It is containing arrays of:

• the left members of the equations
• the right members of the equations

Once converged, one should have left = right (with a tolerance)

Implementations

impl<D> ResidualsValues<D>where
    D: Dim,
    DefaultAllocator: Allocator<f64, D>,

pub fn new(left: OVector<f64, D>, right: OVector<f64, D>) -> Self

pub fn len(&self) -> usize

pub fn get_values(&self, index: usize) -> (f64, f64)

pub fn shape(&self) -> D

pub fn get_values_str_eq(&self, index: usize, float_width: usize) -> String

Trait Implementations

impl<D: Debug> Debug for ResidualsValues<D>where
    D: Dim,
    DefaultAllocator: Allocator<f64, D>,

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

Formats the value using the given formatter.

impl<D> Display for ResidualsValues<D>where
    D: Dim,
    DefaultAllocator: Allocator<f64, D>,

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

Formats the value using the given formatter.