[−][src]Struct optimization_engine::core::SolverStatus
Solver status
This structure contais information about the solver status. Instances of
SolverStatus
are returned by optimizers.
Methods
impl SolverStatus
[src]
pub fn new(
converged: bool,
num_iter: usize,
fpr_norm: f64,
cost_value: f64
) -> SolverStatus
[src]
converged: bool,
num_iter: usize,
fpr_norm: f64,
cost_value: f64
) -> SolverStatus
Constructs a new instance of SolverStatus
Arguments
converged
whether the algorithm has converged to a solution up to the specified tolerancenum_iter
number of iterationsfpr_norm
norm of the fixed-point residual; a gauge of the solution qualitycost_value
the value of the cost function at the solution
pub fn has_converged(&self) -> bool
[src]
whether the algorithm has converged
pub fn get_number_iterations(&self) -> usize
[src]
number of iterations taken by the algorithm
pub fn get_norm_fpr(&self) -> f64
[src]
norm of the fixed point residual
pub fn get_cost_value(&self) -> f64
[src]
value of the cost at the solution
Auto Trait Implementations
impl Send for SolverStatus
impl Sync for SolverStatus
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From for T
[src]
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto 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.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,