pub struct GlobalGaussNewtonIterationMetrics { /* private fields */ }Expand description
Numerical work reported by one global Gauss–Newton object update.
Implementations§
Source§impl GlobalGaussNewtonIterationMetrics
impl GlobalGaussNewtonIterationMetrics
Sourcepub fn conjugate_gradient_iterations(&self) -> usize
pub fn conjugate_gradient_iterations(&self) -> usize
Returns the number of matrix-free conjugate-gradient iterations used.
Sourcepub fn linear_residual_ratio(&self) -> f64
pub fn linear_residual_ratio(&self) -> f64
Returns the final linear residual norm divided by its initial norm.
Sourcepub fn line_search_evaluations(&self) -> usize
pub fn line_search_evaluations(&self) -> usize
Returns the number of full-data trial-objective evaluations.
Sourcepub fn accepted_step_scale(&self) -> f64
pub fn accepted_step_scale(&self) -> f64
Returns the accepted multiplier applied to the Gauss–Newton direction.
Sourcepub fn gradient_norm(&self) -> f64
pub fn gradient_norm(&self) -> f64
Returns the Euclidean norm of J^T r at the pre-update object.
Trait Implementations§
Source§impl AlgorithmIterationMetrics for GlobalGaussNewtonIterationMetrics
impl AlgorithmIterationMetrics for GlobalGaussNewtonIterationMetrics
Source§fn merge(&mut self, other: Self)
fn merge(&mut self, other: Self)
Deterministically accumulates metrics from another batch in schedule order.
Source§fn append_records(
&self,
iteration: usize,
output: &mut Vec<AlgorithmMetricRecord>,
)
fn append_records( &self, iteration: usize, output: &mut Vec<AlgorithmMetricRecord>, )
Appends stable scalar records for a one-based completed
iteration.Source§impl Clone for GlobalGaussNewtonIterationMetrics
impl Clone for GlobalGaussNewtonIterationMetrics
Source§fn clone(&self) -> GlobalGaussNewtonIterationMetrics
fn clone(&self) -> GlobalGaussNewtonIterationMetrics
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Default for GlobalGaussNewtonIterationMetrics
impl Default for GlobalGaussNewtonIterationMetrics
Source§fn default() -> GlobalGaussNewtonIterationMetrics
fn default() -> GlobalGaussNewtonIterationMetrics
Returns the “default value” for a type. Read more
impl Copy for GlobalGaussNewtonIterationMetrics
Auto Trait Implementations§
impl Freeze for GlobalGaussNewtonIterationMetrics
impl RefUnwindSafe for GlobalGaussNewtonIterationMetrics
impl Send for GlobalGaussNewtonIterationMetrics
impl Sync for GlobalGaussNewtonIterationMetrics
impl Unpin for GlobalGaussNewtonIterationMetrics
impl UnsafeUnpin for GlobalGaussNewtonIterationMetrics
impl UnwindSafe for GlobalGaussNewtonIterationMetrics
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 more