Skip to main content

CoClusterResult

Struct CoClusterResult 

Source
#[non_exhaustive]
pub struct CoClusterResult { pub row_labels: Vec<usize>, pub col_labels: Vec<usize>, pub n_row_blocks: usize, pub n_col_blocks: usize, pub block_params: Vec<BlockParams>, pub row_props: Vec<f64>, pub col_props: Vec<f64>, pub log_likelihood: f64, pub icl: f64, pub iterations: usize, pub converged: bool, }
Expand description

Result of co_cluster.

The block structure is indexed as block_params[k * n_col_blocks + l] where k ∈ 0..n_row_blocks and l ∈ 0..n_col_blocks.

§ICL formula

The ICL (Integrated Completed Likelihood) uses the symmetric Govaert-Nadif penalty:

p_KL = (K-1) + (L-1) + 2 * K * L * eff_ncomp
ICL   = log_likelihood - 0.5 * p_KL * (ln(n) + ln(m))

Here ln(n) penalises the n-curve row dimension and ln(m) penalises the m-argument-point column dimension — reflecting that column-clusters partition the m argument points (not the FPC components).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§row_labels: Vec<usize>

Hard row-cluster assignments, length n. Values in 0..n_row_blocks.

§col_labels: Vec<usize>

Hard column-cluster assignments, length m (the number of argument points).

Values in 0..n_col_blocks. This always satisfies col_labels.len() == m — columns cluster the argument points, NOT the FPC components.

§n_row_blocks: usize

Number of row clusters K.

§n_col_blocks: usize

Number of column clusters L.

§block_params: Vec<BlockParams>

Per-block Gaussian parameters, length K*L, indexed k*L + l. Each element describes the diagonal Gaussian on the eff_ncomp-dimensional block scores for the (k, l) block.

§row_props: Vec<f64>

Mixing proportions for row clusters, length K. Sums to 1.

§col_props: Vec<f64>

Mixing proportions for column clusters, length L. Sums to 1.

§log_likelihood: f64

Converged classification log-likelihood (non-decreasing across CEM iterations).

§icl: f64

ICL model-selection criterion (finite; lower = better model).

Formula: ICL = log_likelihood - 0.5 * p_KL * (ln(n) + ln(m)) where p_KL = (K-1) + (L-1) + 2*K*L*eff_ncomp.

§iterations: usize

Number of CEM iterations performed.

§converged: bool

Whether the algorithm converged before max_iter.

Trait Implementations§

Source§

impl Clone for CoClusterResult

Source§

fn clone(&self) -> CoClusterResult

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CoClusterResult

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for CoClusterResult

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CoClusterResult

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V