Struct Mat 

pub struct Mat<T> { /* private fields */ }

Column-major dense matrix with infallible indexing.

Implementations

impl<T> Mat<T>

pub fn from_vec_col_major(shape: [usize; 2], data: Vec<T>) -> Self

Wrap a column-major buffer.

Panics

Panics if data.len() != nrows * ncols; callers construct the buffer with the matching size.

pub fn from_fn<F: FnMut(&[usize]) -> T>(shape: [usize; 2], f: F) -> Self

Build a matrix by evaluating f(&[i, j]) for every element.

pub fn shape(&self) -> &(usize, usize)

Shape as (nrows, ncols).

pub fn dims(&self) -> [usize; 2]

Shape as [nrows, ncols], the form Mat::from_fn takes.

pub fn dim(&self, axis: usize) -> usize

Extent of axis axis (0 = rows, 1 = columns).

pub fn nrows(&self) -> usize

pub fn ncols(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn as_slice(&self) -> &[T]

Column-major storage.

pub fn as_mut_slice(&mut self) -> &mut [T]

Mutable column-major storage.

pub fn into_vec(self) -> Vec<T>

Consume into the column-major buffer.

pub fn col(&self, j: usize) -> &[T]

Contiguous column j.

pub fn col_mut(&mut self, j: usize) -> &mut [T]

Mutable contiguous column j.

pub fn iter(&self) -> Iter<'_, T>

Iterate over elements in column-major order.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Iterate mutably over elements in column-major order.

pub fn map<U, F: FnMut(&T) -> U>(&self, f: F) -> Mat<U>

Apply f element-wise.

impl<T: Clone> Mat<T>

pub fn from_elem(shape: [usize; 2], elem: T) -> Self

Matrix filled with elem.

pub fn transpose(&self) -> Self

Transposed copy.

pub fn leading_cols(&self, ncols: usize) -> Self

Copy of the leading ncols columns.

impl<T: Clone> Mat<T>

pub fn from_rows(rows: Vec<Vec<T>>) -> Self

Build from a list of rows (row-literal order, column-major storage).

Panics

Panics if the rows have different lengths.

impl<T: Clone + Zero> Mat<T>

pub fn zeros(shape: [usize; 2]) -> Self

Zero matrix.

impl<T: TensorScalar> Mat<T>

pub fn into_typed(self) -> TypedTensor<T, Rank<2>>

Move into a tenferro rank-2 tensor without copying.

pub fn from_typed(t: &TypedTensor<T, Rank<2>>) -> Result<Self, Error>

Copy a host-resident tenferro matrix.

Errors

Returns an error when the tensor is not host-resident compact column-major storage.

Trait Implementations

impl<T: Clone> Clone for Mat<T>

fn clone(&self) -> Mat<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Mat<T>

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

Formats the value using the given formatter.

impl<T> Index<&[usize]> for Mat<T>

type Output = T

The returned type after indexing.

fn index(&self, idx: &[usize]) -> &T

Performs the indexing (container[index]) operation.

impl<T> Index<[usize; 2]> for Mat<T>

type Output = T

The returned type after indexing.

fn index(&self, idx: [usize; 2]) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<[usize; 2]> for Mat<T>

fn index_mut(&mut self, idx: [usize; 2]) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T: PartialEq> PartialEq for Mat<T>

fn eq(&self, other: &Mat<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for Mat<T>