Skip to main content

ConsensusClusters

bixverse_methods::methods::nmf_hals::consensus

Struct ConsensusClusters 

Source 
pub struct ConsensusClusters<F: BixverseFloat> {
    pub labels: Vec<Option<usize>>,
    pub local_density: Vec<F>,
    pub kept: Vec<usize>,
    pub silhouette: Vec<F>,
    pub stability: F,
    pub sizes: Vec<usize>,
    pub consensus: Mat<F>,
    pub n_dropped: usize,
    pub n_empty_clusters: usize,
}
Expand description

Diagnostics from clustering the pooled components at one k.

Fields§

§labels: Vec<Option<usize>>

Cluster label per pooled component, None if the component was dropped. Length k * n_runs, indexed the same way as w_all’s columns.

§local_density: Vec<F>

Mean cosine distance to the nearest neighbours, per pooled component. infinity for components dropped as collapsed. Plot this to pick a density_threshold.

§kept: Vec<usize>

Pooled indices of the surviving components, ascending.

§silhouette: Vec<F>

Silhouette per survivor, aligned with kept.

§stability: F

Mean silhouette over the survivors. The stability score.

§sizes: Vec<usize>

Number of survivors per cluster. Length k.

§consensus: Mat<F>

Per-cluster median component, shape k x dim, rows renormalised to unit L2. dim is the feature count for ConsensusTarget::HRows and the sample count for ConsensusTarget::WColumns.

§n_dropped: usize

Components removed, whether collapsed or filtered out.

§n_empty_clusters: usize

Clusters that ended up with no members.

Trait Implementations§

Source§

impl<F: Clone + BixverseFloat> Clone for ConsensusClusters<F>

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<F: Debug + BixverseFloat> Debug for ConsensusClusters<F>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F> Freeze for ConsensusClusters<F>
where Vec<F>: Freeze, F: Freeze, Mat<Own<F>>: Freeze,

§

impl<F> RefUnwindSafe for ConsensusClusters<F>
where Vec<F>: RefUnwindSafe, F: RefUnwindSafe, Mat<Own<F>>: RefUnwindSafe,

§

impl<F> Send for ConsensusClusters<F>
where Vec<F>: Send, Mat<Own<F>>: Send,

§

impl<F> Sync for ConsensusClusters<F>
where Vec<F>: Sync, Mat<Own<F>>: Sync,

§

impl<F> Unpin for ConsensusClusters<F>
where Vec<F>: Unpin, F: Unpin, Mat<Own<F>>: Unpin,

§

impl<F> UnsafeUnpin for ConsensusClusters<F>
where Vec<F>: UnsafeUnpin, F: UnsafeUnpin, Mat<Own<F>>: UnsafeUnpin,

§

impl<F> UnwindSafe for ConsensusClusters<F>
where Vec<F>: UnwindSafe, F: UnwindSafe, Mat<Own<F>>: UnwindSafe,

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<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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