Struct ContractionPlan 

pub struct ContractionPlan {
    pub batch: Vec<u8>,
    pub contracted: Vec<u8>,
    pub free_lhs: Vec<u8>,
    pub free_rhs: Vec<u8>,
}

Contraction plan identifying batch, contracted, and free indices for a 2-input einsum.

• batch: indices in both inputs AND in output (iterated over, not contracted)
• contracted: indices in both inputs but NOT in output (summed over)
• free_lhs: indices only in lhs and output (not in rhs)
• free_rhs: indices only in rhs and output (not in lhs)

Fields

batch: Vec<u8>

Indices in both inputs and the output (iterated over, not contracted).

contracted: Vec<u8>

Indices in both inputs but not the output (summed over).

free_lhs: Vec<u8>

Indices only in the lhs and the output.

free_rhs: Vec<u8>

Indices only in the rhs and the output.

Implementations

impl ContractionPlan

pub fn from_expr(expr: &EinsumExpr) -> ContractionPlan

Derive the batch / contracted / free index partition from a parsed einsum expression.

pub fn lhs_permutation( &self, lhs_indices: &[u8], rhs_indices: &[u8], ) -> Option<Vec<usize>>

Compute LHS permutation to [batch, free_lhs, contracted] order.

pub fn rhs_permutation(&self, rhs_indices: &[u8]) -> Option<Vec<usize>>

Compute RHS permutation to [batch, contracted, free_rhs] order.

Trait Implementations

impl Clone for ContractionPlan

fn clone(&self) -> ContractionPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractionPlan

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

Formats the value using the given formatter.

impl Eq for ContractionPlan

impl PartialEq for ContractionPlan

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