Struct Error 

pub struct Error {
    pub cut_back: Scalar,
    pub max_steps: usize,
}

Backtrack for errors.

Fields

cut_back: Scalar

max_steps: usize

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ObjectiveMerit for Error

const MERIT: bool = false

Whether the value and slope of the merit are read, and so worth preparing.

fn search<X, J, D, W, E>( &self, function: impl FnMut(&X, Scalar) -> Result<Scalar, String>, _jacobian: impl FnMut(&X) -> Result<J, String>, argument: &X, jacobian0: &J, decrement: &D, step_size: Scalar, ) -> Result<Scalar, LineSearchError>

where J: Erase<Erased = E> + Jacobian, D: Erase<Erased = E>, E: Tensor, X: Solution, for<'a> &'a D: Mul<Quantity<W>, Output = X>,

Backtrack along a step of the objective, whose gradient is known.

fn search_merit( &self, merit: impl FnMut(Scalar) -> Result<Scalar, String>, _value: Scalar, _slope: Scalar, step_size: Scalar, ) -> Result<Scalar, LineSearchError>

Backtrack on a merit function of the step size alone.

const SEARCHES: bool = true

Whether anything is searched at all.

impl ResidualMerit for Error

const MERIT: bool = false

Whether the value of the merit is read, and so worth preparing.

fn search_residual( &self, merit: impl FnMut(Scalar) -> Result<Scalar, String>, _value: Scalar, _fraction: Scalar, ) -> Result<Scalar, LineSearchError>

Backtrack on the residual merit of the step size alone.

const SEARCHES: bool = true

Whether anything is searched at all.