pub struct DiagnosticCollector { /* private fields */ }Expand description
Diagnostic collector for gathering convergence information
Implementations§
Source§impl DiagnosticCollector
impl DiagnosticCollector
Sourcepub fn new(options: DiagnosticOptions) -> Self
pub fn new(options: DiagnosticOptions) -> Self
Create a new diagnostic collector
Sourcepub fn record_iteration(
&mut self,
f_value: f64,
grad: &ArrayView1<'_, f64>,
step: &ArrayView1<'_, f64>,
direction: &ArrayView1<'_, f64>,
line_search_info: LineSearchDiagnostic,
)
pub fn record_iteration( &mut self, f_value: f64, grad: &ArrayView1<'_, f64>, step: &ArrayView1<'_, f64>, direction: &ArrayView1<'_, f64>, line_search_info: LineSearchDiagnostic, )
Record an iteration
Sourcepub fn finalize(self) -> ConvergenceDiagnostics
pub fn finalize(self) -> ConvergenceDiagnostics
Finalize and produce complete diagnostics
Trait Implementations§
Auto Trait Implementations§
impl Freeze for DiagnosticCollector
impl RefUnwindSafe for DiagnosticCollector
impl Send for DiagnosticCollector
impl Sync for DiagnosticCollector
impl Unpin for DiagnosticCollector
impl UnwindSafe for DiagnosticCollector
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§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 moreSource§fn 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).Source§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.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.