Enum MethodsErrors 

pub enum MethodsErrors {
    AnnSearchRsError(AnnSearchErrors),
    Core(CoreErrors),
    EdgeRsError(EdgeErrors),
    LimmaMultiCoef {
        n_coef: usize,
    },
    DgeShapeMismatch {
        name: &'static str,
        expected: usize,
        got: usize,
    },
    GraphDirectedError,
    GraphIndexOutOfRange {
        name: &'static str,
        index: usize,
        n_nodes: usize,
    },
    GraphLengthMismatch {
        name: &'static str,
        expected: usize,
        got: usize,
    },
    KnnGraphNeedsDistances,
    MissingNodeTypeWeight(String),
    CommunityAssignmentMismatch,
    PartitionLabelOutOfRange {
        label: usize,
        n_partitions: usize,
    },
    TooManyPartitions {
        n_partitions: usize,
        max: usize,
    },
    NmfRankTooLarge {
        requested: usize,
        available: usize,
    },
    NmfNonFinite,
    NmfNonNegativeViolated,
    NmfConsensusInvalidK {
        k: usize,
    },
    NmfConsensusTooFewRuns {
        n_runs: usize,
    },
    NmfConsensusTooFewComponents {
        k: usize,
        n_surviving: usize,
    },
    NmfConsensusEmptyCluster {
        cluster: usize,
        k: usize,
    },
    NmfKSweepEmptyRange,
    NmfConsensusKMismatch {
        requested: usize,
        restarts: usize,
    },
    NmfDimensionMismatch {
        expected: usize,
        found: usize,
    },
    LdaInvalidTopicCount {
        requested: usize,
        max_available: usize,
    },
    LdaInvalidHyperparameter {
        name: String,
        value: f64,
    },
    LdaEmptyMatrix,
    LdaNonFinite,
    LdaTopNTooLarge {
        requested: usize,
        vocab_size: usize,
    },
    LdaDimensionMismatch {
        expected: usize,
        got: usize,
    },
    FeatureSetIndexOutOfRange {
        set: usize,
        index: usize,
        n_features: usize,
    },
    FeatureSetInvalid {
        set: usize,
        reason: &'static str,
    },
    LmActivityShapeMismatch {
        expected: usize,
        got: usize,
    },
    LmActivityDegreesOfFreedom {
        n_features: usize,
        n_params: usize,
    },
    LmActivityRankDeficient {
        ratio: f64,
    },
    LmActivityNonFinite {
        observation: usize,
    },
}

Error variants raised by bixverse-methods.

Grouped by subsystem.

Variants

AnnSearchRsError(AnnSearchErrors)

Propagates an error from ann-search-rs.

Core(CoreErrors)

Propagates an error from bixverse-core.

EdgeRsError(EdgeErrors)

Propagate errors from the edge-rs crate

LimmaMultiCoef

More than one coefficient was handed to the limma route.

topTable tabulates a single column. Testing several coefficients at once is the moderated F question, which needs top_table_f rather than this chain.

Fields

n_coef: usize

Number of coefficients the caller asked to test together

DgeShapeMismatch

An input vector does not line up with the observations being modelled.

Covers the design rows, the subject labels and the offsets, all of which have to be as long as the cell or sample selection.

Fields

name: &'static str

Which input is the wrong length

expected: usize

What the selection implies

got: usize

What was handed over

GraphDirectedError

Error for algorithms that expect undirected graphs

For methods that expect an undirected graph, but received a directed one.

GraphIndexOutOfRange

A node index in an edge list points outside the graph

Fields

name: &'static str

Which input carried the index

index: usize

The offending index

n_nodes: usize

Number of nodes in the graph

GraphLengthMismatch

A per-node or per-edge input does not line up with the graph

Fields

name: &'static str

Which input is the wrong length

expected: usize

Length the graph implies

got: usize

Length that was supplied

KnnGraphNeedsDistances

The UMAP kNN graph was asked for without kNN distances

MissingNodeTypeWeight(String)

A node type present in the graph has no type weight

CommunityAssignmentMismatch

Error for community membership/graph node number mismatch

In cases where the graph and the community membership do not agree.

PartitionLabelOutOfRange

Error if a partition label sits outside the declared partition count

Fields

label: usize

The offending label

n_partitions: usize

Number of declared partitions

TooManyPartitions

Error if the partition count exceeds what the dense coarsening accepts

Fields

n_partitions: usize

Provided number of partitions

max: usize

The supported maximum

