Trait argmin::prelude::ArgminIter

pub trait ArgminIter {
    type Param;
    type Output;
    type Hessian;
    fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>;

    fn init(&mut self) -> Result<(), Error> { ... }
}

Main part of every solver: next_iter computes one iteration of the algorithm and init is executed before these iterations. The init method comes with a default implementation which corresponds to doing nothing.

Associated Types

type Param

Parameter vectors

type Output

Output of the operator

type Hessian

Hessian

Loading content...

Required methods

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

Computes one iteration of the algorithm.

Loading content...

Provided methods

fn init(&mut self) -> Result<(), Error>

Initializes the algorithm

This is executed before any iterations are performed. It can be used to perform precomputations. The default implementation corresponds to doing nothing.

Loading content...

Implementors

impl<O> ArgminIter for ConjugateGradient<O> where
    O: ArgminOp<Output = <O as ArgminOp>::Param>,
    O::Param: ArgminSub<O::Param, O::Param> + ArgminDot<O::Param, f64> + ArgminScaledAdd<O::Param, f64, O::Param> + ArgminAdd<O::Param, O::Param> + ArgminMul<f64, O::Param> + ArgminDot<O::Param, f64>, 

type Param = O::Param

type Output = O::Output

type Hessian = O::Hessian

fn init(&mut self) -> Result<(), Error>

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

Perform one iteration of SA algorithm

impl<O> ArgminIter for Landweber<O> where
    O::Param: ArgminScaledSub<O::Param, f64, O::Param>,
    O: ArgminOp, 

type Param = O::Param

type Output = O::Output

type Hessian = O::Hessian

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

fn init(&mut self) -> Result<(), Error>

impl<O> ArgminIter for HagerZhangLineSearch<O> where
    O: ArgminOp<Output = f64>,
    O::Param: ArgminSub<O::Param, O::Param> + ArgminDot<O::Param, f64> + ArgminScaledAdd<O::Param, f64, O::Param>, 

type Param = O::Param

type Output = f64

type Hessian = O::Hessian

fn init(&mut self) -> Result<(), Error>

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

impl<O> ArgminIter for MoreThuenteLineSearch<O> where
    O: ArgminOp<Output = f64>,
    O::Param: ArgminSub<O::Param, O::Param> + ArgminDot<O::Param, f64> + ArgminScaledAdd<O::Param, f64, O::Param>, 

type Param = O::Param

type Output = f64

type Hessian = O::Hessian

fn init(&mut self) -> Result<(), Error>

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

impl<O> ArgminIter for Newton<O> where
    O: ArgminOp,
    O::Param: ArgminScaledSub<O::Param, f64, O::Param>,
    O::Hessian: ArgminInv<O::Hessian> + ArgminDot<O::Param, O::Param>, 

type Param = O::Param

type Output = O::Output

type Hessian = O::Hessian

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

fn init(&mut self) -> Result<(), Error>

impl<O> ArgminIter for SimulatedAnnealing<O> where
    O: ArgminOp<Output = f64>, 

type Param = O::Param

type Output = O::Output

type Hessian = O::Hessian

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

Perform one iteration of SA algorithm

fn init(&mut self) -> Result<(), Error>

impl<O> ArgminIter for CauchyPoint<O> where
    O: ArgminOp<Output = f64>,
    O::Param: ArgminMul<f64, O::Param> + ArgminWeightedDot<O::Param, f64, O::Hessian> + ArgminNorm<f64>, 

type Param = O::Param

type Output = O::Output

type Hessian = O::Hessian

fn init(&mut self) -> Result<(), Error>

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

impl<O> ArgminIter for Dogleg<O> where
    O: ArgminOp<Output = f64>,
    O::Param: ArgminMul<f64, O::Param> + ArgminWeightedDot<O::Param, f64, O::Hessian> + ArgminNorm<f64> + ArgminDot<O::Param, f64> + ArgminAdd<O::Param, O::Param> + ArgminSub<O::Param, O::Param>,
    O::Hessian: ArgminInv<O::Hessian> + ArgminDot<O::Param, O::Param>, 

type Param = O::Param

type Output = O::Output

type Hessian = O::Hessian

fn init(&mut self) -> Result<(), Error>

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

impl<O> ArgminIter for Steihaug<O> where
    O: ArgminOp<Output = f64>,
    O::Param: ArgminMul<f64, O::Param> + ArgminWeightedDot<O::Param, f64, O::Hessian> + ArgminNorm<f64> + ArgminDot<O::Param, f64> + ArgminAdd<O::Param, O::Param> + ArgminSub<O::Param, O::Param> + ArgminZero + ArgminMul<f64, O::Param>,
    O::Hessian: ArgminDot<O::Param, O::Param>, 

