Enum MatrixShapeError 

pub enum MatrixShapeError {
    RaggedRows {
        row: usize,
        expected: usize,
        actual: usize,
    },
    ShapeOverflow {
        nrows: usize,
        ncols: usize,
    },
    RowIndexOutOfBounds {
        index: usize,
        nrows: usize,
    },
    ColumnIndexOutOfBounds {
        index: usize,
        ncols: usize,
    },
    DataLengthMismatch {
        actual: usize,
        expected: usize,
    },
}

Error returned when matrix shape or index validation fails.

Constructors use this type for malformed dimensions or payloads. In-place mutation helpers use it to reject caller-supplied indices before changing any matrix values.

Examples

use tensor4all_tensorbackend::{try_from_vec2d, MatrixShapeError};

let err = try_from_vec2d(vec![vec![1.0_f64, 2.0], vec![3.0]]).unwrap_err();
assert!(matches!(
    err,
    MatrixShapeError::RaggedRows {
        row: 1,
        expected: 2,
        actual: 1,
    }
));

Variants

RaggedRows

A later row had a different length than the first row.

Fields

row: usize

Zero-based row number with the mismatched length.

expected: usize

Column count established by the first row.

actual: usize

Actual number of entries in row.

ShapeOverflow

The matrix element count overflowed usize.

Fields

nrows: usize

Number of rows.

ncols: usize

Number of columns.

RowIndexOutOfBounds

The requested row index is outside the matrix.

Fields

index: usize

Rejected zero-based row index.

nrows: usize

Number of rows in the matrix.

ColumnIndexOutOfBounds

The requested column index is outside the matrix.

Fields

index: usize

Rejected zero-based column index.

ncols: usize

Number of columns in the matrix.

DataLengthMismatch

The flat data length did not match the matrix shape.

Fields

actual: usize

Number of supplied elements.

expected: usize

Number of elements implied by the shape.

Trait Implementations

impl Clone for MatrixShapeError

fn clone(&self) -> MatrixShapeError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MatrixShapeError

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

Formats the value using the given formatter.

impl Display for MatrixShapeError

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

Formats the value using the given formatter.

impl Eq for MatrixShapeError

impl Error for MatrixShapeError

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 PartialEq for MatrixShapeError

fn eq(&self, other: &MatrixShapeError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MatrixShapeError