NmfRankTooLarge

NMF Rank is too large for the NNDSVD initialisation

Fields

requested: usize

Requested rank

available: usize

Maximum available rank

NmfNonFinite

Error if NMF values are not finite

NmfNonNegativeViolated

Error if NMF values are negative

NmfConsensusInvalidK

Consensus NMF received a rank that cannot support a silhouette.

Fields

k: usize

Requested rank

NmfConsensusTooFewRuns

Consensus NMF received too few restarts to pool over.

Fields

n_runs: usize

Requested number of restarts

NmfConsensusTooFewComponents

The outlier filter removed so many components that k-means cannot run.

Fields

k: usize

Requested rank

n_surviving: usize

Components left after filtering

NmfConsensusEmptyCluster

k-means returned an empty cluster, so the consensus factor would carry a zero row and the refit would be degenerate.

Fields

cluster: usize

Index of the empty cluster

k: usize

Requested rank

NmfKSweepEmptyRange

The k sweep was handed nothing to sweep over.

NmfConsensusKMismatch

A consensus step was applied to restarts run at a different rank.

Fields

requested: usize

Rank requested for the consensus

restarts: usize

Rank the restarts actually hold

NmfDimensionMismatch

A frozen factor handed to a refit does not line up with V.

Fields

expected: usize

Dimension V expects

found: usize

Dimension the frozen factor provides

LdaInvalidTopicCount

The requested topic count cannot be supported by the corpus.

A topic needs somewhere to put its mass, so k above the vocabulary size leaves topics that no document can ever distinguish.

Fields

requested: usize

Requested number of topics

max_available: usize

Largest topic count the corpus supports

LdaInvalidHyperparameter

A Dirichlet hyperparameter is not strictly positive.

Fields

name: String

Name of the offending hyperparameter

value: f64

Value that was supplied

LdaEmptyMatrix

The document-term matrix carries no counts at all.

LdaNonFinite

A non-finite value reached the variational parameters.

LdaTopNTooLarge

Coherence was asked for more top terms than the vocabulary holds.

Fields

requested: usize

Requested number of top terms per topic

vocab_size: usize

Vocabulary size available

LdaDimensionMismatch

Metric inputs disagree on the number of documents or topics.

Fields

expected: usize

Dimension the model implies

got: usize

Dimension that was supplied

FeatureSetIndexOutOfRange

A feature set points at a feature outside the feature universe.

Fields

set: usize

Index of the offending set

index: usize

The offending feature index

n_features: usize

Size of the feature universe

FeatureSetInvalid

A feature set is empty, repeats a feature, carries a non-finite weight or has a weight vector of the wrong length.

Fields

set: usize

Index of the offending set

reason: &'static str

What is wrong with it

LmActivityShapeMismatch

The data and the feature sets disagree on the number of features.

Fields

expected: usize

Feature universe of the feature sets

got: usize

Features in the data

LmActivityDegreesOfFreedom

The model leaves no residual degrees of freedom.

Fields

n_features: usize

Number of features (the observations of each fit)

n_params: usize

Number of fitted parameters, intercept included

LmActivityRankDeficient

The MLM design is (numerically) rank deficient.

Two sets with identical or proportional weights, or a set covering every feature with one weight (collinear with the intercept), make XᵀX singular.

Fields

ratio: f64

Smallest over largest eigenvalue of XᵀX scaled to unit diagonal

LmActivityNonFinite

An observation holds a NaN or infinite value.

Fields

observation: usize

Index of the observation within the scored batch

Trait Implementations

impl Debug for MethodsErrors

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

Formats the value using the given formatter.

impl Display for MethodsErrors

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

Formats the value using the given formatter.

impl Error for MethodsErrors

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<AnnSearchErrors> for MethodsErrors

fn from(source: AnnSearchErrors) -> MethodsErrors

Converts to this type from the input type.

impl From<CoreErrors> for MethodsErrors

fn from(source: CoreErrors) -> MethodsErrors

Converts to this type from the input type.

impl From<EdgeErrors> for MethodsErrors

fn from(source: EdgeErrors) -> MethodsErrors

Converts to this type from the input type.

impl From<MethodsErrors> for ScErrors

fn from(source: MethodsErrors) -> ScErrors

Converts to this type from the input type.

impl From<SparseErrors> for MethodsErrors

Sparse structure errors surface through the core variant, as before the sparse structures moved to bixverse-sparse.

fn from(err: SparseErrors) -> MethodsErrors

Converts to this type from the input type.