Struct ProductPlan 

pub struct ProductPlan {
    pub layout: Layout,
    pub iteration: Layout,
    pub mappings: [Mapping; 2],
    pub contracted: usize,
}

Layout and reads of an inner product. Contracted axes follow output axes in iteration.

Fields

layout: Layout

iteration: Layout

mappings: [Mapping; 2]

contracted: usize

Implementations

impl ProductPlan

pub fn contracted_len(&self) -> usize

The number of pairings each result folds: the product of the contracted axes’ lengths.

pub fn folded( iteration: Layout, mappings: [Mapping; 2], contracted: usize, ) -> Result<ProductPlan, Error>

pub fn matrix_for(&self, inputs: [Read<'_>; 2]) -> Option<MatrixProduct>

The matrix product that runs this plan, from the iteration axes each operand steps along: its read’s steps where the read reaches its items positionally, and otherwise its mappings entry’s, which says which items it reads. An axis that no read steps along, as a broadcast gives, takes the class of the operands whose free axis mappings makes it, and an axis of one item takes the class of the axis before it. None where the axes don’t fall into frames, rows and columns, in that order.

pub fn dot(_: [&Layout; 2]) -> Result<ProductPlan, Error>

pub fn matrices( inputs: [&Layout; 2], frame: usize, ) -> Result<ProductPlan, Error>

pub fn matrix_axes( _: [&Layout; 2], frame: usize, ) -> Result<((usize, usize), [Vec<usize>; 2]), Error>

The contracted pair and the destinations of each input’s remaining axes, in source order.

pub fn paired( inputs: [&Layout; 2], pairs: &[(usize, usize)], destinations: Option<[Vec<usize>; 2]>, ) -> Result<ProductPlan, Error>

Contracts pairs; optional destinations pair the remaining axes, in each input’s axis order. Without destinations, remaining axes concatenate left then right.

Trait Implementations

impl Clone for ProductPlan

fn clone(&self) -> ProductPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProductPlan

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

Formats the value using the given formatter.