Struct argmin::cg::ConjugateGradient

pub struct ConjugateGradient<'a> { /* fields omitted */ }

Conjugate Gradient method struct (duh)

Methods

impl<'a> ConjugateGradient<'a>

fn new() -> Self

Return a ConjugateGradient struct

fn max_iters(&mut self, max_iters: u64) -> &mut Self

Set maximum number of iterations

Trait Implementations

impl<'a> ArgminSolver<'a> for ConjugateGradient<'a>

type Parameter = Array1<f64>

Parameter vector

type CostValue = f64

Cost value

type Hessian = Array2<f64>

Hessian

type StartingPoints = Self::Parameter

Initial parameter(s)

type ProblemDefinition = ArgminOperator<'a>

Type of Problem (TODO: Trait!)

fn init(
    &mut self,
    operator: &'a Self::ProblemDefinition,
    init_param: &Self::StartingPoints
) -> Result<(), Error>

Initialize with a given problem and a starting point

fn next_iter(
    &mut self
) -> Result<ArgminResult<Self::Parameter, Self::CostValue>, Error>

Compute next point

fn terminate(&self) -> TerminationReason

Indicates whether any of the stopping criteria are met

fn run(
    &mut self,
    operator: &'a Self::ProblemDefinition,
    init_param: &Self::StartingPoints
) -> Result<ArgminResult<Self::Parameter, Self::CostValue>, Error>

Run initialization and iterations at once

impl<'a> Default for ConjugateGradient<'a>

fn default() -> Self

Returns the "default value" for a type.