Skip to main content

LineSearchResult

echidna_optim::line_search

Struct LineSearchResult 

Source 
pub struct LineSearchResult<F> {
    pub alpha: F,
    pub value: F,
    pub gradient: Vec<F>,
    pub evals: usize,
}
Expand description

Result of a successful line search.

Fields§

§alpha: F

The accepted step size.

§value: F

Objective value at x + alpha * d.

§gradient: Vec<F>

Gradient at x + alpha * d.

§evals: usize

Number of function evaluations used.

Trait Implementations§

Source§

impl<F: Debug> Debug for LineSearchResult<F>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F> Freeze for LineSearchResult<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for LineSearchResult<F>
where F: RefUnwindSafe,

§

impl<F> Send for LineSearchResult<F>
where F: Send,

§

impl<F> Sync for LineSearchResult<F>
where F: Sync,

§

impl<F> Unpin for LineSearchResult<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for LineSearchResult<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for LineSearchResult<F>
where F: UnwindSafe,

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> 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<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.