Skip to main content

EmbeddingGeometry

Struct EmbeddingGeometry 

Source
pub struct EmbeddingGeometry {
    pub n_rows: usize,
    pub h: usize,
    pub common_mode_cos: f32,
    pub mean_pairwise_cos: f32,
    pub eff_rank_raw: f32,
    pub eff_rank_centered: f32,
    pub eff_rank_double_centered: f32,
    pub max_abs_corr: f32,
    pub max_vif: f32,
}
Expand description

Geometry of an embedding table, measured once and handed to the caller to report. A struct of measured scalars; nothing here decides anything.

Fields§

§n_rows: usize

Rows measured (units: cells, genes, modules).

§h: usize

Columns (the embedding dimension h).

§common_mode_cos: f32

Mean |cos| between a row and the mean direction over rows. → 1 means every row is essentially the same direction plus a small residual; → 0 means the rows are spread about the origin.

§mean_pairwise_cos: f32

SIGNED mean cosine over distinct row pairs, zero-norm rows excluded. Computed in closed form from the sum of unit rows, so it is one O(n·h) pass rather than n² pairs. A balanced cloud reads −1/(n−1), not 0.

§eff_rank_raw: f32

Participation ratio (Σλ)² / Σλ² of the uncentered Gram EᵀE/n, in [1, h].

READ THIS AS VARIANCE CONCENTRATION, NOT USEFUL DIMENSIONALITY. A low value says the variance is carried by few directions; it does not say the remaining dims are noise. On real fits this has read under 3 of 16 while the dims beyond the first few still recovered cell type well above a null. Low-variance directions can carry ample signal, and reading this field as a capacity estimate is a mistake that has already been made once.

§eff_rank_centered: f32

Same, for the column-centered Gram. Much larger than Self::eff_rank_raw ⇒ the apparent low rank is a mean offset (a common mode), not a genuine collapse.

§eff_rank_double_centered: f32

Same, after DOUBLE centering: each row’s mean across its h columns removed, then each column’s mean. A log-simplex dictionary is log β_gk = (per-gene share) + (module/topic content) − (per-topic partition), and the two offsets dominate its variance: column centering leaves the per-gene share, row centering leaves the per-topic constant, and either alone reads near 1 with a huge Self::max_vif. Removing both leaves the topic-specific content, which is what “how many directions do the topics use” means for such a table. For an embedding it removes a per-unit depth-like offset the same way. Row centering projects out the all-ones direction, so a genuinely full-rank table reads h − 1 here, not h. No VIF is reported for it: the row-centered columns sum to zero, so their correlation matrix is singular by construction.

§max_abs_corr: f32

Largest |correlation| between two distinct dims.

§max_vif: f32

Largest variance-inflation factor diag(C⁻¹) over dims (1 = orthogonal). Above ~5, per-dim readouts stop being trustworthy on their own.

Trait Implementations§

Source§

impl Clone for EmbeddingGeometry

Source§

fn clone(&self) -> Self

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 Copy for EmbeddingGeometry

Source§

impl Debug for EmbeddingGeometry

Source§

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

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

impl Default for EmbeddingGeometry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for EmbeddingGeometry

Source§

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

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> ErasedDestructor for T
where T: 'static,

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