winsfs_core::em

Struct StandardEm

Source 
pub struct StandardEm<const PAR: bool = false> { /* private fields */ }
Expand description

A runner of the standard EM algorithm.

Whether to parallelise over the input in the E-step is controlled by the PAR parameter.

Implementations§

Source§

impl<const PAR: bool> StandardEm<PAR>

Source

pub fn new() -> Self

Returns a new instance of the runner.

Trait Implementations§

Source§

impl<const PAR: bool> Clone for StandardEm<PAR>

Source§

fn clone(&self) -> StandardEm<PAR>

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<const PAR: bool> Debug for StandardEm<PAR>

Source§

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

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

impl<const PAR: bool> Default for StandardEm<PAR>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<const D: usize, I> Em<D, I> for StandardEm<false>
where for<'a> &'a I: IntoSiteIterator<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<const D: usize, I> Em<D, I> for StandardEm<true>
where for<'a> &'a I: IntoParallelSiteIterator<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<const PAR: bool> EmStep for StandardEm<PAR>

Source§

type Status = SumOf<LogLikelihood>

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<const PAR: bool> PartialEq for StandardEm<PAR>

Source§

fn eq(&self, other: &StandardEm<PAR>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<const D: usize, R> StreamingEm<D, R> for StandardEm<false>
where R: Rewind, R::Site: StreamEmSite<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
Source§

impl<const PAR: bool> Eq for StandardEm<PAR>

Source§

impl<const PAR: bool> StructuralPartialEq for StandardEm<PAR>

Auto Trait Implementations§

§

impl<const PAR: bool> Freeze for StandardEm<PAR>

§

impl<const PAR: bool> RefUnwindSafe for StandardEm<PAR>

§

impl<const PAR: bool> Send for StandardEm<PAR>

§

impl<const PAR: bool> Sync for StandardEm<PAR>

§

impl<const PAR: bool> Unpin for StandardEm<PAR>

§

impl<const PAR: bool> UnwindSafe for StandardEm<PAR>

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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.
Source§

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

Source§

fn vzip(self) -> V