Struct Agreement 

pub struct Agreement<L = Layout> {
    pub layout: L,
    pub len: usize,
    pub left: Mapping,
    pub right: Mapping,
}

Two arguments paired by broadcasting: the result’s layout, its number of items, and how each argument lays out over it. A caller that adds its own data to layouts can carry its own layout type, through map_layout.

Fields

layout: L

len: usize

left: Mapping

right: Mapping

Implementations

impl Agreement

pub fn new(left: &Layout, right: &Layout) -> Result<Self, Error>

Pairs the axes of left and right: axes with the same name first, then the rest from the front. Where every axis of left pairs and right has more axes, the result takes right’s axis order; otherwise left’s axes come first, then those only right has. A Length error where paired axes have different lengths and neither is 1.

pub fn axis_pairs(left: &Layout, right: &Layout) -> [Vec<usize>; 2]

pub fn onto(left: &Layout, right: &Layout) -> Result<Self, Error>

Pairs the axes of left and right as Agreement::new does, except that where both key an axis, the result keeps left’s keys. An item of right whose key left lacks is never read, and a key of left that right lacks reads as its type’s fill.

pub fn paired_axes( left: &Layout, right: &Layout, positional: bool, ) -> Vec<usize>

For each axis of right, the axis of left that it pairs with, or a new axis after left’s. Axes with the same name pair first. With positional, the remaining axes then pair from the front where their names don’t conflict, as Agreement::new pairs them.

pub fn paired( left: &Layout, right: &Layout, axes: &[usize], ) -> Result<Self, Error>

Pairs each axis of right with the axis of left that axes gives, where an axis past left’s is a new one.

pub fn with_axes( left: &Layout, right: &Layout, axes: &[usize], ) -> Result<Self, Error>

Pairs each axis of the argument with fewer axes with the axis of the other that axes names.

pub fn outer(left: &Layout, right: &Layout) -> Result<Self, Error>

Gives each argument its own result axes. The left argument’s axes come first.

pub fn mapped( left: &Layout, right: &Layout, xa: &[usize], ya: &[usize], left_keys: bool, ) -> Result<Self, Error>

impl<L> Agreement<L>

pub fn map_layout<M>(self, f: impl FnOnce(L) -> M) -> Agreement<M>

The same agreement with f of its layout as the layout.

Trait Implementations

impl<L: Clone> Clone for Agreement<L>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.