Struct argmin::core::ArgminIterData[][src]

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

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

TODO: Rename to IterResult?

Implementations

impl<O: ArgminOp> ArgminIterData<O>[src]

pub fn new() -> Self[src]

Constructor

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

Set parameter vector

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

Set cost function value

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

Set gradient

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

Set Hessian

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

Set Jacobian

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

Set Population

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

Adds an ArgminKV

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

Set termination reason

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

Get parameter vector

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

Get cost function value

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

Get gradient

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

Get Hessian

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

Get Jacobian

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

Get reference to population

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

Get termination reason

pub fn get_kv(&self) -> ArgminKV[src]

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::Jacobian: Clone,
    O::Param: Clone,
    O::Float: Clone
[src]

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

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

Auto Trait Implementations

impl<O> RefUnwindSafe for ArgminIterData<O> where
    <O as ArgminOp>::Float: RefUnwindSafe,
    <O as ArgminOp>::Hessian: RefUnwindSafe,
    <O as ArgminOp>::Jacobian: RefUnwindSafe,
    <O as ArgminOp>::Param: RefUnwindSafe

impl<O> Send for ArgminIterData<O> where
    <O as ArgminOp>::Float: Send,
    <O as ArgminOp>::Hessian: Send,
    <O as ArgminOp>::Jacobian: Send,
    <O as ArgminOp>::Param: Send

impl<O> Sync for ArgminIterData<O> where
    <O as ArgminOp>::Float: Sync,
    <O as ArgminOp>::Hessian: Sync,
    <O as ArgminOp>::Jacobian: Sync,
    <O as ArgminOp>::Param: Sync

impl<O> Unpin for ArgminIterData<O> where
    <O as ArgminOp>::Float: Unpin,
    <O as ArgminOp>::Hessian: Unpin,
    <O as ArgminOp>::Jacobian: Unpin,
    <O as ArgminOp>::Param: Unpin

impl<O> UnwindSafe for ArgminIterData<O> where
    <O as ArgminOp>::Float: UnwindSafe,
    <O as ArgminOp>::Hessian: UnwindSafe,
    <O as ArgminOp>::Jacobian: UnwindSafe,
    <O as ArgminOp>::Param: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

impl<T> SendSyncUnwindSafe for T where
    T: Send + Sync + UnwindSafe + ?Sized