Trait argmin_core::ArgminSolver

pub trait ArgminSolver: ArgminNextIter {
    fn apply(
        &mut self,
        _: &<Self as ArgminNextIter>::Parameters
    ) -> Result<<Self as ArgminNextIter>::OperatorOutput, Error>;
    fn gradient(
        &mut self,
        _: &<Self as ArgminNextIter>::Parameters
    ) -> Result<<Self as ArgminNextIter>::Parameters, Error>;
    fn hessian(
        &mut self,
        _: &<Self as ArgminNextIter>::Parameters
    ) -> Result<<Self as ArgminNextIter>::Hessian, Error>;
    fn modify(
        &mut self,
        _: &<Self as ArgminNextIter>::Parameters,
        _: f64
    ) -> Result<<Self as ArgminNextIter>::Parameters, Error>;
    fn cur_param(&self) -> <Self as ArgminNextIter>::Parameters;
    fn cur_grad(&self) -> <Self as ArgminNextIter>::Parameters;
    fn cur_hessian(&self) -> <Self as ArgminNextIter>::Hessian;
    fn set_cur_param(&mut self, _: <Self as ArgminNextIter>::Parameters);
    fn set_cur_grad(&mut self, _: <Self as ArgminNextIter>::Parameters);
    fn set_cur_hessian(&mut self, _: <Self as ArgminNextIter>::Hessian);
    fn set_best_param(&mut self, _: <Self as ArgminNextIter>::Parameters);
    fn run(
        &mut self
    ) -> Result<ArgminResult<<Self as ArgminNextIter>::Parameters>, Error>;
    fn run_fast(
        &mut self
    ) -> Result<ArgminResult<<Self as ArgminNextIter>::Parameters>, Error>;
    fn result(&self) -> ArgminResult<<Self as ArgminNextIter>::Parameters>;
    fn set_termination_reason(&mut self, _: TerminationReason);
    fn terminate(&mut self) -> TerminationReason;
    fn set_max_iters(&mut self, _: u64);
    fn max_iters(&self) -> u64;
    fn cur_iter(&self) -> u64;
    fn cur_cost(&self) -> f64;
    fn set_cur_cost(&mut self, _: f64);
    fn best_cost(&self) -> f64;
    fn set_best_cost(&mut self, _: f64);
    fn set_target_cost(&mut self, _: f64);
    fn add_logger(&mut self, _: Box<dyn ArgminLog>);
    fn add_writer(&mut self, _: Box<dyn ArgminWrite<Param = Self::Parameters>>);
    fn base_reset(&mut self);
}

Defines the interface to a solver. Usually, there is no need to implement this manually, use the argmin_derive crate instead.

Required Methods

fn apply(
    &mut self,
    _: &<Self as ArgminNextIter>::Parameters
) -> Result<<Self as ArgminNextIter>::OperatorOutput, Error>

apply cost function or operator to a parameter vector

fn gradient(
    &mut self,
    _: &<Self as ArgminNextIter>::Parameters
) -> Result<<Self as ArgminNextIter>::Parameters, Error>

compute the gradient for a parameter vector

fn hessian(
    &mut self,
    _: &<Self as ArgminNextIter>::Parameters
) -> Result<<Self as ArgminNextIter>::Hessian, Error>

compute the hessian for a parameter vector

fn modify(
    &mut self,
    _: &<Self as ArgminNextIter>::Parameters,
    _: f64
) -> Result<<Self as ArgminNextIter>::Parameters, Error>

modify the parameter vector

fn cur_param(&self) -> <Self as ArgminNextIter>::Parameters

return current parameter vector

fn cur_grad(&self) -> <Self as ArgminNextIter>::Parameters

return current gradient

fn cur_hessian(&self) -> <Self as ArgminNextIter>::Hessian

return current gradient

fn set_cur_param(&mut self, _: <Self as ArgminNextIter>::Parameters)

set current parameter vector

fn set_cur_grad(&mut self, _: <Self as ArgminNextIter>::Parameters)

set current gradient

fn set_cur_hessian(&mut self, _: <Self as ArgminNextIter>::Hessian)

set current gradient

fn set_best_param(&mut self, _: <Self as ArgminNextIter>::Parameters)

set current parameter vector

fn run(
    &mut self
) -> Result<ArgminResult<<Self as ArgminNextIter>::Parameters>, Error>

Execute the optimization algorithm.

fn run_fast(
    &mut self
) -> Result<ArgminResult<<Self as ArgminNextIter>::Parameters>, Error>

Execute the optimization algorithm without Ctrl-C handling, logging, writing and anything else which may cost unnecessary time.

fn result(&self) -> ArgminResult<<Self as ArgminNextIter>::Parameters>

Returns the best solution found during optimization.

fn set_termination_reason(&mut self, _: TerminationReason)

Set termination reason (doesn’t terminate yet! – this is helpful for terminating within the iterations)

fn terminate(&mut self) -> TerminationReason

Evaluate all stopping criterions and return the TerminationReason

fn set_max_iters(&mut self, _: u64)

Set max number of iterations.

fn max_iters(&self) -> u64

Get max number of iterations.

fn cur_iter(&self) -> u64

Get current iteration number.

fn cur_cost(&self) -> f64

Get current cost function value

fn set_cur_cost(&mut self, _: f64)

Get current cost function value

fn best_cost(&self) -> f64

Get best cost function value

fn set_best_cost(&mut self, _: f64)

set best cost value

fn set_target_cost(&mut self, _: f64)

Set the target cost function value which is used as a stopping criterion

fn add_logger(&mut self, _: Box<dyn ArgminLog>)

Add a logger to the array of loggers

fn add_writer(&mut self, _: Box<dyn ArgminWrite<Param = Self::Parameters>>)

Add a writer to the array of writers

fn base_reset(&mut self)

Reset the base of the algorithm to its initial state

Implementors