Module newton_rootfinder::iteratives

This module defines the iteratives variables

Iteratives variables are defined through the Iterative trait

Two kind of iterative variables are provided :

• IterativeParams
• IterativeParamsFD that extends the previous one to work with finite-difference

The struct Iteratives (plural) is holding the array or vector of the previous parameters and is the one that will be used by the solver

It is possible to create default iteratives variables with the following lines:

Examples

use newton_rootfinder as nrf;
use nrf::iteratives::{Iteratives, IterativeParams, IterativeParamsFD};

let size = 5;
let my_iters_fd = Iteratives::new(&vec![IterativeParamsFD::default(); size]);
let my_iters = Iteratives::new(&vec![IterativeParams::default(); size]);

Structs

IterativeParams

The parameters of an iterative variable

IterativeParamsFD

Extension of iteratives. FD stands for Finite-Difference

Iteratives

A slice of iteratives

Enums

PerturbationMethod

Perturbation method used for the compute_perturbation() method from the Iterative trait by the IterativeParamsFD struct

Traits

Iterative

Iterative definition

Functions

default_vec_iteratives

Constructor with default values for iteratives parameters

default_vec_iteratives_fd

Constructor with default values for iteratives parameters with finite-differences