Enum Prior 

#[non_exhaustive]
pub enum Prior {
    Discrete {
        points: Vec<C64>,
        probs: Vec<f64>,
    },
    BernoulliGaussian {
        rho: f64,
    },
}

The prior of every entry of $x$.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Discrete

Points of an alphabet and their probabilities.

Fields

points: Vec<C64>

The points.

probs: Vec<f64>

Their probabilities (summing to 1).

BernoulliGaussian

$(1 - \rho)\, \delta(x) + \rho\, \mathcal{N}(0, 1/\rho)$: sparse, of unit variance (Ma & Ping, eq. 43).

Fields

rho: f64

The probability $\rho$ of a non-zero entry.

Implementations

impl Prior

pub fn uniform(c: &Constellation) -> Prior

Equally likely points of a constellation.

pub fn with_probs(c: &Constellation, px: Option<&[f64]>) -> Result<Prior>

The points of a constellation with the probabilities px (normalised; uniform if None).

Errors

Those of Constellation::priors.

pub fn bernoulli_gaussian(rho: f64) -> Result<Prior>

The Bernoulli-Gaussian prior of sparsity rho.

Errors

comnum_core::Error::Config unless $0 < \rho \le 1$.

pub fn mean(&self) -> C64

$\mathbb{E}[X]$.

pub fn variance(&self) -> f64

$\mathrm{Var}[X] = \mathbb{E}|X - \mathbb{E}X|^{2}$.

pub fn denoise(&self, r: C64, tau: f64, domain: Domain) -> (C64, f64)

The posterior mean $F(r, \tau)$ and variance $G(r, \tau)$ of $x$ from $r = x + n$, $n$ of variance $\tau$ in domain (see the module).

pub fn mse(&self, noise_var: f64, gamma2: f64, domain: Domain) -> (f64, f64)

The MSE function $\Psi(\sigma^{2}, \gamma^{2})$ and the variance function $\Phi(\sigma^{2}, \gamma^{2})$ of the denoiser applied with the variance $\gamma^{2}$ to $S + \sigma Z$ (see the module), by Gauss–Hermite quadrature.

Trait Implementations

impl Clone for Prior

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Prior

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

Formats the value using the given formatter.

impl PartialEq for Prior

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Prior