[−][src]Struct argmin::solver::conjugategradient::cg::ConjugateGradient
The conjugate gradient method is a solver for systems of linear equations with a symmetric and positive-definite matrix.
Example
extern crate argmin; use argmin::prelude::*; use argmin::solver::conjugategradient::ConjugateGradient; use serde::{Deserialize, Serialize}; #[derive(Clone, Default, Serialize, Deserialize)] struct MyProblem {} impl ArgminOp for MyProblem { type Param = Vec<f64>; type Output = Vec<f64>; type Hessian = (); fn apply(&self, p: &Vec<f64>) -> Result<Vec<f64>, Error> { Ok(vec![4.0 * p[0] + 1.0 * p[1], 1.0 * p[0] + 3.0 * p[1]]) } } // Define inital parameter vector let init_param: Vec<f64> = vec![2.0, 1.0]; // Define the right hand side `b` of `A * x = b` let b = vec![1.0, 2.0]; // Set up operator let operator = MyProblem {}; // Set up the solver let mut solver = ConjugateGradient::new(operator, b, init_param)?; // Set maximum number of iterations solver.set_max_iters(2); // Attach a logger solver.add_logger(ArgminSlogLogger::term()); // Run solver solver.run()?; // Wait a second (lets the logger flush everything before printing to screen again) std::thread::sleep(std::time::Duration::from_secs(1)); // Print result println!("{:?}", solver.result());
References:
[0] Jorge Nocedal and Stephen J. Wright (2006). Numerical Optimization. Springer. ISBN 0-387-30303-0.
Methods
impl<O> 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>,
[src]
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>,
pub fn new(
operator: O,
b: O::Param,
init_param: O::Param
) -> Result<Self, Error>
[src]
operator: O,
b: O::Param,
init_param: O::Param
) -> Result<Self, Error>
Constructor
Parameters:
cost_function
: cost function
b
: right hand side of A * x = b
init_param
: Initial parameter vector
pub fn p(&self) -> O::Param
[src]
Return the current search direction (This is needed by NewtonCG for instance)
pub fn p_prev(&self) -> O::Param
[src]
Return the previous search direction (This is needed by NewtonCG for instance)
pub fn residual(&self) -> O::Param
[src]
Return the current residual (This is needed by NewtonCG for instance)
Trait Implementations
impl<O: Clone> Clone 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>,
O::Param: Clone,
O::Param: Clone,
O::Param: Clone,
O::Param: Clone,
[src]
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>,
O::Param: Clone,
O::Param: Clone,
O::Param: Clone,
O::Param: Clone,
fn clone(&self) -> ConjugateGradient<O>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<'de, O> Deserialize<'de> 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>,
O: Deserialize<'de>,
O::Param: Deserialize<'de>,
O::Param: Deserialize<'de>,
O::Param: Deserialize<'de>,
O::Param: Deserialize<'de>,
[src]
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>,
O: Deserialize<'de>,
O::Param: Deserialize<'de>,
O::Param: Deserialize<'de>,
O::Param: Deserialize<'de>,
O::Param: Deserialize<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl<O> Serialize 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>,
O: Serialize,
O::Param: Serialize,
O::Param: Serialize,
O::Param: Serialize,
O::Param: Serialize,
[src]
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>,
O: Serialize,
O::Param: Serialize,
O::Param: Serialize,
O::Param: Serialize,
O::Param: Serialize,
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl<O> ArgminSolver 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>,
[src]
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>,
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
.
fn set_checkpoint_dir(&mut self, dir: &str)
[src]
Set checkpoint directory
fn set_checkpoint_name(&mut self, name: &str)
[src]
Set checkpoint name
fn set_checkpoint_mode(&mut self, mode: CheckpointMode)
[src]
Set checkpoint mode
fn from_checkpoint<P>(path: P) -> Result<Self, Error> where
P: AsRef<Path>,
Self: DeserializeOwned,
[src]
P: AsRef<Path>,
Self: DeserializeOwned,
Load solver from checkpoint
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>,
[src]
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>,
Auto Trait Implementations
impl<O> Send for ConjugateGradient<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 ConjugateGradient<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> From for T
[src]
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
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> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
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> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,