[−][src]Enum levenberg_marquardt::TerminationReason
Reasons for terminating the minimization.
Variants
User(&'static str)
The residual or Jacobian computation was not successful, it returned None
.
Numerical(&'static str)
Encountered NaN
or $\pm\infty$
.
The residuals are literally zero.
The residuals vector and the Jacobian columns are almost orthogonal.
This is the gtol
termination criterion.
The ftol
or xtol
criterion was fulfilled.
NoImprovementPossible(&'static str)
The bound for ftol
, xtol
or gtol
was set so low that the
test passed with the machine epsilon but not with the actual
bound. This means you must increase the bound.
Maximum number of function evaluations was hit.
The number of parameters $n$
is zero.
The number of residuals $m$
is zero.
WrongDimensions(&'static str)
The shape of the computed residuals or Jacobian is not correct.
Implementations
impl TerminationReason
[src]
pub fn was_successful(&self) -> bool
[src]
Compute whether the outcome is considered successful.
This does not necessarily mean we have a minimizer. Some termination criteria are approximations for necessary optimality conditions or check limitations due to floating point arithmetic.
pub fn was_usage_issue(&self) -> bool
[src]
A fundamental assumptions was not met.
For example if the number of residuals changed.
Trait Implementations
impl Debug for TerminationReason
[src]
impl Eq for TerminationReason
[src]
impl PartialEq<TerminationReason> for TerminationReason
[src]
pub fn eq(&self, other: &TerminationReason) -> bool
[src]
pub fn ne(&self, other: &TerminationReason) -> bool
[src]
impl StructuralEq for TerminationReason
[src]
impl StructuralPartialEq for TerminationReason
[src]
Auto Trait Implementations
impl RefUnwindSafe for TerminationReason
impl Send for TerminationReason
impl Sync for TerminationReason
impl Unpin for TerminationReason
impl UnwindSafe for TerminationReason
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn is_in_subset(&self) -> bool
pub fn to_subset_unchecked(&self) -> SS
pub fn from_subset(element: &SS) -> SP
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,