Struct GaussNewton

pub struct GaussNewton<F> { /* private fields */ }

Gauss-Newton method

Example

References:

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

Implementations

impl<F: ArgminFloat> GaussNewton<F>

pub fn new() -> Self

Constructor

pub fn with_gamma(self, gamma: F) -> Result<Self, Error>

set gamma

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

Set tolerance for the stopping criterion based on cost difference

Trait Implementations

impl<F: Clone> Clone for GaussNewton<F>

fn clone(&self) -> GaussNewton<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: ArgminFloat> Default for GaussNewton<F>

fn default() -> GaussNewton<F>

Returns the “default value” for a type.

impl<'de, F> Deserialize<'de> for GaussNewton<F>

where 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<F> Serialize for GaussNewton<F>

where 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, F> Solver<O> for GaussNewton<F>

where O: ArgminOp<Float = F>, O::Param: Default + 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 + ArgminInv<O::Jacobian> + ArgminDot<O::Jacobian, O::Jacobian> + ArgminDot<O::Output, O::Param> + ArgminDot<O::Param, O::Param>, O::Hessian: Default, F: ArgminFloat,

const NAME: &'static str = "Gauss-Newton method"

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.