Struct EinsumNotation 

pub struct EinsumNotation {
    pub inputs: Vec<Vec<EinsumAxis>>,
    pub output: Vec<EinsumAxis>,
}

Rank-unresolved einsum notation.

This is the programmatic counterpart of string notation such as "...ij,...jk->...ik". Resolve it through an einsum operation, after input ranks are known; EinsumSubscripts remains the rank-resolved runtime form.

Examples

use tenferro_einsum::{EinsumAxis, EinsumNotation};
let notation = EinsumNotation::new(&[&[EinsumAxis::Ellipsis]], &[]);
assert_eq!(notation.input_count(), 1);

Fields

inputs: Vec<Vec<EinsumAxis>>

Axis tokens for each input tensor.

output: Vec<EinsumAxis>

Axis tokens for the output tensor.

Implementations

impl EinsumNotation

pub fn new(inputs: &[&[EinsumAxis]], output: &[EinsumAxis]) -> Self

Create rank-unresolved notation from axis-token arrays.

Examples

use tenferro_einsum::{EinsumAxis, EinsumNotation};

let notation = EinsumNotation::new(
    &[&[EinsumAxis::Ellipsis, EinsumAxis::Label(0)], &[EinsumAxis::Ellipsis, EinsumAxis::Label(0)]],
    &[EinsumAxis::Ellipsis],
);
assert_eq!(notation.input_count(), 2);

pub fn input_count(&self) -> usize

Number of input operands described by this notation.

Examples

use tenferro_einsum::{EinsumAxis, EinsumNotation};
let notation = EinsumNotation::new(&[&[EinsumAxis::Ellipsis]], &[]);
assert_eq!(notation.input_count(), 1);

pub fn parse(notation: &str) -> Result<Self>

Parse flat string notation, retaining ellipsis tokens.

Errors

Returns crate::Error::InvalidSubscripts for malformed separators, labels, ellipses, or parenthesized contraction order.

Trait Implementations

impl Clone for EinsumNotation

fn clone(&self) -> EinsumNotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EinsumNotation

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

Formats the value using the given formatter.

impl Eq for EinsumNotation

impl Hash for EinsumNotation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EinsumNotation

fn eq(&self, other: &EinsumNotation) -> 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 EinsumNotation