Struct newton_rootfinder::iteratives::Iteratives
source · [−]pub struct Iteratives<'a, T: Iterative> { /* private fields */ }Expand description
A slice of iteratives
This struct is used as a wrapper to act on a slice of several iteratives
It provides the same method as the Iterative trait with the plural suffix:
step_limitationscompute_perturbations
Implementations
sourceimpl<'a, T> Iteratives<'a, T>where
T: Iterative,
impl<'a, T> Iteratives<'a, T>where
T: Iterative,
pub fn new(iteratives_params: &'a [T]) -> Self
pub fn len(&self) -> usize
sourcepub fn step_limitations<D>(
&self,
values: &OVector<f64, D>,
raw_step: &OVector<f64, D>
) -> OVector<f64, D>where
D: Dim,
DefaultAllocator: Allocator<f64, D>,
pub fn step_limitations<D>(
&self,
values: &OVector<f64, D>,
raw_step: &OVector<f64, D>
) -> OVector<f64, D>where
D: Dim,
DefaultAllocator: Allocator<f64, D>,
Compute a limited step for several iteratives
Return the new value after the application of the step limitation (and not the step).
This is required as it can be limited by an interval for the iteratives.
sourcepub fn compute_perturbations<D>(
&self,
iterative_values: &OVector<f64, D>
) -> OVector<f64, D>where
D: Dim,
DefaultAllocator: Allocator<f64, D>,
pub fn compute_perturbations<D>(
&self,
iterative_values: &OVector<f64, D>
) -> OVector<f64, D>where
D: Dim,
DefaultAllocator: Allocator<f64, D>,
Compute the perturbation for several iteratives
Trait Implementations
sourceimpl<'a, T> Debug for Iteratives<'a, T>where
T: Iterative + Debug,
impl<'a, T> Debug for Iteratives<'a, T>where
T: Iterative + Debug,
Auto Trait Implementations
impl<'a, T> RefUnwindSafe for Iteratives<'a, T>where
T: RefUnwindSafe,
impl<'a, T> Send for Iteratives<'a, T>where
T: Sync,
impl<'a, T> Sync for Iteratives<'a, T>where
T: Sync,
impl<'a, T> Unpin for Iteratives<'a, T>
impl<'a, T> UnwindSafe for Iteratives<'a, T>where
T: RefUnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read morefn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.