Skip to main content

Residual

Struct Residual 

Source
pub struct Residual {
    pub control: Scalar,
    pub cut_back: Scalar,
    pub max_steps: usize,
}
Expand description

The Armijo condition on half the squared norm of the residual.

Fields§

§control: Scalar§cut_back: Scalar§max_steps: usize

Trait Implementations§

Source§

impl Clone for Residual

Source§

fn clone(&self) -> Residual

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Residual

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Residual

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for Residual

Source§

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

Formats the value using the given formatter. Read more
Source§

impl ResidualMerit for Residual

Source§

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. Read more
Source§

const SEARCHES: bool = true

Whether anything is searched at all.
Source§

const MERIT: bool = true

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<A, B, C, I> Component<Coupled<A, B>, Left<I>> for C
where A: Layout, B: Layout, C: Component<A, I>,

Source§

const OFFSET: usize = const OFFSET: usize = C::OFFSET;

Source§

impl<A, B, C, I> Component<Coupled<A, B>, Right<I>> for C
where A: Layout, B: Layout, C: Component<B, I>,

Source§

const OFFSET: usize = const OFFSET: usize = A::STRIDE + C::OFFSET;

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Is<T> for T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.