[−][src]Struct argmin::solver::trustregion::dogleg::Dogleg
The Dogleg method computes the intersection of the trust region boundary with a path given by the unconstraind minimum along the steepest descent direction and the optimum of the quadratic approximation of the cost function at the current point.
References:
[0] Jorge Nocedal and Stephen J. Wright (2006). Numerical Optimization. Springer. ISBN 0-387-30303-0.
Methods
impl<O> Dogleg<O> where
O: ArgminOp<Output = f64>,
<O as ArgminOp>::Param: ArgminMul<f64, <O as ArgminOp>::Param> + ArgminWeightedDot<<O as ArgminOp>::Param, f64, <O as ArgminOp>::Hessian> + ArgminNorm<f64> + ArgminDot<<O as ArgminOp>::Param, f64> + ArgminAdd<<O as ArgminOp>::Param, <O as ArgminOp>::Param> + ArgminSub<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
<O as ArgminOp>::Hessian: ArgminInv<<O as ArgminOp>::Hessian> + ArgminDot<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
[src]
O: ArgminOp<Output = f64>,
<O as ArgminOp>::Param: ArgminMul<f64, <O as ArgminOp>::Param> + ArgminWeightedDot<<O as ArgminOp>::Param, f64, <O as ArgminOp>::Hessian> + ArgminNorm<f64> + ArgminDot<<O as ArgminOp>::Param, f64> + ArgminAdd<<O as ArgminOp>::Param, <O as ArgminOp>::Param> + ArgminSub<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
<O as ArgminOp>::Hessian: ArgminInv<<O as ArgminOp>::Hessian> + ArgminDot<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
Trait Implementations
impl<O> ArgminSolver for Dogleg<O> where
O: ArgminOp<Output = f64>,
<O as ArgminOp>::Param: ArgminMul<f64, <O as ArgminOp>::Param> + ArgminWeightedDot<<O as ArgminOp>::Param, f64, <O as ArgminOp>::Hessian> + ArgminNorm<f64> + ArgminDot<<O as ArgminOp>::Param, f64> + ArgminAdd<<O as ArgminOp>::Param, <O as ArgminOp>::Param> + ArgminSub<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
<O as ArgminOp>::Hessian: ArgminInv<<O as ArgminOp>::Hessian> + ArgminDot<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
[src]
O: ArgminOp<Output = f64>,
<O as ArgminOp>::Param: ArgminMul<f64, <O as ArgminOp>::Param> + ArgminWeightedDot<<O as ArgminOp>::Param, f64, <O as ArgminOp>::Hessian> + ArgminNorm<f64> + ArgminDot<<O as ArgminOp>::Param, f64> + ArgminAdd<<O as ArgminOp>::Param, <O as ArgminOp>::Param> + ArgminSub<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
<O as ArgminOp>::Hessian: ArgminInv<<O as ArgminOp>::Hessian> + ArgminDot<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
fn run(&mut self) -> Result<ArgminResult<Self::Param>, Error>
[src]
Run the optimization algorithm
fn run_fast(&mut self) -> Result<ArgminResult<Self::Param>, Error>
[src]
Run the essential parts of the optimization algorithm (no logging, no Ctrl-C handling)
fn apply(&mut self, param: &Self::Param) -> Result<Self::Output, Error>
[src]
Applies the cost function or operator to a parameter vector param
.
Returns an Err
if apply
of ArgminOperator
is not implemented.
fn gradient(&mut self, param: &Self::Param) -> Result<Self::Param, Error>
[src]
Computes the gradient at parameter param
.
Returns an Err
if gradient
of ArgminOperator
is not implemented.
fn hessian(&mut self, param: &Self::Param) -> Result<Self::Hessian, Error>
[src]
Computes the Hessian at parameter param
.
Returns an Err
if hessian
of ArgminOperator
is not implemented.
fn cur_param(&self) -> Self::Param
[src]
Returns the current parameter vector.
fn cur_grad(&self) -> Self::Param
[src]
Returns the most recently stored gradient.
fn cur_hessian(&self) -> Self::Hessian
[src]
Returns the most recently stored Hessian.
fn set_cur_param(&mut self, param: Self::Param)
[src]
Sets the current parameter to param
.
fn set_cur_grad(&mut self, grad: Self::Param)
[src]
Sets the current gradient to grad
.
fn set_cur_hessian(&mut self, hessian: Self::Hessian)
[src]
Sets the current Hessian to hessian
.
fn set_best_param(&mut self, param: Self::Param)
[src]
Sets the best parameter vector to param
.
fn modify(&self, param: &Self::Param, factor: f64) -> Result<Self::Param, Error>
[src]
Modify the parameter vector by calling the modify
method of the trait
ArgminOperator
. Will return an Err
if modify
is not implemented.
fn result(&self) -> ArgminResult<Self::Param>
[src]
Returns the result of the optimization.
fn set_max_iters(&mut self, iters: u64)
[src]
Sets the maximum number of iterations to iters
.
fn max_iters(&self) -> u64
[src]
Returns the maximum number of iterations.
fn increment_iter(&mut self)
[src]
Increments the iteration counter.
fn cur_iter(&self) -> u64
[src]
Returns the current number of iterations.
fn cur_cost(&self) -> f64
[src]
Returns the most recently stored cost function value.
fn set_cur_cost(&mut self, cost: f64)
[src]
Sets the current cost function value to cost
fn best_cost(&self) -> f64
[src]
Returns the best cost function value obtained so far.
fn set_best_cost(&mut self, cost: f64)
[src]
Sets the best cost function value.
fn set_target_cost(&mut self, cost: f64)
[src]
Sets the target cost function value to cost
. The optimization algorithm will be
terminated when this limit is reached.
fn increment_cost_func_count(&mut self)
[src]
Increments the counter for the computations of the cost function by 1.
fn increase_cost_func_count(&mut self, count: u64)
[src]
Increases the counter for the computations of the cost function by count
.
fn cost_func_count(&self) -> u64
[src]
Returns the current value of the counter for the computations of the cost function.
fn increment_grad_func_count(&mut self)
[src]
Increments the counter for the computations of the gradient by 1.
fn increase_grad_func_count(&mut self, count: u64)
[src]
Increases the counter for the computations of the gradient by count
.
fn grad_func_count(&self) -> u64
[src]
Returns the current value of the counter for the computations of the gradient.
fn increment_hessian_func_count(&mut self)
[src]
Increments the counter for the computations of the Hessian by 1.
fn increase_hessian_func_count(&mut self, count: u64)
[src]
Increases the counter for the computations of the Hessian by count
.
fn hessian_func_count(&self) -> u64
[src]
Returns the current value of the counter for the computations of the Hessian.
fn add_logger(&mut self, logger: Arc<dyn ArgminLog>)
[src]
Attaches a logger which implements ArgminLog
to the solver.
fn add_writer(&mut self, writer: Arc<dyn ArgminWrite<Param = Self::Param>>)
[src]
Attaches a writer which implements ArgminWrite
to the solver.
fn set_termination_reason(&mut self, reason: TerminationReason)
[src]
Sets the TerminationReason
fn terminate(&mut self) -> TerminationReason
[src]
Checks whether any of the conditions to terminate is true and terminates the algorithm.
fn base_reset(&mut self)
[src]
Resets the base
field to it's initial conditions. This is helpful for
implementing a solver which is initialized once, but called several times. It is
recommended to only call this method inside the init
function of
ArgminNextIter
.
impl<O> ArgminIter for Dogleg<O> where
O: ArgminOp<Output = f64>,
<O as ArgminOp>::Param: ArgminMul<f64, <O as ArgminOp>::Param> + ArgminWeightedDot<<O as ArgminOp>::Param, f64, <O as ArgminOp>::Hessian> + ArgminNorm<f64> + ArgminDot<<O as ArgminOp>::Param, f64> + ArgminAdd<<O as ArgminOp>::Param, <O as ArgminOp>::Param> + ArgminSub<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
<O as ArgminOp>::Hessian: ArgminInv<<O as ArgminOp>::Hessian> + ArgminDot<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
[src]
O: ArgminOp<Output = f64>,
<O as ArgminOp>::Param: ArgminMul<f64, <O as ArgminOp>::Param> + ArgminWeightedDot<<O as ArgminOp>::Param, f64, <O as ArgminOp>::Hessian> + ArgminNorm<f64> + ArgminDot<<O as ArgminOp>::Param, f64> + ArgminAdd<<O as ArgminOp>::Param, <O as ArgminOp>::Param> + ArgminSub<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
<O as ArgminOp>::Hessian: ArgminInv<<O as ArgminOp>::Hessian> + ArgminDot<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
type Param = <O as ArgminOp>::Param
Parameter vectors
type Output = <O as ArgminOp>::Output
Output of the operator
type Hessian = <O as ArgminOp>::Hessian
Hessian
fn init(&mut self) -> Result<(), Error>
[src]
fn next_iter(&mut self) -> Result<ArgminIterData<Self::Param>, Error>
[src]
impl<O> ArgminTrustRegion for Dogleg<O> where
O: ArgminOp<Output = f64>,
<O as ArgminOp>::Param: ArgminMul<f64, <O as ArgminOp>::Param> + ArgminWeightedDot<<O as ArgminOp>::Param, f64, <O as ArgminOp>::Hessian> + ArgminNorm<f64> + ArgminDot<<O as ArgminOp>::Param, f64> + ArgminAdd<<O as ArgminOp>::Param, <O as ArgminOp>::Param> + ArgminSub<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
<O as ArgminOp>::Hessian: ArgminInv<<O as ArgminOp>::Hessian> + ArgminDot<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
[src]
O: ArgminOp<Output = f64>,
<O as ArgminOp>::Param: ArgminMul<f64, <O as ArgminOp>::Param> + ArgminWeightedDot<<O as ArgminOp>::Param, f64, <O as ArgminOp>::Hessian> + ArgminNorm<f64> + ArgminDot<<O as ArgminOp>::Param, f64> + ArgminAdd<<O as ArgminOp>::Param, <O as ArgminOp>::Param> + ArgminSub<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
<O as ArgminOp>::Hessian: ArgminInv<<O as ArgminOp>::Hessian> + ArgminDot<<O as ArgminOp>::Param, <O as ArgminOp>::Param>,
Auto Trait Implementations
impl<O> Send for Dogleg<O> where
<O as ArgminOp>::Hessian: Send,
<O as ArgminOp>::Param: Send,
<O as ArgminOp>::Hessian: Send,
<O as ArgminOp>::Param: Send,
impl<O> Sync for Dogleg<O> where
<O as ArgminOp>::Hessian: Sync,
<O as ArgminOp>::Param: Sync,
<O as ArgminOp>::Hessian: Sync,
<O as ArgminOp>::Param: Sync,
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From for T
[src]
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,