Struct MultiCcaParams 

pub struct MultiCcaParams<T> {
    pub n_components: usize,
    pub n_iter: usize,
    pub tol: T,
    pub penalties: Option<Vec<T>>,
    pub standardise: bool,
}

Tuning knobs for multi_cca.

Fields

n_components: usize

Number of components to extract.

n_iter: usize

Maximum block coordinate ascent sweeps per component.

tol: T

Relative change in the criterion below which a component has converged.

penalties: Option<Vec<T>>

L1 bound per block. None picks sqrt(p_1) / 2 for every block, which is what DIALOGUE uses; a bound must lie in [1, sqrt(p_k)].

standardise: bool

Centre and scale every column to unit variance first, with an n - 1 denominator. PMA does this unconditionally by default.

Implementations

impl<T: BixverseFloat> MultiCcaParams<T>

pub fn new( n_components: usize, n_iter: usize, tol: T, penalties: Option<Vec<T>>, standardise: bool, ) -> Self

Builds a parameter set.

Params

• n_components - Number of components to extract
• n_iter - Maximum sweeps per component
• tol - Relative convergence tolerance on the criterion
• penalties - Per-block L1 bounds, or None to derive them
• standardise - Centre and scale the columns first

Returns

The parameter set. Nothing is validated here; multi_cca checks the values against the data it is given.

Trait Implementations

impl<T: Clone> Clone for MultiCcaParams<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for MultiCcaParams<T>

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

Formats the value using the given formatter.

impl<T: BixverseFloat> Default for MultiCcaParams<T>

fn default() -> Self

Returns the “default value” for a type.