Enum EinsumError 

#[non_exhaustive]
pub enum EinsumError {
    InvalidCharacter {
        position: usize,
        byte: u8,
    },
    MalformedSubscripts {
        position: usize,
        reason: &'static str,
    },
    OperandCountMismatch {
        subscripts: usize,
        operands: usize,
    },
    TooManyLabels {
        operand: usize,
        labels: usize,
        ndim: usize,
    },
    TooFewLabels {
        operand: usize,
        labels: usize,
        ndim: usize,
    },
    DiagonalSizeMismatch {
        operand: usize,
        label: char,
        sizes: (usize, usize),
    },
    BroadcastMismatch {
        label: Option<char>,
        sizes: (usize, usize),
    },
    OutputLabelRepeated {
        label: char,
    },
    OutputLabelUnknown {
        label: char,
    },
    OutputEllipsisMissing {
        broadcast_rank: usize,
    },
    SizeOverflow,
    ShapeMismatch {
        operand: usize,
        expected: Vec<usize>,
        actual: Vec<usize>,
    },
    InvalidPath {
        reason: &'static str,
    },
}

Reports invalid expressions, shapes, and paths.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidCharacter

A byte outside the subscript grammar was found.

Fields

position: usize

Byte position in the supplied string.

byte: u8

Invalid byte.

MalformedSubscripts

An arrow or another grammar element is malformed.

Fields

position: usize

Byte position in the supplied string.

reason: &'static str

Short explanation of the grammar error.

OperandCountMismatch

The number of input groups differs from the operand count.

Fields

subscripts: usize

Number of input groups.

operands: usize

Number of operand shapes or arrays.

TooManyLabels

An operand group names more axes than the operand has.

Fields

operand: usize

Zero-based operand index.

labels: usize

Number of explicit labels.

ndim: usize

Operand rank.

TooFewLabels

An operand without an ellipsis names fewer axes than its rank.

Fields

operand: usize

Zero-based operand index.

labels: usize

Number of labels.

ndim: usize

Operand rank.

DiagonalSizeMismatch

Repeated axes in one operand have different lengths.

Fields

operand: usize

Zero-based operand index.

label: char

Repeated label.

sizes: (usize, usize)

First and conflicting lengths.

BroadcastMismatch

Two axes cannot broadcast to one label size.

Fields

label: Option<char>

Named label, or None for an ellipsis axis.

sizes: (usize, usize)

Conflicting lengths.

OutputLabelRepeated

An explicit output repeats a label.

Fields

label: char

Repeated label.

OutputLabelUnknown

An explicit output names a label absent from every input.

Fields

label: char

Unknown label.

OutputEllipsisMissing

An explicit output omits broadcast axes.

Fields

broadcast_rank: usize

Number of omitted broadcast axes.

SizeOverflow

A required array size does not fit in usize.

ShapeMismatch

Execution operands differ from the shapes bound to a plan.

Fields

operand: usize

Zero-based operand index.

expected: Vec<usize>

Shape stored in the plan.

actual: Vec<usize>

Shape supplied for execution.

InvalidPath

A supplied path cannot reduce the operand list to one value.

Fields

reason: &'static str

Short explanation of the path error.

Trait Implementations

impl Clone for EinsumError

fn clone(&self) -> EinsumError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EinsumError

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

Formats the value using the given formatter.

impl Display for EinsumError

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

Formats the value using the given formatter.

impl Eq for EinsumError

impl Error for EinsumError

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 EinsumError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EinsumError