Struct newton_rootfinder::residuals::JacobianValues

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

Residuals jacobian values outputs of the model

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

It is containing arrays of:

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

The jacobian of the left and right members are required, as the output jacobian value depends of the normalization method and both members are required to compute it

Implementations

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

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

pub fn normalize(
    &self,
    res_values: &ResidualsValues<D>,
    norm_methods: &[NormalizationMethod]
) -> OMatrix<f64, D, D>

pub fn get_jacobians(&self) -> (&OMatrix<f64, D, D>, &OMatrix<f64, D, D>)

Trait Implementations

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

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

Formats the value using the given formatter.