Struct EinBuilder 

pub struct EinBuilder<L: Label = usize> { /* private fields */ }

Builder for constructing einsum specifications.

Example

use omeinsum::EinBuilder;

let ein = EinBuilder::new()
    .input(&[0, 1])      // A[i,j]
    .input(&[1, 2])      // B[j,k]
    .output(&[0, 2])     // C[i,k]
    .size(0, 10)         // i has size 10
    .size(1, 20)         // j has size 20
    .size(2, 30)         // k has size 30
    .build();

Implementations

impl<L: Label> EinBuilder<L>

pub fn new() -> Self

Create a new builder.

pub fn input(self, indices: &[L]) -> Self

Add an input tensor specification.

pub fn output(self, indices: &[L]) -> Self

Set the output specification.

pub fn size(self, index: L, size: usize) -> Self

Set the size for an index.

pub fn sizes(self, sizes: impl IntoIterator<Item = (L, usize)>) -> Self

Set multiple sizes at once.

pub fn build(self) -> Einsum<L>

Build the einsum specification.

Panics

Panics if no output is specified or if sizes are missing.

Trait Implementations

impl<L: Label> Default for EinBuilder<L>

fn default() -> Self

Returns the “default value” for a type.