Struct loopybayesnet::LogProbVector

pub struct LogProbVector { /* fields omitted */ }

The representation of a probability vector in log-space

Log-space manipulation of probabilitys is stabler regarding vectors with values very close to 0 or 1. This uses the natural logarithm (base e).

The content of this log-proba vector may not be normalized: adding a constant value to all entries of the vector does not change the normalized probability it represents.

Methods

impl LogProbVector

pub fn uniform(n: usize) -> LogProbVector

Create an unnormalized log-probability vector representing an uniform distribution

pub fn deterministic(n: usize, i: usize) -> LogProbVector

Create an unnormalized log-probability vector representing a deterministic distribution choosing value i from the n possible

If i >= n, this returns a vector assigning 0 probability to every value.

pub fn from_log_probabilities(log_probabilities: Array1<f32>) -> LogProbVector

Wrap an array of log-probabilities into a log-probability vector

pub fn log_probabilities(&self) -> ArrayView1<f32>

Access the underlying array of log-probas

pub fn as_probabilities(&self) -> Array1<f32>

Get the normalized probabilities represented by this log-probability vector

pub fn renormalize(&mut self)

Renormalize the log-probability vector so that its content represent exactly the log of a normalized probability distribution.

pub fn prod(&mut self, other: &LogProbVector)

Multiply the given log-probability vector into this one.

NB: Multiplication is done in probability space, hence the log-probabilities are summed As a result, the log-probability vector will no longer be normalized if it was.

pub fn reset(&mut self)

Resets this log-probas vector to a uniform distribution

Trait Implementations

impl Clone for LogProbVector

fn clone(&self) -> LogProbVector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LogProbVector

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

Formats the value using the given formatter.