Struct GaussPhiK 

pub struct GaussPhiK { /* private fields */ }

Parameters of a Gaussian potential.

Implementations

impl GaussPhiK

pub fn new(k: Array2<f64>, h: Array1<f64>, g: f64) -> Self

Creates a new Gaussian potential with the given parameters.

Arguments

• k - Precision matrix |X| x |X|.
• h - Information vector |X|.
• g - Log-normalization constant.

Panics

• Panics if k is not square and symmetric.
• Panics if the length of h does not match the size of k.
• Panics if k, h, or g contain non-finite values.

Results

A new Gaussian potential instance.

pub const fn precision_matrix(&self) -> &Array2<f64>

Returns the precision matrix.

Returns

A reference to the precision matrix.

pub const fn information_vector(&self) -> &Array1<f64>

Returns the information vector.

Returns

A reference to the information vector.

pub const fn log_normalization_constant(&self) -> f64

Returns the log-normalization constant.

Returns

The log-normalization constant.

Trait Implementations

impl AbsDiffEq for GaussPhiK

type Epsilon = f64

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl Clone for GaussPhiK

fn clone(&self) -> GaussPhiK

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GaussPhiK

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

Formats the value using the given formatter.

impl PartialEq for GaussPhiK

fn eq(&self, other: &Self) -> 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 RelativeEq for GaussPhiK

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.