Struct argmin::prelude::IterState

pub struct IterState<O> where
    O: ArgminOp,  {
    pub param: <O as ArgminOp>::Param,
    pub prev_param: <O as ArgminOp>::Param,
    pub best_param: <O as ArgminOp>::Param,
    pub prev_best_param: <O as ArgminOp>::Param,
    pub cost: f64,
    pub prev_cost: f64,
    pub best_cost: f64,
    pub prev_best_cost: f64,
    pub target_cost: f64,
    pub grad: Option<<O as ArgminOp>::Param>,
    pub prev_grad: Option<<O as ArgminOp>::Param>,
    pub hessian: Option<<O as ArgminOp>::Hessian>,
    pub prev_hessian: Option<<O as ArgminOp>::Hessian>,
    pub jacobian: Option<<O as ArgminOp>::Jacobian>,
    pub prev_jacobian: Option<<O as ArgminOp>::Jacobian>,
    pub iter: u64,
    pub last_best_iter: u64,
    pub max_iters: u64,
    pub cost_func_count: u64,
    pub grad_func_count: u64,
    pub hessian_func_count: u64,
    pub jacobian_func_count: u64,
    pub modify_func_count: u64,
    pub time: Duration,
    pub termination_reason: TerminationReason,
}

Fields

param: <O as ArgminOp>::Param

Current parameter vector

prev_param: <O as ArgminOp>::Param

Previous parameter vector

best_param: <O as ArgminOp>::Param

Current best parameter vector

prev_best_param: <O as ArgminOp>::Param

Previous best parameter vector

cost: f64

Current cost function value

prev_cost: f64

Previous cost function value

best_cost: f64

Current best cost function value

prev_best_cost: f64

Previous best cost function value

target_cost: f64

Target cost function value

grad: Option<<O as ArgminOp>::Param>

Current gradient

prev_grad: Option<<O as ArgminOp>::Param>

Previous gradient

hessian: Option<<O as ArgminOp>::Hessian>

Current Hessian

prev_hessian: Option<<O as ArgminOp>::Hessian>

Previous Hessian

jacobian: Option<<O as ArgminOp>::Jacobian>

Current Jacobian

prev_jacobian: Option<<O as ArgminOp>::Jacobian>

Previous Jacobian

iter: u64

Current iteration

last_best_iter: u64

Iteration number of last best cost

max_iters: u64

Maximum number of iterations

cost_func_count: u64

Number of cost function evaluations so far

grad_func_count: u64

Number of gradient evaluations so far

hessian_func_count: u64

Number of Hessian evaluations so far

jacobian_func_count: u64

Number of Jacobian evaluations so far

modify_func_count: u64

Number of modify evaluations so far

time: Duration

Time required so far

termination_reason: TerminationReason

Reason of termination

Methods

impl<O> IterState<O> where
    O: ArgminOp, 

pub fn new(param: <O as ArgminOp>::Param) -> IterState<O>

Create new IterState from param

pub fn param(&mut self, param: <O as ArgminOp>::Param) -> &mut IterState<O>

Set parameter vector. This shifts the stored parameter vector to the previous parameter vector.

pub fn best_param(&mut self, param: <O as ArgminOp>::Param) -> &mut IterState<O>

Set best paramater vector. This shifts the stored best parameter vector to the previous best parameter vector.

pub fn cost(&mut self, cost: f64) -> &mut IterState<O>

Set the current cost function value. This shifts the stored cost function value to the previous cost function value.

pub fn best_cost(&mut self, cost: f64) -> &mut IterState<O>

Set the current best cost function value. This shifts the stored best cost function value to the previous cost function value.

pub fn grad(&mut self, grad: <O as ArgminOp>::Param) -> &mut IterState<O>

Set gradient. This shifts the stored gradient to the previous gradient.

pub fn hessian(
    &mut self,
    hessian: <O as ArgminOp>::Hessian
) -> &mut IterState<O>

Set Hessian. This shifts the stored Hessian to the previous Hessian.

pub fn jacobian(
    &mut self,
    jacobian: <O as ArgminOp>::Jacobian
) -> &mut IterState<O>

Set Jacobian. This shifts the stored Jacobian to the previous Jacobian.

pub fn target_cost(&mut self, target_cost: f64) -> &mut IterState<O>

pub fn max_iters(&mut self, max_iters: u64) -> &mut IterState<O>

pub fn last_best_iter(&mut self, last_best_iter: u64) -> &mut IterState<O>

