Struct argmin::result::ArgminResult
[−]
[src]
pub struct ArgminResult<T: ArgminParameter, U: ArgminCostValue> { pub param: T, pub cost: U, pub iters: u64, pub terminated: bool, pub termination_reason: TerminationReason, }
Return struct for all solvers.
Fields
param: T
Final parameter vector
cost: U
Final cost value
iters: u64
Number of iterations
terminated: bool
Indicated whether it terminated or not
termination_reason: TerminationReason
Reason of termination
Methods
impl<T: ArgminParameter, U: ArgminCostValue> ArgminResult<T, U>
[src]
fn new(param: T, cost: U, iters: u64) -> Self
[src]
Constructor
param
: Final (best) parameter vector
cost
: Final (best) cost function value
iters
: Number of iterations
fn set_termination_reason(
&mut self,
termination_reason: TerminationReason
) -> &mut Self
[src]
&mut self,
termination_reason: TerminationReason
) -> &mut Self
Set the termination reason
In case of NotTerminated
, the field terminated
is set to false
and true
otherwise.
termination_reason
: Termination reason of type TerminationReason