Struct newton_rootfinder::residuals::ResidualsConfig [−][src]
pub struct ResidualsConfig<'a> { /* fields omitted */ }Expand description
Residuals configuration used by the solver
The solver is using directly two slices to perform its calculation
- the
update_methodsused for computing the jacobian - the
stopping_criteriasused to control if another iteration is performed
It is possible to used a Vec<ResidualConfig> to create such a struct thanks to the convert_into_vecs() method.
However, if the performance is critical for the user,
it should create is own arrays to feed to the new() constructor
and not use ResidualConfig (singular)
Implementations
pub fn new(
stopping_criterias: &'a [NormalizationMethod],
update_methods: &'a [NormalizationMethod]
) -> Self
pub fn convert_into_vecs(
residuals_config: Vec<ResidualConfig>
) -> (Vec<NormalizationMethod>, Vec<NormalizationMethod>)
pub fn convert_into_vecs(
residuals_config: Vec<ResidualConfig>
) -> (Vec<NormalizationMethod>, Vec<NormalizationMethod>)
Method to generate the vector of stopping_criteras and update_methods from a vector of ResidualConfig
pub fn evaluate_update_residuals<D>(
&self,
values: &ResidualsValues<D>
) -> OVector<f64, D> where
D: Dim,
DefaultAllocator: Allocator<f64, D>,
pub fn evaluate_update_residuals<D>(
&self,
values: &ResidualsValues<D>
) -> OVector<f64, D> where
D: Dim,
DefaultAllocator: Allocator<f64, D>,
Evaluation of the value of the update residuals thanks to the normalization() function
pub fn evaluate_stopping_residuals<D>(
&self,
values: &ResidualsValues<D>
) -> OVector<f64, D> where
D: Dim,
DefaultAllocator: Allocator<f64, D>,
pub fn evaluate_stopping_residuals<D>(
&self,
values: &ResidualsValues<D>
) -> OVector<f64, D> where
D: Dim,
DefaultAllocator: Allocator<f64, D>,
Evaluation of the value of the stopping residuals thanks to the normalization() function
pub fn get_update_methods(&self) -> &'a [NormalizationMethod]ⓘ
Trait Implementations
This method tests for self and other values to be equal, and is used
by ==. Read more
This method tests for !=.
Auto Trait Implementations
impl<'a> RefUnwindSafe for ResidualsConfig<'a>
impl<'a> Send for ResidualsConfig<'a>
impl<'a> Sync for ResidualsConfig<'a>
impl<'a> Unpin for ResidualsConfig<'a>
impl<'a> UnwindSafe for ResidualsConfig<'a>
Blanket Implementations
Mutably borrows from an owned value. Read more
The inverse inclusion map: attempts to construct self from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self is actually part of its subset T (and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self to the equivalent element of its superset.