Struct elemental::Matrix

pub struct Matrix { /* private fields */ }

Abstracts over matrices.

Implementations

impl Matrix

pub fn new(rows: usize, cols: usize, vals: Vec<f64>) -> Self

Constructs a new matrix.

pub fn scalar_multiply(&self, scalar: f64) -> Self

Multiplies the given matrix by the given scalar, returning a new matrix.

pub fn rows(&self) -> usize

Gets the number of rows of the matrix.

pub fn cols(&self) -> usize

Gets the number of columns of the matrix.

pub fn copy_vals(&self) -> Vec<f64>

Copies the values of the matrix.

pub fn vals(&self) -> &Vec<f64>

Gets the values of the matrix.

pub fn vals_mut(&mut self) -> &mut Vec<f64>

Gets the values of the matrix, with mutable permission.

pub fn empty() -> Self

Generates an empty matrix.

Trait Implementations

impl Add<Matrix> for Matrix

Defines matrix addition.

type Output = Matrix

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl Clone for Matrix

fn clone(&self) -> Matrix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Matrix

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

Formats the value using the given formatter.

impl Index<[usize; 2]> for Matrix

Defines matrix indexing.

type Output = f64

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<[usize; 2]> for Matrix

Defines matrix indexing with mutable permission.

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

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

impl Mul<Matrix> for Matrix

Defines matrix multiplication.

type Output = Matrix

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl Sub<Matrix> for Matrix

Defines matrix subtraction.

type Output = Matrix

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.