Struct Found

Source

pub struct Found<X, F> {
    pub x: X,
    pub value: F,
    pub evaluations: usize,
    pub converged: bool,
}

Expand description

What a front found.

Fields§

§x: X

The best point evaluated. For solve_linear, the last iterate.

§value: F

The function’s value at x. For solve and solve_linear, the norm of the residuals there.

§evaluations: usize

How many times the function was evaluated. For solve_linear, how many products with the matrix and its transpose, including one for the residual at x.

§converged: bool

Whether the method’s stopping test passed before the evaluations ran out.

Trait Implementations§

Source §

impl<X: Clone, F: Clone> Clone for Found<X, F>

Source §

fn clone(&self) -> Self

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<X: Debug, F: Debug> Debug for Found<X, F>

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<X: PartialEq, F: PartialEq> PartialEq for Found<X, F>

Source §

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Source §

impl<X: PartialEq, F: PartialEq> StructuralPartialEq for Found<X, F>

Auto Trait Implementations§

§

impl<X, F> Forget for Found<X, F>

§

impl<X, F> Freeze for Found<X, F>
where X: Freeze, F: Freeze,

§

impl<X, F> RefUnwindSafe for Found<X, F>
where X: RefUnwindSafe, F: RefUnwindSafe,

§

impl<X, F> UnwindSafe for Found<X, F>
where X: UnwindSafe, 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §