Trait Normalisation

pub trait Normalisation {
    const NORM: bool;
}

A marker trait for SFS normalisation.

An SFS can either be in a normalised or unnormalised state, i.e. the values of the SFS can either be in probability space or not. When not in probability space, the values are typically in count space, in which case they sum to the number of sites in the input from which the SFS was constructed.

Required Associated Constants

const NORM: bool

A boolean indicating whether the spectrum is normalised.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Normalisation for Norm

const NORM: bool = true

impl Normalisation for Unnorm

const NORM: bool = false