type Param = O::Param

type Output = O::Output

type Hessian = O::Hessian

fn init(&mut self) -> Result<(), Error>

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

impl<O, L> ArgminIter for SteepestDescent<O, L> where
    O: ArgminOp<Output = f64>,
    O::Param: ArgminSub<O::Param, O::Param> + ArgminDot<O::Param, f64> + ArgminScaledAdd<O::Param, f64, O::Param> + ArgminMul<f64, O::Param> + ArgminSub<O::Param, O::Param> + ArgminNorm<f64>,
    L: ArgminLineSearch<Param = O::Param, Output = f64, Hessian = O::Hessian>, 

type Param = O::Param

type Output = f64

type Hessian = O::Hessian

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

Perform one iteration of SA algorithm

fn init(&mut self) -> Result<(), Error>

impl<O, L> ArgminIter for BacktrackingLineSearch<O, L> where
    O: ArgminOp<Output = f64>,
    O::Param: ArgminSub<O::Param, O::Param> + ArgminDot<O::Param, f64> + ArgminScaledAdd<O::Param, f64, O::Param>,
    L: LineSearchCondition<O::Param>, 

type Param = O::Param

type Output = f64

type Hessian = O::Hessian

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

fn init(&mut self) -> Result<(), Error>

impl<O, L> ArgminIter for NewtonCG<O, L> where
    O: ArgminOp<Output = f64>,
    O::Param: ArgminSub<O::Param, O::Param> + ArgminAdd<O::Param, O::Param> + ArgminDot<O::Param, f64> + ArgminScaledAdd<O::Param, f64, O::Param> + ArgminMul<f64, O::Param> + ArgminZero + ArgminNorm<f64>,
    O::Hessian: ArgminInv<O::Hessian> + ArgminDot<O::Param, O::Param>,
    L: ArgminLineSearch<Param = O::Param, Output = O::Output, Hessian = O::Hessian>, 

type Param = O::Param

type Output = O::Output

type Hessian = O::Hessian

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

fn init(&mut self) -> Result<(), Error>

impl<O, L> ArgminIter for BFGS<O, L> where
    O: ArgminOp<Output = f64>,
    O::Param: ArgminSub<O::Param, O::Param> + ArgminDot<O::Param, f64> + ArgminDot<O::Param, O::Hessian> + ArgminScaledAdd<O::Param, f64, O::Param> + ArgminNorm<f64> + ArgminMul<f64, O::Param>,
    O::Hessian: ArgminSub<O::Hessian, O::Hessian> + ArgminDot<O::Param, O::Param> + ArgminDot<O::Hessian, O::Hessian> + ArgminAdd<O::Hessian, O::Hessian> + ArgminMul<f64, O::Hessian> + ArgminTranspose + ArgminEye,
    L: ArgminLineSearch<Param = O::Param, Output = O::Output, Hessian = O::Hessian>, 

type Param = O::Param

type Output = O::Output

type Hessian = O::Hessian

fn init(&mut self) -> Result<(), Error>

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

impl<O, L, B> ArgminIter for NonlinearConjugateGradient<O, L, B> where
    O: ArgminOp<Output = f64>,
    O::Param: ArgminSub<O::Param, O::Param> + ArgminDot<O::Param, f64> + ArgminScaledAdd<O::Param, f64, O::Param> + ArgminAdd<O::Param, O::Param> + ArgminMul<f64, O::Param> + ArgminDot<O::Param, f64> + ArgminNorm<f64>,
    L: ArgminLineSearch<Param = O::Param, Output = f64, Hessian = O::Hessian>,
    B: ArgminNLCGBetaUpdate<O::Param>, 

type Param = O::Param

type Output = O::Output

type Hessian = O::Hessian

fn init(&mut self) -> Result<(), Error>

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

Perform one iteration of SA algorithm

impl<O, R> ArgminIter for TrustRegion<O, R> where
    O: ArgminOp<Output = f64>,
    O::Param: ArgminMul<f64, O::Param> + ArgminWeightedDot<O::Param, f64, O::Hessian> + ArgminNorm<f64> + ArgminDot<O::Param, f64> + ArgminAdd<O::Param, O::Param> + ArgminSub<O::Param, O::Param> + ArgminZero + ArgminMul<f64, O::Param>,
    O::Hessian: ArgminDot<O::Param, O::Param>,
    R: ArgminTrustRegion<Param = O::Param, Output = f64, Hessian = O::Hessian>, 

type Param = O::Param

type Output = f64

type Hessian = O::Hessian

fn init(&mut self) -> Result<(), Error>

fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>

Loading content...