Skip to main content

LbfgsDiagnostics

Struct LbfgsDiagnostics 

Source
pub struct LbfgsDiagnostics {
    pub pairs_accepted: usize,
    pub pairs_curvature_rejected: usize,
    pub pairs_evicted_by_memory: usize,
    pub gamma_clamp_hits: usize,
    pub line_search_backtracks: usize,
}
Expand description

Counters surfaced by the L-BFGS solver.

Fields§

§pairs_accepted: usize

Number of (s, y) curvature pairs that passed the Cauchy-Schwarz filter sy > F::epsilon() · sqrt(ss · yy) and entered the history buffer.

§pairs_curvature_rejected: usize

Number of curvature pairs rejected by the filter sy > F::epsilon() · sqrt(ss · yy) (negative or near-zero curvature, i.e. cosine angle near 0 between s and y).

§pairs_evicted_by_memory: usize

Number of evict-then-push events: a new accepted pair was added while the history buffer was already at config.memory, so the oldest pair was dropped. With the FIFO eviction policy used here, the invariant `pairs_evicted_by_memory == max(0, pairs_accepted

  • config.memory)` holds exactly at termination.
§gamma_clamp_hits: usize

Number of iterations where the initial L-BFGS gamma was clamped to the open range (1e-3, 1e3) (i.e. raw_gamma was strictly outside) or substituted with 1.0 because sy/yy was non-finite. A raw_gamma exactly equal to a clamp boundary is not counted.

§line_search_backtracks: usize

Total Armijo line-search trial points beyond the first per outer iteration, summed across all iterations. A high value relative to iterations signals the search direction is poorly scaled.

Trait Implementations§

Source§

impl Clone for LbfgsDiagnostics

Source§

fn clone(&self) -> LbfgsDiagnostics

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for LbfgsDiagnostics

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for LbfgsDiagnostics

Source§

fn default() -> LbfgsDiagnostics

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

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

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.