pub fn termination_reason(
    &mut self,
    termination_reason: TerminationReason
) -> &mut IterState<O>

pub fn time(&mut self, time: Duration) -> &mut IterState<O>

pub fn get_param(&self) -> <O as ArgminOp>::Param

pub fn get_prev_param(&self) -> <O as ArgminOp>::Param

pub fn get_best_param(&self) -> <O as ArgminOp>::Param

pub fn get_prev_best_param(&self) -> <O as ArgminOp>::Param

pub fn get_cost(&self) -> f64

pub fn get_prev_cost(&self) -> f64

pub fn get_best_cost(&self) -> f64

pub fn get_prev_best_cost(&self) -> f64

pub fn get_target_cost(&self) -> f64

pub fn get_cost_func_count(&self) -> u64

pub fn get_grad_func_count(&self) -> u64

pub fn get_hessian_func_count(&self) -> u64

pub fn get_jacobian_func_count(&self) -> u64

pub fn get_modify_func_count(&self) -> u64

pub fn get_last_best_iter(&self) -> u64

pub fn get_termination_reason(&self) -> TerminationReason

pub fn get_time(&self) -> Duration

pub fn get_grad(&self) -> Option<<O as ArgminOp>::Param>

pub fn get_prev_grad(&self) -> Option<<O as ArgminOp>::Param>

pub fn get_hessian(&self) -> Option<<O as ArgminOp>::Hessian>

pub fn get_prev_hessian(&self) -> Option<<O as ArgminOp>::Hessian>

pub fn get_jacobian(&self) -> Option<<O as ArgminOp>::Jacobian>

pub fn get_prev_jacobian(&self) -> Option<<O as ArgminOp>::Jacobian>

pub fn get_iter(&self) -> u64

pub fn get_max_iters(&self) -> u64

pub fn increment_iter(&mut self)

Increment the number of iterations by one

pub fn increment_func_counts(&mut self, op: &OpWrapper<O>)

Increment all function evaluation counts by the evaluation counts of another operator wrapped in OpWrapper.

pub fn set_func_counts(&mut self, op: &OpWrapper<O>)

Set all function evaluation counts to the evaluation counts of another operator wrapped in OpWrapper.

pub fn increment_cost_func_count(&mut self, num: u64)

Increment cost function evaluation count by num

pub fn increment_grad_func_count(&mut self, num: u64)

Increment gradient function evaluation count by num

pub fn increment_hessian_func_count(&mut self, num: u64)

Increment Hessian function evaluation count by num

pub fn increment_jacobian_func_count(&mut self, num: u64)

Increment Jacobian function evaluation count by num

pub fn increment_modify_func_count(&mut self, num: u64)

Increment modify function evaluation count by num

pub fn new_best(&mut self)

Indicate that a new best parameter vector was found

pub fn is_best(&self) -> bool

Returns whether the current parameter vector is also the best parameter vector found so far.

pub fn terminated(&self) -> bool

Return whether the algorithm has terminated or not

Trait Implementations

impl<O> Debug for IterState<O> where
    O: ArgminOp + Debug,
    <O as ArgminOp>::Param: Debug,
    <O as ArgminOp>::Hessian: Debug,
    <O as ArgminOp>::Jacobian: Debug, 

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

Formats the value using the given formatter.

impl<'de, O> Deserialize<'de> for IterState<O> where
    O: ArgminOp,
    <O as ArgminOp>::Param: Deserialize<'de>, 

fn deserialize<__D>(
    __deserializer: __D
) -> Result<IterState<O>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<O> Default for IterState<O> where
    O: ArgminOp,
    <O as ArgminOp>::Param: Default, 

fn default() -> IterState<O>

Returns the "default value" for a type.

impl<O> KV for IterState<O> where
    O: ArgminOp, 

fn serialize(
    &self,
    _record: &Record,
    serializer: &mut dyn Serializer
) -> Result<(), Error>

Serialize self into Serializer

impl<O> Serialize for IterState<O> where
    O: ArgminOp,
    <O as ArgminOp>::Param: Serialize, 

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<O> Clone for IterState<O> where
    O: ArgminOp + Clone,
    <O as ArgminOp>::Param: Clone,
    <O as ArgminOp>::Hessian: Clone,
    <O as ArgminOp>::Jacobian: Clone, 

fn clone(&self) -> IterState<O>

Returns a copy of the value.

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

Performs copy-assignment from source.