Struct extendr_api::prelude::modules::core::zip::ZipEq

pub struct ZipEq<Rows, Cols, Head, Tail>(/* private fields */)
where
    Head: MatShape<Rows = Rows, Cols = Cols>,
    Tail: MatShape<Rows = Rows, Cols = Cols>;

Zipped matrix views.

Implementations

impl<Rows, Cols, Head, Tail> ZipEq<Rows, Cols, Head, Tail>

where Rows: Copy + Eq + Debug, Cols: Copy + Eq + Debug, Head: MatShape<Rows = Rows, Cols = Cols>, Tail: MatShape<Rows = Rows, Cols = Cols>,

pub fn new(head: Head, tail: Tail) -> ZipEq<Rows, Cols, Head, Tail>

Creates a zipped matrix, after asserting that the dimensions match.

pub fn new_unchecked(head: Head, tail: Tail) -> ZipEq<Rows, Cols, Head, Tail>

Creates a zipped matrix, assuming that the dimensions match.

impl<Head, Tail> ZipEq<(), usize, Head, Tail>

where Head: for<'a> MatIndex<'a, Rows = (), Cols = usize, Index = ((), usize), LayoutTransform = VecLayoutTransform>, Tail: for<'a> MatIndex<'a, Rows = (), Cols = usize, Index = ((), usize), LayoutTransform = VecLayoutTransform>,

pub fn for_each( self, f: impl for<'a> FnMut(<ZipEq<(), usize, Head, Tail> as MatIndex<'a>>::Item), )

Applies f to each element of self.

pub fn for_each_with_index( self, f: impl for<'a> FnMut(usize, <ZipEq<(), usize, Head, Tail> as MatIndex<'a>>::Item), )

Applies f to each element of self, while passing in the index of the current element.

pub fn map<E>( self, f: impl for<'a> FnMut(<ZipEq<(), usize, Head, Tail> as MatIndex<'a>>::Item) -> E, ) -> Row<E>

where E: Entity,

Applies f to each element of self and collect its result into a new row.

impl<Head, Tail> ZipEq<usize, (), Head, Tail>

where Head: for<'a> MatIndex<'a, Rows = usize, Cols = (), Index = (usize, ()), LayoutTransform = VecLayoutTransform>, Tail: for<'a> MatIndex<'a, Rows = usize, Cols = (), Index = (usize, ()), LayoutTransform = VecLayoutTransform>,

pub fn for_each( self, f: impl for<'a> FnMut(<ZipEq<usize, (), Head, Tail> as MatIndex<'a>>::Item), )

Applies f to each element of self.

pub fn for_each_with_index( self, f: impl for<'a> FnMut(usize, <ZipEq<usize, (), Head, Tail> as MatIndex<'a>>::Item), )

Applies f to each element of self, while passing in the index of the current element.

pub fn map<E>( self, f: impl for<'a> FnMut(<ZipEq<usize, (), Head, Tail> as MatIndex<'a>>::Item) -> E, ) -> Col<E>

where E: Entity,

Applies f to each element of self and collect its result into a new column.

impl<Head, Tail> ZipEq<usize, usize, Head, Tail>

where Head: for<'a> MatIndex<'a, Rows = usize, Cols = usize, Index = (usize, usize), LayoutTransform = MatLayoutTransform>, Tail: for<'a> MatIndex<'a, Rows = usize, Cols = usize, Index = (usize, usize), LayoutTransform = MatLayoutTransform>,

pub fn for_each( self, f: impl for<'a> FnMut(<ZipEq<usize, usize, Head, Tail> as MatIndex<'a>>::Item), )

Applies f to each element of self.

pub fn for_each_with_index( self, f: impl for<'a> FnMut(usize, usize, <ZipEq<usize, usize, Head, Tail> as MatIndex<'a>>::Item), )

Applies f to each element of self, while passing the indices of the position of the current element.

pub fn for_each_triangular_lower_with_index( self, diag: Diag, f: impl for<'a> FnMut(usize, usize, <ZipEq<usize, usize, Head, Tail> as MatIndex<'a>>::Item), )

Applies f to each element of the lower triangular half of self, while passing the indices of the position of the current element.

diag specifies whether the diagonal should be included or excluded.

pub fn for_each_triangular_upper_with_index( self, diag: Diag, f: impl for<'a> FnMut(usize, usize, <ZipEq<usize, usize, Head, Tail> as MatIndex<'a>>::Item), )

Applies f to each element of the upper triangular half of self, while passing the indices of the position of the current element.

diag specifies whether the diagonal should be included or excluded.

pub fn for_each_triangular_lower( self, diag: Diag, f: impl for<'a> FnMut(<ZipEq<usize, usize, Head, Tail> as MatIndex<'a>>::Item), )

Applies f to each element of the lower triangular half of self.

diag specifies whether the diagonal should be included or excluded.

pub fn for_each_triangular_upper( self, diag: Diag, f: impl for<'a> FnMut(<ZipEq<usize, usize, Head, Tail> as MatIndex<'a>>::Item), )

