Struct WindowLogLikelihoodTolerance 

pub struct WindowLogLikelihoodTolerance { /* private fields */ }

A stopping rule for window EM that lets the algorithm run until the successive sum of normalised block log-likelihood values falls below a certain tolerance.

This is analogous to LogLikelihoodTolerance, but instead of considering the full (normalised) data log-likelihood, we consider the sum of these values over blocks.

Implementations

impl WindowLogLikelihoodTolerance

pub fn absolute_difference(&self) -> f64

Returns the absolute difference between the two most recent window log-likelihood values.

pub fn log_likelihood(&self) -> LogLikelihood

Returns the current window log-likelihood value.

pub fn new(tolerance: f64) -> Self

Creates a new stopping rule that allows EM steps until the absolute difference in successive, window log-likelihood values falls below tolerance.

pub fn tolerance(&self) -> f64

Returns the tolerance defining convergence.

Trait Implementations

impl<T> Stop<T> for WindowLogLikelihoodTolerance

where T: EmStep<Status = Vec<SumOf<LogLikelihood>>>,

type Status = <T as EmStep>::Status

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

fn stop<const N: usize>( &mut self, _em: &T, status: &Self::Status, _sfs: &Sfs<N>, ) -> bool

Returns true if the algorithm should stop, false otherwise.

impl StoppingRule for WindowLogLikelihoodTolerance

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.

fn inspect<F>(self, f: F) -> Inspect<Self, F>

where Self: Sized, F: FnMut(&Self),

Inspect the stopping rule after each E-step.

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.