Skip to main content

RefinementResult

radsym::refine::result

Struct RefinementResult 

Source 
pub struct RefinementResult<H> {
    pub hypothesis: H,
    pub status: RefinementStatus,
    pub residual: Scalar,
    pub iterations: usize,
}
Expand description

Result of a local refinement procedure.

Fields§

§hypothesis: H

The refined hypothesis.

§status: RefinementStatus

Convergence status.

§residual: Scalar

RMS residual of the final fit (meaning depends on the algorithm).

§iterations: usize

Number of iterations performed.

Implementations§

Source§

impl<H> RefinementResult<H>

Source

pub fn converged(&self) -> bool

Whether refinement converged successfully.

Trait Implementations§

Source§

impl<H: Clone> Clone for RefinementResult<H>

Source§

fn clone(&self) -> RefinementResult<H>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<H: Debug> Debug for RefinementResult<H>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<H> Freeze for RefinementResult<H>
where H: Freeze,

§

impl<H> RefUnwindSafe for RefinementResult<H>
where H: RefUnwindSafe,

§

impl<H> Send for RefinementResult<H>
where H: Send,

§

impl<H> Sync for RefinementResult<H>
where H: Sync,

§

impl<H> Unpin for RefinementResult<H>
where H: Unpin,

§

impl<H> UnsafeUnpin for RefinementResult<H>
where H: UnsafeUnpin,

§

impl<H> UnwindSafe for RefinementResult<H>
where H: 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> 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<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> Same for T

Source§

type Output = T

Should always be Self
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> 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, 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.