Enum SparseErrors 

pub enum SparseErrors {
    Data2NotAvailable,
    SliceIndexOutOfBounds {
        index: usize,
        len: usize,
    },
    DuplicateSliceIndex(usize),
    SparseMatrixMultiplication {
        n_col_a: usize,
        n_row_b: usize,
    },
    DimensionMisMatchSparse {
        indices_len: usize,
        data_len: usize,
    },
    SparseIndptrInvalid {
        detail: &'static str,
        expected: usize,
        got: usize,
    },
    ShapeMismatchSparse,
    SparseMatrixMustBeCsr,
    SparseMatrixIsolatedRow {
        row: usize,
        row_sum: f64,
    },
    MalformedCsr(&'static str),
    SparseMatrixMustBeCsc,
    ShapeMismatch {
        expected: (usize, usize),
        got: (usize, usize),
    },
}

Error variants raised by the sparse structures and operations.

bixverse-core converts these into the identically named CoreErrors variants, so callers of the core crate keep matching on CoreErrors.

Variants

Data2NotAvailable

Error in situations were data_2 in CompressedSparseData2 is asked for but not available

SliceIndexOutOfBounds

Error if the slice index is out of bounds

Fields

index: usize

The chosen index

len: usize

The actual length

DuplicateSliceIndex(usize)

Error if the slice index is duplicated

SparseMatrixMultiplication

Error for sparse multiplication dimension mismatches

Fields

n_col_a: usize

Number of columns in matrix a

n_row_b: usize

Number of rows in matrix b

DimensionMisMatchSparse

Dimension mismatch error during construction

Fields

indices_len: usize

Length indices

data_len: usize

Length data

SparseIndptrInvalid

Error if the indptr is inconsistent with the shape it declares or with the stored values.

Raised by CompressedSparseData2::validate on input that crossed an FFI boundary, where the struct’s public fields could have been populated with anything.

Fields

detail: &'static str

Which invariant failed

expected: usize

The value implied by the rest of the structure

got: usize

The value actually found

ShapeMismatchSparse

Error if there is a dimension mismatch in terms of the two matrices

SparseMatrixMustBeCsr

Error if the sparse matrix is not in CSR.

SparseMatrixIsolatedRow

A row summed to (effectively) zero where a row-stochastic normalisation was asked for.

On a kNN-derived affinity matrix every node has k out-edges, so a zero row means the kernel weights underflowed rather than that the graph is legitimately disconnected. Anything built on top of the operator would be meaningless, hence an error rather than leaving the row at zero.

Fields

row: usize

The offending row index

row_sum: f64

The row sum that was rejected

MalformedCsr(&'static str)

A CSR matrix failed one of its structural invariants.

Raised by validate_square_csr. The static string names the invariant, because “the graph is malformed” alone leaves the caller to bisect their own input.

SparseMatrixMustBeCsc

Error if the sparse matrix is not in CSC.

ShapeMismatch

Shape mismatch problem for matrices

Fields

expected: (usize, usize)

Expected shape

got: (usize, usize)

Provided shape

Trait Implementations

impl Debug for SparseErrors

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

Formats the value using the given formatter.

impl Display for SparseErrors

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

Formats the value using the given formatter.

impl Error for SparseErrors

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<SparseErrors> for CoreErrors

Maps each SparseErrors variant onto the identically named CoreErrors variant, so callers keep matching on CoreErrors after the sparse structures moved to bixverse-sparse.

fn from(err: SparseErrors) -> CoreErrors

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

Converts to this type from the input type.