Skip to main content

FitController

Struct FitController 

Source
pub struct FitController<E: Equation + Send + 'static> { /* private fields */ }
Expand description

A running fit that you advance one cycle at a time.

It’s ready to go as soon as it’s built, so the first step runs cycle 1. The accessors read the current state between steps, and finish or into_result turn it into a result.

Implementations§

Source§

impl<E: Equation + Send + 'static> FitController<E>

Source

pub fn step(&mut self) -> Result<Status>

Run one cycle and return the new Status.

Continue means there’s more to do; Stop means the algorithm is finished and further steps won’t change the outcome.

Source

pub fn request_stop(&mut self)

Flag the fit as Aborted so the result shows an early stop.

This only sets the status; it won’t halt a later step, which runs a full cycle and overwrites it. Call it just before into_result.

Source

pub fn cycle(&self) -> usize

The current cycle number (0 before the first step).

Source

pub fn status(&self) -> &Status

The current Status of the fit.

Source

pub fn theta(&self) -> &Theta

The current support points and weights.

Source

pub fn psi(&self) -> &Psi

The current likelihood matrix.

Source

pub fn likelihood(&self) -> f64

The current log-likelihood.

Source

pub fn n2ll(&self) -> f64

The current negative two log-likelihood (objective function).

Source

pub fn error_models(&self) -> &AssayErrorModels

The current error models (updated when the algorithm optimizes them).

Source

pub fn finish(self) -> Result<NonParametricResult<E>>

Run the fit to completion and return the result.

Safe to call anytime: if the fit has already stopped, it just returns the result.

Source

pub fn into_result(self) -> Result<NonParametricResult<E>>

Turn the current state into a result as-is, without running more cycles.

Auto Trait Implementations§

§

impl<E> Freeze for FitController<E>

§

impl<E> !RefUnwindSafe for FitController<E>

§

impl<E> Send for FitController<E>

§

impl<E> Sync for FitController<E>

§

impl<E> Unpin for FitController<E>

§

impl<E> UnsafeUnpin for FitController<E>

§

impl<E> !UnwindSafe for FitController<E>

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

§

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

§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

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

§

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

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> SendAlias for T

§

impl<T> SyncAlias for T