Struct RootBracketResult

Source

pub struct RootBracketResult<F: Scalar = f64> { /* private fields */ }

Expand description

Result of an automatic root bracket search, including unsuccessful searches.

Implementations§

Source §

impl<F: Scalar> RootBracketResult<F>

Source

pub fn bracket(&self) -> (F, F)

Ordered, distinct endpoints. On failure these are the outermost samples, which need not bracket a root and may have an overflowing total width.

Source

pub fn values(&self) -> (F, F)

Function values at the returned endpoints.

Source

pub fn iterations(&self) -> u64

Number of expansion rounds that evaluated at least one new point.

Source

pub fn function_evals(&self) -> u64

Number of callback invocations, including all initial points.

Source

pub fn reason(&self) -> BracketTerminationReason

Why the search stopped.

Source

pub fn bracketed(&self) -> bool

Whether the sampled points form a valid bracket.

Trait Implementations§

Source §

impl<F: Clone + Scalar> Clone for RootBracketResult<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<F: Copy + Scalar> Copy for RootBracketResult<F>

Source §

impl<F: Debug + Scalar> Debug for RootBracketResult<F>

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<F: PartialEq + Scalar> PartialEq for RootBracketResult<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<F: PartialEq + Scalar> StructuralPartialEq for RootBracketResult<F>

Auto Trait Implementations§

§

impl<F> Freeze for RootBracketResult<F>
where [Sample<F>; 2]: Freeze,

§

impl<F> RefUnwindSafe for RootBracketResult<F>
where [Sample<F>; 2]: RefUnwindSafe,

§

impl<F> UnwindSafe for RootBracketResult<F>
where [Sample<F>; 2]: 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> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

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

Source §

fn by_ref(&self) -> &T

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> Imply<T> for U
where T: ?Sized, U: ?Sized,

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 §