Applies f to each element of the upper triangular half of self.

diag specifies whether the diagonal should be included or excluded.

pub fn map<E>( self, f: impl for<'a> FnMut(<ZipEq<usize, usize, Head, Tail> as MatIndex<'a>>::Item) -> E, ) -> Mat<E>

where E: Entity,

Applies f to each element of self and collect its result into a new matrix.

Trait Implementations

impl<Rows, Cols, Head, Tail> Clone for ZipEq<Rows, Cols, Head, Tail>

where Rows: Clone, Cols: Clone, Head: Clone + MatShape<Rows = Rows, Cols = Cols>, Tail: Clone + MatShape<Rows = Rows, Cols = Cols>,

fn clone(&self) -> ZipEq<Rows, Cols, Head, Tail>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Rows, Cols, Head, Tail> Debug for ZipEq<Rows, Cols, Head, Tail>

where Rows: Debug, Cols: Debug, Head: Debug + MatShape<Rows = Rows, Cols = Cols>, Tail: Debug + MatShape<Rows = Rows, Cols = Cols>,

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

Formats the value using the given formatter.

impl<'a, Rows, Cols, Head, Tail> MatIndex<'a> for ZipEq<Rows, Cols, Head, Tail>

where Rows: Debug + Copy + Eq, Cols: Copy + Eq + Debug, Head: MatIndex<'a, Rows = Rows, Cols = Cols>, Tail: MatIndex<'a, Rows = Rows, Cols = Cols, Index = <Head as MaybeContiguous>::Index, LayoutTransform = <Head as MaybeContiguous>::LayoutTransform>,

type Item = Zip<<Head as MatIndex<'a>>::Item, <Tail as MatIndex<'a>>::Item>

Item produced by the zipped views.

unsafe fn get_unchecked( &'a mut self, index: <ZipEq<Rows, Cols, Head, Tail> as MaybeContiguous>::Index, ) -> <ZipEq<Rows, Cols, Head, Tail> as MatIndex<'a>>::Item

Get the item at the given index, skipping bound checks.

unsafe fn get_from_slice_unchecked( slice: &'a mut <ZipEq<Rows, Cols, Head, Tail> as MaybeContiguous>::Slice, idx: usize, ) -> <ZipEq<Rows, Cols, Head, Tail> as MatIndex<'a>>::Item

Get the item at the given slice position, skipping bound checks.

fn is_contiguous(&self) -> bool

Checks if the zipped matrices are contiguous.

fn preferred_layout( &self, ) -> <ZipEq<Rows, Cols, Head, Tail> as MaybeContiguous>::LayoutTransform

Computes the preferred iteration layout of the matrices.

fn with_layout( self, layout: <ZipEq<Rows, Cols, Head, Tail> as MaybeContiguous>::LayoutTransform, ) -> ZipEq<Rows, Cols, Head, Tail>

Applies the layout transformation to the matrices.

impl<Rows, Cols, Head, Tail> MatShape for ZipEq<Rows, Cols, Head, Tail>

where Rows: Copy + Eq + Debug, Cols: Copy + Eq + Debug, Head: MatShape<Rows = Rows, Cols = Cols>, Tail: MatShape<Rows = Rows, Cols = Cols>,

type Rows = Rows

Type of rows.

type Cols = Cols

Type of columns.

fn nrows(&self) -> <ZipEq<Rows, Cols, Head, Tail> as MatShape>::Rows

Returns the number of rows.

fn ncols(&self) -> <ZipEq<Rows, Cols, Head, Tail> as MatShape>::Cols

Returns the number of columns.

impl<Rows, Cols, Head, Tail> MaybeContiguous for ZipEq<Rows, Cols, Head, Tail>

where Rows: Debug + Copy + Eq, Cols: Copy + Eq + Debug, Head: MaybeContiguous<Rows = Rows, Cols = Cols>, Tail: MaybeContiguous<Rows = Rows, Cols = Cols, Index = <Head as MaybeContiguous>::Index, LayoutTransform = <Head as MaybeContiguous>::LayoutTransform>,

type Index = <Head as MaybeContiguous>::Index

Indexing type.

type Slice = Zip<<Head as MaybeContiguous>::Slice, <Tail as MaybeContiguous>::Slice>

Contiguous slice type.

type LayoutTransform = <Head as MaybeContiguous>::LayoutTransform

Layout transformation type.

unsafe fn get_slice_unchecked( &mut self, idx: <ZipEq<Rows, Cols, Head, Tail> as MaybeContiguous>::Index, n_elems: usize, ) -> <ZipEq<Rows, Cols, Head, Tail> as MaybeContiguous>::Slice

Returns slice at index of length n_elems.

impl<Rows, Cols, Head, Tail> Copy for ZipEq<Rows, Cols, Head, Tail>

where Rows: Copy, Cols: Copy, Head: Copy + MatShape<Rows = Rows, Cols = Cols>, Tail: Copy + MatShape<Rows = Rows, Cols = Cols>,