Struct argmin::solver::gaussnewton::gaussnewton_linesearch::GaussNewtonLS

pub struct GaussNewtonLS<L, F> { /* fields omitted */ }

Gauss-Newton method with linesearch

Example

References:

[0] Jorge Nocedal and Stephen J. Wright (2006). Numerical Optimization. Springer. ISBN 0-387-30303-0.

Implementations

impl<L, F: ArgminFloat> GaussNewtonLS<L, F>

pub fn new(linesearch: L) -> Self

Constructor

pub fn with_tol(self, tol: F) -> Result<Self, Error>

Set tolerance for the stopping criterion based on cost difference

Trait Implementations

impl<L: Clone, F: Clone> Clone for GaussNewtonLS<L, F>

fn clone(&self) -> GaussNewtonLS<L, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de, L, F> Deserialize<'de> for GaussNewtonLS<L, F> where
    L: Deserialize<'de>,
    F: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<L, F> Serialize for GaussNewtonLS<L, F> where
    L: Serialize,
    F: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<O, L, F> Solver<O> for GaussNewtonLS<L, F> where
    O: ArgminOp<Float = F>,
    O::Param: Debug + ArgminScaledSub<O::Param, O::Float, O::Param> + ArgminSub<O::Param, O::Param> + ArgminMul<O::Float, O::Param>,
    O::Output: ArgminNorm<O::Float>,
    O::Jacobian: ArgminTranspose<O::Jacobian> + ArgminInv<O::Jacobian> + ArgminDot<O::Jacobian, O::Jacobian> + ArgminDot<O::Output, O::Param> + ArgminDot<O::Param, O::Param>,
    L: Clone + ArgminLineSearch<O::Param, O::Float> + Solver<OpWrapper<LineSearchOP<O>>>,
    F: ArgminFloat, 

const NAME: &'static str

Name of the solver

fn next_iter(
    &mut self,
    op: &mut OpWrapper<O>,
    state: &IterState<O>
) -> Result<ArgminIterData<O>, Error>

Computes one iteration of the algorithm.

fn terminate(&mut self, state: &IterState<O>) -> TerminationReason

Checks whether the algorithm must be terminated

fn init(
    &mut self,
    _op: &mut OpWrapper<O>,
    _state: &IterState<O>
) -> Result<Option<ArgminIterData<O>>, Error>

Initializes the algorithm

fn terminate_internal(&mut self, state: &IterState<O>) -> TerminationReason

Checks whether basic termination reasons apply.