Struct argmin::core::ArgminIterData

pub struct ArgminIterData<O: ArgminOp> { /* private fields */ }

The datastructure which is returned by the next_iter method of the Solver trait.

TODO: Rename to IterResult?

Implementations

impl<O: ArgminOp> ArgminIterData<O>

pub fn new() -> Self

Constructor

pub fn param(self, param: O::Param) -> Self

Set parameter vector

pub fn cost(self, cost: O::Float) -> Self

Set cost function value

pub fn grad(self, grad: O::Param) -> Self

Set gradient

pub fn hessian(self, hessian: O::Hessian) -> Self

Set Hessian

pub fn inv_hessian(self, inv_hessian: O::Hessian) -> Self

Set inverse Hessian

pub fn jacobian(self, jacobian: O::Jacobian) -> Self

Set Jacobian

pub fn population(self, population: Vec<(O::Param, O::Float)>) -> Self

Set Population

pub fn kv(self, kv: ArgminKV) -> Self

Adds an ArgminKV

pub fn termination_reason(self, reason: TerminationReason) -> Self

Set termination reason

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

Get parameter vector

pub fn get_cost(&self) -> Option<O::Float>

Get cost function value

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

Get gradient

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

Get Hessian

pub fn get_inv_hessian(&self) -> Option<O::Hessian>

Get inverse Hessian

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

Get Jacobian

pub fn get_population(&self) -> Option<&Vec<(O::Param, O::Float)>>

Get reference to population

pub fn get_termination_reason(&self) -> Option<TerminationReason>

Get termination reason

pub fn get_kv(&self) -> ArgminKV

Return KV

Trait Implementations

impl<O: Clone + ArgminOp> Clone for ArgminIterData<O> where
    O::Param: Clone,
    O::Float: Clone,
    O::Param: Clone,
    O::Hessian: Clone,
    O::Hessian: Clone,
    O::Jacobian: Clone,
    O::Param: Clone,
    O::Float: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Debug + ArgminOp> Debug for ArgminIterData<O> where
    O::Param: Debug,
    O::Float: Debug,
    O::Param: Debug,
    O::Hessian: Debug,
    O::Hessian: Debug,
    O::Jacobian: Debug,
    O::Param: Debug,
    O::Float: Debug, 

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

Formats the value using the given formatter.

impl<O: Default + ArgminOp> Default for ArgminIterData<O> where
    O::Param: Default,
    O::Float: Default,
    O::Param: Default,
    O::Hessian: Default,
    O::Hessian: Default,
    O::Jacobian: Default,
    O::Param: Default,
    O::Float: Default, 

fn default() -> ArgminIterData<O>

Returns the “default value” for a type.