Struct Matrix 

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

A dense 2D matrix in column-major layout.

Access elements with m[[row, col]] syntax. Data is stored contiguously in column-major order, so flat buffers use row + nrows * col.

Examples

use tensor4all_tensorbackend::Matrix;

let mut m = Matrix::zeros(2, 3);
m[[0, 1]] = 5.0_f64;
assert_eq!(m[[0, 1]], 5.0);
assert_eq!(m[[0, 0]], 0.0);
assert_eq!(m.nrows(), 2);
assert_eq!(m.ncols(), 3);

Implementations

impl<T> Matrix<T>

pub fn from_col_major_vec(nrows: usize, ncols: usize, data: Vec<T>) -> Self

Create a matrix from raw column-major data.

Panics

Panics if data.len() != nrows * ncols.

Examples

use tensor4all_tensorbackend::Matrix;

let m = Matrix::from_col_major_vec(2, 2, vec![1.0, 3.0, 2.0, 4.0]);
assert_eq!(m[[0, 0]], 1.0);
assert_eq!(m[[0, 1]], 2.0);
assert_eq!(m[[1, 0]], 3.0);
assert_eq!(m[[1, 1]], 4.0);

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

View the underlying column-major data as a contiguous slice.

Examples

use tensor4all_tensorbackend::Matrix;

let m = Matrix::from_col_major_vec(2, 2, vec![1, 3, 2, 4]);
assert_eq!(m.as_col_major_slice(), &[1, 3, 2, 4]);

pub fn nrows(&self) -> usize

Number of rows

pub fn ncols(&self) -> usize

Number of columns

impl<T: Clone> Matrix<T>

pub fn from_elem(nrows: usize, ncols: usize, elem: T) -> Self

Create a new matrix filled with a constant value.

Examples

use tensor4all_tensorbackend::Matrix;

let m = Matrix::from_elem(2, 3, 7.0);
assert_eq!(m[[0, 0]], 7.0);
assert_eq!(m[[1, 2]], 7.0);

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

pub fn zeros(nrows: usize, ncols: usize) -> Self

Create a zeros matrix

Examples

use tensor4all_tensorbackend::Matrix;

let m = Matrix::<f64>::zeros(2, 3);
assert_eq!(m.nrows(), 2);
assert_eq!(m.ncols(), 3);
assert_eq!(m[[0, 0]], 0.0);
assert_eq!(m[[1, 2]], 0.0);

Trait Implementations

impl<T: Clone> Clone for Matrix<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Matrix<T>

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

Formats the value using the given formatter.

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

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

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

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