Skip to main content

CoClusterSelectResult

Struct CoClusterSelectResult 

Source
#[non_exhaustive]
pub struct CoClusterSelectResult { pub best: CoClusterResult, pub best_k: usize, pub best_l: usize, pub grid_scores: Vec<(usize, usize, f64, usize, f64)>, pub slope_estimate: f64, pub penalty_rate: f64, }
Expand description

Result of co_cluster_select: the slope-heuristic-selected (K, L) fit together with full grid diagnostics.

§Grid diagnostics

grid_scores contains one entry per (K, L) pair in the sweep: (K, L, log_likelihood, model_dim, penalised_score).

penalised_score = log_likelihood − penalty_rate × model_dim. In fallback branches (single cell, flat slope, small grid) penalised_score = log_likelihood.

§Slope heuristic calibration

The Birgé–Massart penalty is estimated by OLS over the large-model (top-50% by dimension) region of the fitted grid. This is a data-driven heuristic: it works best when the grid spans a range of model dimensions and the data is well-separated enough for the log-likelihood to grow linearly with dimension in the overparameterised region. On poorly separated data the slope may be noisy and the selection may land at a boundary. Inspect grid_scores to audit the selection.

§Divergence from R funHDDC

The slope calibration here uses OLS over the top-50% by model dimension (the “linear region” heuristic of Baudry, Maugis & Michel 2012). R’s funHDDC uses a slightly different calibration based on the full grid. The selected model may differ on small grids.

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.
§best: CoClusterResult

The selected (K*, L*) co-clustering result.

§best_k: usize

Selected number of row clusters K*.

§best_l: usize

Selected number of column clusters L*.

§grid_scores: Vec<(usize, usize, f64, usize, f64)>

All grid fits: (K, L, log_likelihood, model_dim, penalised_score).

penalised_score = log_likelihood − penalty_rate * model_dim. In fallback branches (< 4 grid points, flat slope, etc.) penalised_score = log_likelihood.

§slope_estimate: f64

OLS slope estimated from the top-50% of fits by model dimension. Zero when the grid is too small or the slope heuristic fell back to max-LL.

§penalty_rate: f64

Penalty rate applied per model dimension: 2 × |slope_estimate|. Zero in fallback branches.

Trait Implementations§

Source§

impl Clone for CoClusterSelectResult

Source§

fn clone(&self) -> CoClusterSelectResult

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 CoClusterSelectResult

Source§

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

Formats the value using the given formatter. Read more

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<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