Struct argmin::prelude::ArgminIterData

pub struct ArgminIterData<O> where
    O: ArgminOp,  { /* fields omitted */ }

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

TODO: Rename to IterResult?

Methods

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

pub fn new() -> ArgminIterData<O>

Constructor

pub fn param(self, param: <O as ArgminOp>::Param) -> ArgminIterData<O>

Set parameter vector

pub fn cost(self, cost: f64) -> ArgminIterData<O>

Set cost function value

pub fn grad(self, grad: <O as ArgminOp>::Param) -> ArgminIterData<O>

Set gradient

pub fn hessian(self, hessian: <O as ArgminOp>::Hessian) -> ArgminIterData<O>

Set hessian

pub fn kv(self, kv: ArgminKV) -> ArgminIterData<O>

Adds an ArgminKV

pub fn termination_reason(self, reason: TerminationReason) -> ArgminIterData<O>

Set termination reason

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

Get parameter vector

pub fn get_cost(&self) -> Option<f64>

Get cost function value

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

Get gradient

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

Get hessian

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

Get termination reason

pub fn get_kv(&self) -> ArgminKV

Return KV

Trait Implementations

impl<O> Clone for ArgminIterData<O> where
    O: ArgminOp + Clone,
    <O as ArgminOp>::Param: Clone,
    <O as ArgminOp>::Hessian: 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> Serialize for ArgminIterData<O> where
    O: ArgminOp, 

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> Debug for ArgminIterData<O> where
    O: ArgminOp + Debug,
    <O as ArgminOp>::Param: Debug,
    <O as ArgminOp>::Hessian: Debug, 

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

Formats the value using the given formatter.

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

fn default() -> ArgminIterData<O>

Returns the "default value" for a type.