pub struct LeastSquareInitReport {
pub violation_initial: Number,
pub violation_final: Number,
pub step_norm: Number,
pub alpha: Number,
pub rejected_trials: Index,
pub termination: &'static str,
}Expand description
What the safeguarded least-square initializer did. Returned by
DefaultIterateInitializer::safeguarded_least_square_x and
readable after the solve through
crate::application::IpoptApplication::least_square_init_report,
so a starting point that silently got worse is visible somewhere
other than the iteration count. It is primarily a programmatic
accessor; since gh#616 the same fields are also emitted once per
solve at debug level on the pounce::algorithm target, so a
fixture sweep can attribute a moving model without a source patch
(RUST_LOG=pounce::algorithm=debug). Nothing prints it at the
default log level.
Fields§
§violation_initial: NumberNonlinear violation at the user’s x0, after the interior push.
violation_final: NumberNonlinear violation at the point actually handed to the
algorithm. Equal to violation_initial when nothing was
accepted.
step_norm: Numberalpha * ||x_ls - x0||_2 for the accepted trial; 0 if none was.
alpha: NumberStep fraction of the accepted trial; 0 if none was.
rejected_trials: IndexBacktracking trials whose true violation failed the test.
termination: &'static strWhy the safeguard stopped.
Trait Implementations§
Source§impl Clone for LeastSquareInitReport
impl Clone for LeastSquareInitReport
Source§fn clone(&self) -> LeastSquareInitReport
fn clone(&self) -> LeastSquareInitReport
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for LeastSquareInitReport
impl Debug for LeastSquareInitReport
Source§impl Default for LeastSquareInitReport
impl Default for LeastSquareInitReport
Source§fn default() -> LeastSquareInitReport
fn default() -> LeastSquareInitReport
Auto Trait Implementations§
impl Freeze for LeastSquareInitReport
impl RefUnwindSafe for LeastSquareInitReport
impl Send for LeastSquareInitReport
impl Sync for LeastSquareInitReport
impl Unpin for LeastSquareInitReport
impl UnsafeUnpin for LeastSquareInitReport
impl UnwindSafe for LeastSquareInitReport
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T, U> Imply<T> for U
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
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> ⓘ
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> ⓘ
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