winsfs_core::em

Struct Inspect

Source 
pub struct Inspect<T, F> { /* private fields */ }
Expand description

A combinator for types that allows inspection after each E-step.

To inspect the EM process itself, this can be constructed using EmStep::inspect, which is available on anything implementing Em or StreamingEm. To inspect a stopping rule, this can be constructed using StoppingRule::inspect.

Trait Implementations§

Source§

impl<T: Debug, F: Debug> Debug for Inspect<T, F>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const D: usize, T, F, I> Em<D, I> for Inspect<T, F>
where T: Em<D, I>, F: FnMut(&T, &T::Status, &USfs<D>),

Source§

fn e_step(&mut self, sfs: Sfs<D>, input: &I) -> (Self::Status, USfs<D>)

The E-step of the algorithm. Read more
Source§

fn em_step(&mut self, sfs: Sfs<N>, input: &I) -> (Self::Status, Sfs<N>)

A full EM-step of the algorithm. Read more
Source§

fn em<S>( &mut self, sfs: Sfs<N>, input: &I, stopping_rule: S, ) -> (Self::Status, Sfs<N>)
where S: Stop<Self, Status = Self::Status>,

Runs the EM algorithm until convergence. Read more
Source§

impl<T, F> EmStep for Inspect<T, F>
where T: EmStep,

Source§

type Status = <T as EmStep>::Status

The status returned after each step. Read more
Source§

fn inspect<const N: usize, F>(self, f: F) -> Inspect<Self, F>
where F: FnMut(&Self, &Self::Status, &USfs<N>),

Inspect the status after each E-step.
Source§

impl<T, S, F> Stop<T> for Inspect<S, F>
where T: EmStep, S: Stop<T, Status = T::Status>, F: FnMut(&S),

Source§

type Status = <T as EmStep>::Status

A status from the E-step that may be used for checking convergence.
Source§

fn stop<const D: usize>( &mut self, em: &T, status: &Self::Status, sfs: &Sfs<D>, ) -> bool

Returns true if the algorithm should stop, false otherwise.
Source§

impl<S, F> StoppingRule for Inspect<S, F>
where S: StoppingRule,

Source§

fn and<S>(self, other: S) -> Both<Self, S>
where Self: Sized,

Returns a new stopping rule that requires that both this and another stopping rule must indicicate convergence before stopping.
Source§

fn inspect<F>(self, f: F) -> Inspect<Self, F>
where Self: Sized, F: FnMut(&Self),

Inspect the stopping rule after each E-step. Read more
Source§

fn or<S>(self, other: S) -> Either<Self, S>
where Self: Sized,

Returns a new stopping rule that requires that either this or another stopping rule must indicicate convergence before stopping.
Source§

impl<const D: usize, T, F, R> StreamingEm<D, R> for Inspect<T, F>
where R: Rewind, R::Site: EmSite<D>, T: StreamingEm<D, R>, F: FnMut(&T, &T::Status, &USfs<D>),

Source§

fn stream_e_step( &mut self, sfs: Sfs<D>, reader: &mut R, ) -> Result<(Self::Status, USfs<D>)>

The E-step of the algorithm. Read more
Source§

fn stream_em_step( &mut self, sfs: Sfs<D>, reader: &mut R, ) -> Result<(Self::Status, Sfs<D>)>

A full EM-step of the algorithm. Read more
Source§

fn stream_em<S>( &mut self, sfs: Sfs<D>, reader: &mut R, stopping_rule: S, ) -> Result<(Self::Status, Sfs<D>)>
where S: Stop<Self, Status = Self::Status>,

Runs the EM algorithm until convergence. Read more

Auto Trait Implementations§

§

impl<T, F> Freeze for Inspect<T, F>
where T: Freeze, F: Freeze,

§

impl<T, F> RefUnwindSafe for Inspect<T, F>
where T: RefUnwindSafe, F: RefUnwindSafe,

§

impl<T, F> Send for Inspect<T, F>
where T: Send, F: Send,

§

impl<T, F> Sync for Inspect<T, F>
where T: Sync, F: Sync,

§

impl<T, F> Unpin for Inspect<T, F>
where T: Unpin, F: Unpin,

§

impl<T, F> UnwindSafe for Inspect<T, F>
where T: 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<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> 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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

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

Source§

fn vzip(self) -> V