Struct Matrix 

pub struct Matrix { /* private fields */ }

Matrix itself

Implementations

impl Matrix

pub fn new(data: Vec<Row>) -> Matrix

Return a new matrix with metadata generated.

Arguments

• data - A vector that stores multiple Rows.

Notes

Try to use macros create_matrix!().

use matrix::{create_matrix, create_matrix_row};

let matrix = create_matrix!(
    create_matrix_row!(1.0,2.0),
    create_matrix_row!(3.0,4.0)
);

Trait Implementations

impl Add for Matrix

type Output = Matrix

A new matrix object will be returned.

fn add(self, rhs: Self) -> Self::Output

Perform additions between two matrices and return a result matrix.

Example

  use matrix::{create_matrix, create_matrix_row};

  let lhs = create_matrix!(create_matrix_row!(1.0, 5.0), create_matrix_row!(-4.0, 3.0));
  let rhs = create_matrix!(create_matrix_row!(2.0, -1.0), create_matrix_row!(4.0, -1.0));
  let returning_result = create_matrix!(create_matrix_row!(3.0, 4.0), create_matrix_row!(0.0, 2.0));

impl Debug for Matrix

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

Formats the value using the given formatter.

impl Mul<Matrix> for f32

type Output = Matrix

A new matrix object will be returned.

fn mul(self, matrix: Matrix) -> Self::Output

Perform multiplication between a matrix and a float number, then return a result matrix.

impl Mul for Matrix

type Output = Matrix

A new matrix object will be returned.

fn mul(self, rhs: Self) -> Self::Output

Perform multiplication between two matrices and return a result matrix.

Example 1

use matrix::{create_matrix, create_matrix_row};

let lhs = create_matrix!(create_matrix_row!(1.0, 2.0, 3.0), create_matrix_row!(4.0, 5.0, 6.0));
let rhs = create_matrix!(create_matrix_row!(7.0, 8.0), create_matrix_row!(9.0, 10.0), create_matrix_row!(11.0, 12.0));
let returning_result = create_matrix!(create_matrix_row!(58.0, 64.0), create_matrix_row!(139.0, 154.0));

Example 2

use matrix::{create_matrix, create_matrix_row};

let lhs = create_matrix!(create_matrix_row!(1.0, 2.0, 3.0));
let rhs = create_matrix!(create_matrix_row!(4.0), create_matrix_row!(5.0), create_matrix_row!(6.0));
let return_result = create_matrix!(create_matrix_row!(32.0));

Example 3

use matrix::{create_matrix, create_matrix_row};

let lhs = create_matrix!(create_matrix_row!(4.0), create_matrix_row!(5.0), create_matrix_row!(6.0));
let rhs = create_matrix!(create_matrix_row!(1.0, 2.0, 3.0));
let return_result = create_matrix!(
    create_matrix_row!(4.0, 8.0, 12.0),
    create_matrix_row!(5.0, 10.0, 15.0),
    create_matrix_row!(6.0, 12.0, 18.0)
);

impl PartialEq for Matrix

fn eq(&self, other: &Matrix) -> bool

Compare two matrices with same structure and data.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub for Matrix

Perform substraction between two matrices and return a result matrix.

type Output = Matrix

A new matrix object will be returned.

fn sub(self, rhs: Self) -> Self::Output

Perform substraction between two matrices and return a result matrix.

Example

use matrix::{create_matrix, create_matrix_row};

let lhs = create_matrix!(create_matrix_row!(4.0, 5.0, 6.0), create_matrix_row!(2.0, 3.0, 4.0));
let rhs = create_matrix!(create_matrix_row!(2.0, 4.0, 6.0), create_matrix_row!(1.0, 2.0, 3.0));
let returning_result = create_matrix!(create_matrix_row!(2.0, 1.0, 0.0), create_matrix_row!(1.0, 1.0, 1.0));