Struct ConjugateGradientConfig 

pub struct ConjugateGradientConfig<T: RealScalar = f64, B: LinearAlgebra<T> = NalgebraProvider, L = StrongWolfeLineSearch<T, B>> { /* private fields */ }

Configuration for the scalar- and linear-algebra-generic nonlinear conjugate-gradient optimizer.

Implementations

impl<T, B, L> ConjugateGradientConfig<T, B, L>

where T: RealScalar, B: LinearAlgebra<T>,

pub fn new() -> Self

where L: Default,

Create a configuration with default hyperparameters.

pub fn with_line_search<N>( self, line_search: N, ) -> ConjugateGradientConfig<T, B, N>

Replace the line-search implementation, changing the configuration’s line-search type.

pub const fn with_update(self, update: ConjugateGradientUpdate) -> Self

Select the coefficient update formula.

pub fn with_transform<X>(self, transform: X) -> Self

where X: Transform<T, B> + 'static,

Configure a coordinate transform.

Trait Implementations

impl<T, B, L> Default for ConjugateGradientConfig<T, B, L>

where T: RealScalar, B: LinearAlgebra<T>, L: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T: RealScalar, B: LinearAlgebra<T>, L> SupportsParameterNames for ConjugateGradientConfig<T, B, L>

fn get_parameter_names_mut(&mut self) -> &mut Option<Vec<String>>

A helper method to get the mutable internal parameter name storage.

fn with_parameter_names<I, S>(self, parameter_names: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Set the names associated with each parameter.

impl<T, B, L, P, U, E> Terminator<ConjugateGradient<T, B, L>, P, GradientStatus<T, B>, U, E, ConjugateGradientConfig<T, B, L>> for ConjugateGradientGTerminator<T>

where T: RealScalar, B: LinearAlgebra<T> + PseudoInverse<T>, P: Gradient<T, B, U, E>, L: for<'a> LineSearch<T, B, TransformedProblem<'a, P, T, B>, U, E> + Clone + Default + Send + Sync,

fn check_for_termination( &mut self, _current_step: usize, algorithm: &mut ConjugateGradient<T, B, L>, _problem: &P, status: &mut GradientStatus<T, B>, _args: &U, _config: &ConjugateGradientConfig<T, B, L>, ) -> ControlFlow<()>

A termination check which is called on each step of an Algorithm.