Struct NmlMatrix

pub struct NmlMatrix<T> {
    pub num_rows: u32,
    pub num_cols: u32,
    pub data: Box<[T]>,
    pub is_square: bool,
}

Nml_Matrix represents a matrix with a given number of rows and columns, the Data is stored in a one dimensional array using row-major-ordering (data[i][j] = data_new[i * m +j], where m is the number of columns) The Library contains a few methods to create matrices with or without data.

Fields

num_rows: u32

num_cols: u32

data: Box<[T]>

is_square: bool

Implementations

impl<T> NmlMatrix<T>

where T: Num + Copy + Default + Signed + PartialOrd + MulAssign + AddAssign + Display + SampleUniform,

pub fn new(num_rows: u32, num_cols: u32) -> NmlMatrix<T>

creates a matrix without data and reserves the capacity for the Data Vector

pub fn new_with_2d_vec( num_rows: u32, num_cols: u32, data_2d: &mut Vec<Vec<T>>, ) -> Result<Self, NmlError>

use a 2d Vector to initialize the matrix. Each Vector in the 2d Vector is a row and the length of these vectors are the columns

pub fn new_with_data( num_rows: u32, num_cols: u32, data: Box<[T]>, ) -> Result<Self, NmlError>

Constructor that uses a vector to initialize the matrix. checks if the entered rows and columns fit the vector size

pub fn nml_mat_rnd(num_rows: u32, num_cols: u32, minimum: T, maximum: T) -> Self

Returns a matrix with defined size and random data between minimum and maximum values

pub fn nml_mat_sqr(size: u32) -> Self

Creates a square matrix of a given size, where all cells are filled with 0.0

pub fn nml_mat_eye(size: u32) -> Self

creates a identity matrix with the given size

pub fn nml_mat_cp(matrix: &NmlMatrix<T>) -> Self

Creates a new matrix which is a copy of a given matrix. Uses only the reference to the matrix, so that the original matrix is not moved

pub fn equality(&self, matrix: &NmlMatrix<T>) -> bool

Checks if two matrices are equal by checking their dimensions and after that every cell. Method is also used for implementation of trait PatialEq

pub fn equality_in_tolerance(&self, matrix: NmlMatrix<T>, tolerance: T) -> bool

Checks if two matrices are equal with a given tolerance

pub fn at(&self, row: u32, col: u32) -> Result<T, NmlError>

Returns the value a specified at A[i,j]

pub fn get_column(&self, column: u32) -> Result<Self, NmlError>

Returns a result with a specified Column of a matrix, which in itself also is a matrix. If the specified matrix is not in the matrix the result will contain an error

pub fn get_row(&self, row: u32) -> Result<Self, NmlError>

Returns a result which either contains a row of a matrix (which is also a matrix) or a error

pub fn set_value(&mut self, row: u32, col: u32, data: T) -> Result<(), NmlError>

Method sets the value of a given cell in the matrix through a mutable reference

pub fn set_all_values(&mut self, value: T)

Method sets the values of all cells ro a given value

pub fn set_dig_values(&mut self, value: T) -> Result<(), NmlError>

checks if the matrix is square and sets the diagonal values to a given value

pub fn multiply_row_scalar( &mut self, row: u32, scalar: T, ) -> Result<(), NmlError>

multiplies a given row with a given scalar in place. If the row-index is not in the matrix the returned Result will contain an error

pub fn multiply_col_scalar( &mut self, col: u32, scalar: T, ) -> Result<(), NmlError>

multiplies a given column with a given scalar in place. If the row-index is not in the matrix the returned Result will contain an error

pub fn multiply_matrix_scalar(&mut self, scalar: T)

multiplies the matrix in place with a given scalar

pub fn add_rows( &mut self, row_1: u32, scalar_1: T, row_2: u32, scalar_2: T, ) -> Result<(), NmlError>

row_1 is multiplied with scalar_1, this is analog for 2. row_1 will be modified with the solution (row_1 = row_1 * scalar + row_2 * scalar_2)

pub fn swap_rows(&mut self, row_1: u32, row_2: u32) -> Result<(), NmlError>

Method that swaps two given rows of a matrix object in place. Returns either nothing or an NmlError if the specified rows are not in the matrix

pub fn swap_columns(&mut self, col_1: u32, col_2: u32) -> Result<(), NmlError>

Method that swaps two given rows of a matrix object in place. Returns either nothing or an NmlError if the specified rows are not in the matrix

pub fn remove_column(&self, col: u32) -> Result<Self, NmlError>

Tries to remove a column of a matrix and returns the rest of the matrix as a now on. Does not move the original matrix. If the column is not in the original matrix the result will return an error

pub fn remove_row(&self, row: u32) -> Result<Self, NmlError>

Tries to remove a column of a matrix and returns the rest of the matrix as a now on. Does not move the original matrix. If the column is not in the original matrix the result will return an error

pub fn get_sub_mtr( &self, row_start: u32, row_end: u32, col_start: u32, col_end: u32, ) -> Result<Self, NmlError>

pub fn transpose(&self) -> Self

Computes the transpose matrix b’ of a matrix b. This is achieved by going from row-major-ordering to a more efficient storage. The input matrix will not be modified or moved.

pub fn mul_transpose(&self, other: &Self) -> Result<Self, NmlError>

The naive matrix multiplication algorihm applied with the transponse of the one matrix

pub fn mul_naive(&self, other: &Self) -> Result<Self, NmlError>

The naive matrix multiplication algorithm. It iterates trough all values of both matrices. These matrices are not moved or modified

pub fn evcxr_display(&self)

Trait Implementations

impl<T> Add for &NmlMatrix<T>

where T: Num + Copy + Default + Signed + PartialOrd + MulAssign + AddAssign,

type Output = Result<NmlMatrix<T>, NmlError>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add for NmlMatrix<T>

where T: Num + Copy + Default + Signed + PartialOrd + MulAssign + AddAssign,

type Output = Result<NmlMatrix<T>, NmlError>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Debug> Debug for NmlMatrix<T>

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

Formats the value using the given formatter.

impl<T> Display for NmlMatrix<T>

where T: Num + Copy + Default + Signed + PartialOrd + MulAssign + AddAssign + Display,

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

Formats the value using the given formatter.

impl<T> Mul for NmlMatrix<T>

where T: Num + Copy + Default + Signed + PartialOrd + MulAssign + AddAssign + SampleUniform + Display,

type Output = Result<NmlMatrix<T>, NmlError>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> PartialEq for NmlMatrix<T>

where T: Num + Copy + Default + Signed + PartialOrd + MulAssign + AddAssign + SampleUniform + Display,

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

Tests for self and other values to be equal, and is used by ==.

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<T> Sub for &NmlMatrix<T>

where T: Num + Copy + Default + Signed + PartialOrd + MulAssign + AddAssign,

type Output = Result<NmlMatrix<T>, NmlError>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub for NmlMatrix<T>

where T: Num + Copy + Default + Signed + PartialOrd + MulAssign + AddAssign,

type Output = Result<NmlMatrix<T>, NmlError>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Eq for NmlMatrix<T>

where T: Num + Copy + Default + Signed + PartialOrd + MulAssign + AddAssign + SampleUniform + Display,