Struct GaussCPDS 

pub struct GaussCPDS { /* private fields */ }

Sample (sufficient) statistics for a Gaussian CPD.

Implementations

impl GaussCPDS

pub fn new( mu_x: Array1<f64>, mu_z: Array1<f64>, m_xx: Array2<f64>, m_xz: Array2<f64>, m_zz: Array2<f64>, n: f64, ) -> Self

Creates a new GaussCPDS instance.

Arguments

• mu_x - Response mean vector |X|.
• mu_z - Design mean vector |Z|.
• m_xx - Response covariance (uncentered) matrix |X| x |X|.
• m_xz - Cross-covariance (uncentered) matrix |X| x |Z|.
• m_zz - Design covariance (uncentered) matrix |Z| x |Z|.
• n - Sample size.

Panics

• Panics if mu_x length does not match m_xx size.
• Panics if mu_z length does not match m_zz size.
• Panics if m_xx is not square.
• Panics if the number of rows of m_xz does not match the size of m_xx.
• Panics if the number of columns of m_xz does not match the size of m_zz.
• Panics if m_zz is not square.
• Panics if any of the values in mu_x, mu_z, m_xx, m_xz, or m_zz are not finite.
• Panics if n is not finite or is negative.

Returns

A new GaussCPDS instance.

pub fn sample_response_mean(&self) -> &Array1<f64>

Returns the response mean vector |X|.

Returns

A reference to the response mean vector.

pub fn sample_design_mean(&self) -> &Array1<f64>

Returns the design mean vector |Z|.

Returns

A reference to the design mean vector.

pub fn sample_response_covariance(&self) -> Array2<f64>

Returns the response covariance matrix |X| x |X|.

Returns

A reference to the response covariance matrix.

pub fn sample_cross_covariance(&self) -> Array2<f64>

Returns the cross-covariance matrix |X| x (|Z| + 1).

Returns

A reference to the cross-covariance matrix.

pub fn sample_design_covariance(&self) -> Array2<f64>

Returns the design covariance matrix (|Z| + 1) x (|Z| + 1).

Returns

A reference to the design covariance matrix.

pub fn sample_size(&self) -> f64

Returns the sample size.

Returns

The sample size.

Trait Implementations

impl Add for GaussCPDS

type Output = GaussCPDS

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for GaussCPDS

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl CSSEstimator<GaussCPDS> for SSE<'_, GaussTable>

fn fit(&self, x: &Set<usize>, z: &Set<usize>) -> GaussCPDS

Fits the estimator to the dataset and returns the conditional sufficient statistics.

impl CSSEstimator<GaussCPDS> for SSE<'_, GaussWtdTable>

fn fit(&self, x: &Set<usize>, z: &Set<usize>) -> GaussCPDS

Fits the estimator to the dataset and returns the conditional sufficient statistics.

impl Clone for GaussCPDS

fn clone(&self) -> GaussCPDS

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GaussCPDS

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GaussCPDS

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ParCSSEstimator<GaussCPDS> for SSE<'_, GaussTable>

fn par_fit(&self, x: &Set<usize>, z: &Set<usize>) -> GaussCPDS

Fits the estimator to the dataset and returns the conditional sufficient statistics in parallel.

impl ParCSSEstimator<GaussCPDS> for SSE<'_, GaussWtdTable>

fn par_fit(&self, x: &Set<usize>, z: &Set<usize>) -> GaussCPDS

Fits the estimator to the dataset and returns the conditional sufficient statistics in parallel.

impl Serialize for GaussCPDS

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.