Struct Window

pub struct Window<const D: usize> { /* private fields */ }

A window of block SFS estimates, used in window EM.

As part of the window EM algorithm, “windows” of block estimates are averaged out to give a running estimate of the SFS. The “window size” governs the number of past block estimates that are remembered and averaged over.

Implementations

impl<const D: usize> Window<D>

pub fn from_initial(initial: USfs<D>, window_size: usize) -> Self

Creates a new window of with size window_size by repeating a provided SFS.

pub fn from_zeros(shape: [usize; D], window_size: usize) -> Self

Creates a new window of zero-initialised SFS with size window_size.

pub fn shape(&self) -> [usize; D]

Returns the shape of the window.

pub fn window_size(&self) -> usize

Returns the window size, corresponding to the number of past block estimates in the window.

Trait Implementations

impl<const D: usize> Clone for Window<D>

fn clone(&self) -> Window<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const D: usize> Debug for Window<D>

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

Formats the value using the given formatter.

impl<const D: usize> PartialEq for Window<D>

fn eq(&self, other: &Window<D>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const D: usize> StructuralPartialEq for Window<D>