Struct rusty_machine::linalg::Matrix

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

The Matrix struct.

Can be instantiated with any type.

Implementations

impl<T> Matrix<T>where
    T: Any + Float,

pub fn qr_decomp(self) -> Result<(Matrix<T>, Matrix<T>), Error>

👎Deprecated

Compute the QR decomposition of the matrix.

Returns the tuple (Q,R).

Note: this function is deprecated in favor of HouseholderQr and will be removed in a future release.

Examples

use rulinalg::matrix::Matrix;

let m = matrix![1.0, 0.5, 0.5;
                0.5, 1.0, 0.5;
                0.5, 0.5, 1.0];

let (q, r) = m.qr_decomp().unwrap();

Failures

• Cannot compute the QR decomposition.

impl<T> Matrix<T>where
    T: Any + Float,

pub fn cholesky(&self) -> Result<Matrix<T>, Error>

👎Deprecated

Cholesky decomposition

Returns the cholesky decomposition of a positive definite matrix.

NOTE: This function is deprecated, and will be removed in a future release. Please see Cholesky for its replacement.

Examples

use rulinalg::matrix::Matrix;

let m = matrix![1.0, 0.5, 0.5;
                0.5, 1.0, 0.5;
                0.5, 0.5, 1.0];

let l = m.cholesky();

Panics

• The matrix is not square.

Failures

• Matrix is not positive definite.

impl<T> Matrix<T>where
    T: Any + Float,

pub fn bidiagonal_decomp(
    self
) -> Result<(Matrix<T>, Matrix<T>, Matrix<T>), Error>

Converts matrix to bidiagonal form

Returns (B, U, V), where B is bidiagonal and self = U B V_T.

Note that if self has self.rows() > self.cols() the matrix will be transposed and then reduced - this will lead to a sub-diagonal instead of super-diagonal.

Failures

• The matrix cannot be reduced to bidiagonal form.

impl<T> Matrix<T>where
    T: Any + Float + Signed,

pub fn svd(self) -> Result<(Matrix<T>, Matrix<T>, Matrix<T>), Error>

Singular Value Decomposition

Computes the SVD using the Golub-Reinsch algorithm.

Returns Σ, U, V, such that self = U Σ V^T. Σ is a diagonal matrix whose elements correspond to the non-negative singular values of the matrix. The singular values are ordered in non-increasing order. U and V have orthonormal columns, and each column represents the left and right singular vectors for the corresponding singular value in Σ, respectively.

If self has M rows and N columns, the dimensions of the returned matrices are as follows.

If M >= N:

• Σ: N x N
• U: M x N
• V: N x N

If M < N:

• Σ: M x M
• U: M x M
• V: N x M

Note: This version of the SVD is sometimes referred to as the ‘economy SVD’.

Failures

This function may fail in some cases. The current decomposition whilst being efficient is fairly basic. Hopefully the algorithm can be made not to fail in the near future.

impl<T> Matrix<T>where
    T: Any + Float,

pub fn upper_hessenberg(self) -> Result<Matrix<T>, Error>

Returns H, where H is the upper hessenberg form.

If the transformation matrix is also required, you should use upper_hess_decomp.

Examples

use rulinalg::matrix::Matrix;

let a = matrix![2., 0., 1., 1.;
                2., 0., 1., 2.;
                1., 2., 0., 0.;
                2., 0., 1., 1.];
let h = a.upper_hessenberg();

println!("{:}", h.expect("Could not get upper Hessenberg form."));

Panics

• The matrix is not square.

Failures

• The matrix cannot be reduced to upper hessenberg form.

pub fn upper_hess_decomp(self) -> Result<(Matrix<T>, Matrix<T>), Error>

Returns (U,H), where H is the upper hessenberg form and U is the unitary transform matrix.

Note: The current transform matrix seems broken…

Examples

use rulinalg::matrix::BaseMatrix;

let a = matrix![1., 2., 3.;
                4., 5., 6.;
                7., 8., 9.];

// u is the transform, h is the upper hessenberg form.
let (u, h) = a.clone().upper_hess_decomp().expect("This matrix should decompose!");

assert_matrix_eq!(h, u.transpose() * a * u, comp = abs, tol = 1e-12);

Panics

• The matrix is not square.

Failures

• The matrix cannot be reduced to upper hessenberg form.

impl<T> Matrix<T>where
    T: Any + Float,

pub fn lup_decomp(self) -> Result<(Matrix<T>, Matrix<T>, Matrix<T>), Error>

👎Deprecated

Computes L, U, and P for LUP decomposition.

Returns L,U, and P respectively.

This function is deprecated. Please see PartialPivLu for a replacement.

Examples

use rulinalg::matrix::Matrix;

let a = matrix![1.0, 2.0, 0.0;
                0.0, 3.0, 4.0;
                5.0, 1.0, 2.0];

let (l, u, p) = a.lup_decomp().expect("This matrix should decompose!");

Panics

• Matrix is not square.

Failures

• Matrix cannot be LUP decomposed.

impl<T> Matrix<T>where
    T: Any + Float + Signed,

pub fn eigenvalues(self) -> Result<Vec<T, Global>, Error>

Eigenvalues of a square matrix.

Returns a Vec of eigenvalues.

Examples

use rulinalg::matrix::Matrix;

let a = Matrix::new(4,4, (1..17).map(|v| v as f64).collect::<Vec<f64>>());
let e = a.eigenvalues().expect("We should be able to compute these eigenvalues!");
println!("{:?}", e);

Panics

• The matrix is not square.

Failures

• Eigenvalues cannot be computed.

pub fn eigendecomp(self) -> Result<(Vec<T, Global>, Matrix<T>), Error>

Eigendecomposition of a square matrix.

Returns a Vec of eigenvalues, and a matrix with eigenvectors as the columns.

The eigenvectors are only gauranteed to be correct if the matrix is real-symmetric.

Examples

use rulinalg::matrix::Matrix;

let a = matrix![3., 2., 4.;
                2., 0., 2.;
                4., 2., 3.];

let (e, m) = a.eigendecomp().expect("We should be able to compute this eigendecomp!");
println!("{:?}", e);
println!("{:?}", m.data());

Panics

• The matrix is not square.

Failures

• The eigen decomposition can not be computed.

impl<T> Matrix<T>

pub fn new<U>(rows: usize, cols: usize, data: U) -> Matrix<T>where
    U: Into<Vec<T, Global>>,

Constructor for Matrix struct.

Requires both the row and column dimensions.

Examples

use rulinalg::matrix::{Matrix, BaseMatrix};

let mat = Matrix::new(2,2, vec![1.0, 2.0, 3.0, 4.0]);

assert_eq!(mat.rows(), 2);
assert_eq!(mat.cols(), 2);

Panics

• The input data does not match the given dimensions.

pub fn from_fn<F>(rows: usize, cols: usize, f: F) -> Matrix<T>where
    F: FnMut(usize, usize) -> T,

Constructor for Matrix struct that takes a function f and constructs a new matrix such that A_ij = f(j, i), where i is the row index and j the column index.

Requires both the row and column dimensions as well as a generating function.

Examples

use rulinalg::matrix::{Matrix, BaseMatrix};

// Let's assume you have an array of "things" for
// which you want to generate a distance matrix:
let things: [i32; 3] = [1, 2, 3];
let distances: Matrix<f64> = Matrix::from_fn(things.len(), things.len(), |col, row| {
    (things[col] - things[row]).abs().into()
});

assert_eq!(distances.rows(), 3);
assert_eq!(distances.cols(), 3);
assert_eq!(distances.data(), &vec![
    0.0, 1.0, 2.0,
    1.0, 0.0, 1.0,
    2.0, 1.0, 0.0,
]);

Warning

This function will be changed in a future release so that A_ij = f(i, j) - to be consistent with the rest of the library.

pub fn data(&self) -> &Vec<T, Global>

Returns a non-mutable reference to the underlying data.

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

Returns a mutable slice of the underlying data.

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

Consumes the Matrix and returns the Vec of data.

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

pub fn zeros(rows: usize, cols: usize) -> Matrix<T>

Constructs matrix of all zeros.

Requires both the row and the column dimensions.

Examples

use rulinalg::matrix::Matrix;

let mat = Matrix::<f64>::zeros(2,3);

pub fn from_diag(diag: &[T]) -> Matrix<T>

Constructs matrix with given diagonal.

Requires slice of diagonal elements.

Examples

use rulinalg::matrix::Matrix;

let mat = Matrix::from_diag(&vec![1.0,2.0,3.0,4.0]);

impl<T> Matrix<T>where
    T: Clone + One,

pub fn ones(rows: usize, cols: usize) -> Matrix<T>

Constructs matrix of all ones.

Requires both the row and the column dimensions.

Examples

use rulinalg::matrix::Matrix;

let mat = Matrix::<f64>::ones(2,3);

impl<T> Matrix<T>where
    T: Clone + Zero + One,

pub fn identity(size: usize) -> Matrix<T>

Constructs the identity matrix.

Requires the size of the matrix.

Examples

use rulinalg::matrix::Matrix;

let I = Matrix::<f64>::identity(4);

impl<T> Matrix<T>where
    T: Float + FromPrimitive,

pub fn mean(&self, axis: Axes) -> Vector<T>

The mean of the matrix along the specified axis.

• Axis Row - Arithmetic mean of rows.
• Axis Col - Arithmetic mean of columns.

Calling mean() on an empty matrix will return an empty matrix.

Examples

use rulinalg::matrix::{Matrix, Axes};

let a = matrix![1.0, 2.0;
                3.0, 4.0];

let c = a.mean(Axes::Row);
assert_eq!(c, vector![2.0, 3.0]);

let d = a.mean(Axes::Col);
assert_eq!(d, vector![1.5, 3.5]);

pub fn variance(&self, axis: Axes) -> Result<Vector<T>, Error>

The variance of the matrix along the specified axis.

• Axis Row - Sample variance of rows.
• Axis Col - Sample variance of columns.

Examples

use rulinalg::matrix::{Matrix, Axes};

let a = matrix![1.0, 2.0;
                3.0, 4.0];

let c = a.variance(Axes::Row).unwrap();
assert_eq!(c, vector![2.0, 2.0]);

let d = a.variance(Axes::Col).unwrap();
assert_eq!(d, vector![0.5, 0.5]);

Failures

• There are one or fewer row/columns in the working axis.

impl<T> Matrix<T>where
    T: Any + Float,

pub fn solve(self, y: Vector<T>) -> Result<Vector<T>, Error>

Solves the equation Ax = y.

Requires a Vector y as input.

The method performs an LU decomposition internally, consuming the matrix in the process. If solving the same system for multiple right-hand sides is desired, see PartialPivLu.

Examples

use rulinalg::matrix::Matrix;
use rulinalg::vector::Vector;

let a = matrix![2.0, 3.0;
                1.0, 2.0];
let y = vector![13.0, 8.0];

let x = a.solve(y).unwrap();

assert_eq!(x, vector![2.0, 3.0]);

Panics

• The matrix column count and vector size are different.
• The matrix is not square.

Failures

• The matrix cannot be decomposed into an LUP form to solve.
• There is no valid solution as the matrix is singular.

pub fn inverse(self) -> Result<Matrix<T>, Error>

Computes the inverse of the matrix.

Internally performs an LU decomposition.

Examples

use rulinalg::matrix::Matrix;

let a = matrix![2., 3.;
                1., 2.];
let inv = a.clone().inverse().expect("This matrix should have an inverse!");

let I = a * inv;

assert_matrix_eq!(I, matrix![1.0, 0.0; 0.0, 1.0]);

Panics

• The matrix is not square.

Failures

• The matrix could not be LUP decomposed.
• The matrix has zero determinant.

pub fn det(self) -> T

Computes the determinant of the matrix.

Examples

let a = matrix![1.0, 2.0, 0.0;
                0.0, 3.0, 4.0;
                5.0, 1.0, 2.0];

let det = a.det();

Panics

• The matrix is not square.

impl<T> Matrix<T>where
    T: ToPrimitive,

pub fn try_into<U>(self) -> Result<Matrix<U>, Error>where
    U: NumCast,

Attempts to convert the matrix into a new matrix of different scalar type.

Failures

• One or more of the elements in the matrix cannot be converted into the new type.

Trait Implementations

impl<'a, T> Add<&'a Matrix<T>> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between two matrices.

This will reuse allocated memory from self.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, m: &Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, T> Add<&'a T> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Scalar addition with matrix.

Will reuse the memory allocated for the existing matrix.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, f: &T) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, T> Add<&'b Matrix<T>> for &'a Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between two matrices.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, m: &Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, T> Add<&'b Matrix<T>> for MatrixSlice<'a, T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, m: &Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, T> Add<&'b Matrix<T>> for MatrixSliceMut<'a, T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, m: &Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, T> Add<&'b MatrixSlice<'a, T>> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, s: &MatrixSlice<'_, T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, T> Add<&'b MatrixSliceMut<'a, T>> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, s: &MatrixSliceMut<'_, T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, T> Add<&'b T> for &'a Matrix<T>where
    T: Copy + Add<T, Output = T>,

Scalar addition with matrix.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, f: &T) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, 'c, T> Add<&'c Matrix<T>> for &'b MatrixSlice<'a, T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, m: &Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, 'c, T> Add<&'c Matrix<T>> for &'b MatrixSliceMut<'a, T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, m: &Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, 'c, T> Add<&'c MatrixSlice<'a, T>> for &'b Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, s: &MatrixSlice<'_, T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, 'c, T> Add<&'c MatrixSliceMut<'a, T>> for &'b Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, s: &MatrixSliceMut<'_, T>) -> Matrix<T>

Performs the + operation.

impl<'a, T> Add<Matrix<T>> for &'a Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between two matrices.

This will reuse allocated memory from m.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, m: Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, T> Add<Matrix<T>> for &'b MatrixSlice<'a, T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, m: Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, T> Add<Matrix<T>> for &'b MatrixSliceMut<'a, T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, m: Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<T> Add<Matrix<T>> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between two matrices.

This will reuse allocated memory from self.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, m: Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, T> Add<Matrix<T>> for MatrixSlice<'a, T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, m: Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, T> Add<Matrix<T>> for MatrixSliceMut<'a, T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, m: Matrix<T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, T> Add<MatrixSlice<'a, T>> for &'b Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, s: MatrixSlice<'_, T>) -> Matrix<T>

Performs the + operation.

impl<'a, T> Add<MatrixSlice<'a, T>> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, s: MatrixSlice<'_, T>) -> Matrix<T>

Performs the + operation.

impl<'a, 'b, T> Add<MatrixSliceMut<'a, T>> for &'b Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, s: MatrixSliceMut<'_, T>) -> Matrix<T>

Performs the + operation.

impl<'a, T> Add<MatrixSliceMut<'a, T>> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, s: MatrixSliceMut<'_, T>) -> Matrix<T>

Performs the + operation.

impl<'a, T> Add<T> for &'a Matrix<T>where
    T: Copy + Add<T, Output = T>,

Scalar addition with matrix.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, f: T) -> Matrix<T>

Performs the + operation.

impl<T> Add<T> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Scalar addition with matrix.

Will reuse the memory allocated for the existing matrix.

type Output = Matrix<T>

The resulting type after applying the + operator.

fn add(self, f: T) -> Matrix<T>

Performs the + operation.

impl<'a, T> AddAssign<&'a Matrix<T>> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition assignment between two matrices.

fn add_assign(&mut self, _rhs: &Matrix<T>)

Performs the += operation.

impl<'a, T> AddAssign<&'a T> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs addition assignment between a matrix and a scalar.

fn add_assign(&mut self, _rhs: &T)

Performs the += operation.

impl<'a, 'b, T> AddAssign<&'b Matrix<T>> for MatrixSliceMut<'a, T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition assignment between two matrices.

fn add_assign(&mut self, _rhs: &Matrix<T>)

Performs the += operation.

impl<'a, 'b, T> AddAssign<&'b MatrixSlice<'a, T>> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition assignment between two matrices.

fn add_assign(&mut self, _rhs: &MatrixSlice<'_, T>)

Performs the += operation.

impl<'a, 'b, T> AddAssign<&'b MatrixSliceMut<'a, T>> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition assignment between two matrices.

fn add_assign(&mut self, _rhs: &MatrixSliceMut<'_, T>)

Performs the += operation.

impl<T> AddAssign<Matrix<T>> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition assignment between two matrices.

fn add_assign(&mut self, _rhs: Matrix<T>)

Performs the += operation.

impl<'a, T> AddAssign<Matrix<T>> for MatrixSliceMut<'a, T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition assignment between two matrices.

fn add_assign(&mut self, _rhs: Matrix<T>)

Performs the += operation.

impl<'a, T> AddAssign<MatrixSlice<'a, T>> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition assignment between two matrices.

fn add_assign(&mut self, _rhs: MatrixSlice<'_, T>)

Performs the += operation.

impl<'a, T> AddAssign<MatrixSliceMut<'a, T>> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs elementwise addition assignment between two matrices.

fn add_assign(&mut self, _rhs: MatrixSliceMut<'_, T>)

Performs the += operation.

impl<T> AddAssign<T> for Matrix<T>where
    T: Copy + Add<T, Output = T>,

Performs addition assignment between a matrix and a scalar.

fn add_assign(&mut self, _rhs: T)

Performs the += operation.

impl<T> BaseMatrix<T> for Matrix<T>

fn rows(&self) -> usize

Rows in the matrix.

fn cols(&self) -> usize

Columns in the matrix.

fn row_stride(&self) -> usize

Row stride in the matrix.

fn is_empty(&self) -> bool

Returns true if the matrix contais no elements

fn as_ptr(&self) -> *const T

Top left index of the matrix.

fn into_matrix(self) -> Matrix<T>where
    T: Copy,

Convert the matrix struct into a owned Matrix.

fn sum(&self) -> Twhere
    T: Copy + Zero<Output = T> + Add<T>,

The sum of all elements in the matrix

fn elemul(&self, m: &Matrix<T>) -> Matrix<T>where
    T: Copy + Mul<T, Output = T>,

The elementwise product of two matrices.

fn elediv(&self, m: &Matrix<T>) -> Matrix<T>where
    T: Copy + Div<T, Output = T>,

The elementwise division of two matrices.

fn vcat<S>(&self, m: &S) -> Matrix<T>where
    T: Copy,
    S: BaseMatrix<T>,

Vertically concatenates two matrices. With self on top.

fn as_slice(&self) -> MatrixSlice<'_, T>

Returns a MatrixSlice over the whole matrix.

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

Get a reference to an element in the matrix without bounds checking.

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

Get a reference to an element in the matrix.

fn col(&self, index: usize) -> Column<'_, T>

Returns the column of a matrix at the given index. None if the index is out of bounds.

unsafe fn col_unchecked(&self, index: usize) -> Column<'_, T>

Returns the column of a matrix at the given index without doing a bounds check.

fn row(&self, index: usize) -> Row<'_, T>

Returns the row of a matrix at the given index.

unsafe fn row_unchecked(&self, index: usize) -> Row<'_, T>

Returns the row of a matrix at the given index without doing unbounds checking

fn iter<'a>(&self) -> SliceIter<'a, T>where
    T: 'a,

Returns an iterator over the matrix data.

fn col_iter(&self) -> Cols<'_, T>

Iterate over the columns of the matrix.

fn row_iter(&self) -> Rows<'_, T>

Iterate over the rows of the matrix.

fn diag_iter(&self, k: DiagOffset) -> Diagonal<'_, T, Self>

Iterate over diagonal entries

fn metric<'a, 'b, B, M>(&'a self, mat: &'b B, metric: M) -> Twhere
    B: 'b + BaseMatrix<T>,
    M: MatrixMetric<'a, 'b, T, Self, B>,

Compute the metric distance between two matrices.

fn diag(&self) -> Diagonal<'_, T, Self>

Extract the diagonal of the matrix

fn split_at(
    &self,
    mid: usize,
    axis: Axes
) -> (MatrixSlice<'_, T>, MatrixSlice<'_, T>)

Split the matrix at the specified axis returning two MatrixSlices.

fn sub_slice<'a>(
    &self,
    start: [usize; 2],
    rows: usize,
    cols: usize
) -> MatrixSlice<'a, T>where
    T: 'a,

Produce a MatrixSlice from an existing matrix.

impl<T> BaseMatrixMut<T> for Matrix<T>

fn as_mut_ptr(&mut self) -> *mut T

Top left index of the slice.

fn as_mut_slice(&mut self) -> MatrixSliceMut<'_, T>

Returns a MatrixSliceMut over the whole matrix.

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

Get a mutable reference to an element in the matrix without bounds checks.

fn get_mut(&mut self, index: [usize; 2]) -> Option<&mut T>

Get a mutable reference to an element in the matrix.

fn iter_mut<'a>(&mut self) -> SliceIterMut<'a, T>where
    T: 'a,

Returns a mutable iterator over the matrix.

fn col_mut(&mut self, index: usize) -> ColumnMut<'_, T>

Returns a mutable reference to the column of a matrix at the given index. None if the index is out of bounds.

unsafe fn col_unchecked_mut(&mut self, index: usize) -> ColumnMut<'_, T>

Returns a mutable reference to the column of a matrix at the given index without doing a bounds check.

fn row_mut(&mut self, index: usize) -> RowMut<'_, T>

Returns a mutable reference to the row of a matrix at the given index. None if the index is out of bounds.

unsafe fn row_unchecked_mut(&mut self, index: usize) -> RowMut<'_, T>

Returns a mutable reference to the row of a matrix at the given index without doing a bounds check.

fn swap_rows(&mut self, a: usize, b: usize)

Swaps two rows in a matrix.

fn swap_cols(&mut self, a: usize, b: usize)

Swaps two columns in a matrix.

fn col_iter_mut(&mut self) -> ColsMut<'_, T>

Iterate over the mutable columns of the matrix.

fn row_iter_mut(&mut self) -> RowsMut<'_, T>

Iterate over the mutable rows of the matrix.

fn diag_iter_mut(&mut self, k: DiagOffset) -> DiagonalMut<'_, T, Self>

Iterate over diagonal entries mutably

fn split_at_mut(
    &mut self,
    mid: usize,
    axis: Axes
) -> (MatrixSliceMut<'_, T>, MatrixSliceMut<'_, T>)

Split the matrix at the specified axis returning two MatrixSliceMuts.

fn sub_slice_mut<'a>(
    &mut self,
    start: [usize; 2],
    rows: usize,
    cols: usize
) -> MatrixSliceMut<'a, T>where
    T: 'a,

Produce a MatrixSliceMut from an existing matrix.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CostFunc<Matrix<f64>> for CrossEntropyError

fn cost(outputs: &Matrix<f64>, targets: &Matrix<f64>) -> f64

The cost function.

fn grad_cost(outputs: &Matrix<f64>, targets: &Matrix<f64>) -> Matrix<f64>

The gradient of the cost function.

impl CostFunc<Matrix<f64>> for MeanSqError

fn cost(outputs: &Matrix<f64>, targets: &Matrix<f64>) -> f64

The cost function.

fn grad_cost(outputs: &Matrix<f64>, targets: &Matrix<f64>) -> Matrix<f64>

The gradient of the cost function.

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

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

Formats the value using the given formatter.

impl<T> Display for Matrix<T>where
    T: Display,

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

Formats the Matrix for display.

impl<'a, T> Div<&'a T> for Matrix<T>where
    T: Copy + Div<T, Output = T>,

Scalar division with matrix.

Will reuse the memory allocated for the existing matrix.

type Output = Matrix<T>

The resulting type after applying the / operator.

fn div(self, f: &T) -> Matrix<T>

Performs the / operation.

impl<'a, 'b, T> Div<&'b T> for &'a Matrix<T>where
    T: Copy + Div<T, Output = T>,

Scalar division with matrix.

type Output = Matrix<T>

The resulting type after applying the / operator.

fn div(self, f: &T) -> Matrix<T>

Performs the / operation.

impl<'a, T> Div<T> for &'a Matrix<T>where
    T: Copy + Div<T, Output = T>,

Scalar division with matrix.

type Output = Matrix<T>

The resulting type after applying the / operator.

fn div(self, f: T) -> Matrix<T>

Performs the / operation.

impl<T> Div<T> for Matrix<T>where
    T: Copy + Div<T, Output = T>,

Scalar division with matrix.

Will reuse the memory allocated for the existing matrix.

type Output = Matrix<T>

The resulting type after applying the / operator.

fn div(self, f: T) -> Matrix<T>

Performs the / operation.

impl<'a, T> DivAssign<&'a T> for Matrix<T>where
    T: Copy + Div<T, Output = T>,

Performs division assignment between a matrix and a scalar.

fn div_assign(&mut self, _rhs: &T)

Performs the /= operation.

impl<T> DivAssign<T> for Matrix<T>where
    T: Copy + Div<T, Output = T>,

Performs division assignment between a matrix and a scalar.

fn div_assign(&mut self, _rhs: T)

Performs the /= operation.

impl<'a, T> From<MatrixSlice<'a, T>> for Matrix<T>where
    T: Copy,

fn from(slice: MatrixSlice<'a, T>) -> Matrix<T>

Converts to this type from the input type.

impl<'a, T> From<MatrixSliceMut<'a, T>> for Matrix<T>where
    T: Copy,

fn from(slice: MatrixSliceMut<'a, T>) -> Matrix<T>

Converts to this type from the input type.

impl<T> From<Vector<T>> for Matrix<T>

fn from(vector: Vector<T>) -> Matrix<T>

Converts to this type from the input type.

impl<'a, T> FromIterator<&'a [T]> for Matrix<T>where
    T: 'a + Copy,

Creates a Matrix from an iterator over slices.

Each of the slices produced by the iterator will become a row in the matrix.

Panics

Will panic if the iterators items do not have constant length.

Examples

We can create a new matrix from some data.

use rulinalg::matrix::{Matrix, BaseMatrix};

let a : Matrix<f64> = vec![4f64; 16].chunks(4).collect();

assert_eq!(a.rows(), 4);
assert_eq!(a.cols(), 4);

We can also do more interesting things.

use rulinalg::matrix::{Matrix, BaseMatrix};

let a = Matrix::new(4,2, (0..8).collect::<Vec<usize>>());

// Here we skip the first row and take only those
// where the first entry is less than 6.
let b = a.row_iter()
         .skip(1)
         .filter(|x| x[0] < 6)
         .collect::<Matrix<usize>>();

// We take the middle rows
assert_eq!(b.into_vec(), vec![2,3,4,5]);

fn from_iter<I>(iterable: I) -> Matrix<T>where
    I: IntoIterator<Item = &'a [T]>,

Creates a value from an iterator.

impl<'a, T> FromIterator<Row<'a, T>> for Matrix<T>where
    T: 'a + Copy,

fn from_iter<I>(iterable: I) -> Matrix<T>where
    I: IntoIterator<Item = Row<'a, T>>,

Creates a value from an iterator.

impl<'a, T> FromIterator<RowMut<'a, T>> for Matrix<T>where
    T: 'a + Copy,

fn from_iter<I>(iterable: I) -> Matrix<T>where
    I: IntoIterator<Item = RowMut<'a, T>>,

Creates a value from an iterator.

impl<T> Hash for Matrix<T>where
    T: Hash,

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given [Hasher].

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

Indexes matrix.

Takes row index first then column.

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 Matrix<T>

Indexes mutable matrix.

Takes row index first then column.

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

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

impl<T: Float> Invertible<Matrix<T>> for MinMaxScaler<T>

fn inv_transform(&self, inputs: Matrix<T>) -> Result<Matrix<T>, Error>

Maps the inputs using the inverse of the fitted transform.

impl<T: Float + FromPrimitive> Invertible<Matrix<T>> for Standardizer<T>

fn inv_transform(&self, inputs: Matrix<T>) -> LearningResult<Matrix<T>>

Maps the inputs using the inverse of the fitted transform.

impl<'a, 'b, T> Mul<&'a Matrix<T>> for Matrix<T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: &Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<&'a PermutationMatrix<T>> for Matrix<T>where
    T: Clone,

Right-multiply a matrix by a permutation matrix.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a PermutationMatrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<&'a T> for Matrix<T>where
    T: Copy + Mul<T, Output = T>,

Scalar multiplication with matrix.

Will reuse the memory allocated for the existing matrix.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, f: &T) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<&'a Vector<T>> for Matrix<T>where
    T: Zero<Output = T> + Mul<T, Output = T> + Add<T> + Copy,

Multiplies matrix by vector.

type Output = Vector<T>

The resulting type after applying the * operator.

fn mul(self, m: &Vector<T>) -> Vector<T>

Performs the * operation.

impl<'a, 'b, T> Mul<&'b Matrix<T>> for &'a Matrix<T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: &Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, T> Mul<&'b Matrix<T>> for MatrixSlice<'a, T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: &Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, T> Mul<&'b Matrix<T>> for MatrixSliceMut<'a, T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: &Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, T> Mul<&'b MatrixSlice<'a, T>> for Matrix<T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: &MatrixSlice<'_, T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, T> Mul<&'b MatrixSliceMut<'a, T>> for Matrix<T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: &MatrixSliceMut<'_, T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, 'm, T> Mul<&'b PermutationMatrix<T>> for &'a Matrix<T>where
    T: Zero + Clone,

Right-multiply a matrix by a permutation matrix.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, rhs: &'b PermutationMatrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, T> Mul<&'b T> for &'a Matrix<T>where
    T: Copy + Mul<T, Output = T>,

Scalar multiplication with matrix.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, f: &T) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, T> Mul<&'b Vector<T>> for &'a Matrix<T>where
    T: Zero<Output = T> + Mul<T, Output = T> + Add<T> + Copy,

Multiplies matrix by vector.

type Output = Vector<T>

The resulting type after applying the * operator.

fn mul(self, v: &Vector<T>) -> Vector<T>

Performs the * operation.

impl<'a, 'b, 'c, T> Mul<&'c Matrix<T>> for &'b MatrixSlice<'a, T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: &Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, 'c, T> Mul<&'c Matrix<T>> for &'b MatrixSliceMut<'a, T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: &Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, 'c, T> Mul<&'c MatrixSlice<'a, T>> for &'b Matrix<T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: &MatrixSlice<'_, T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, 'c, T> Mul<&'c MatrixSliceMut<'a, T>> for &'b Matrix<T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: &MatrixSliceMut<'_, T>) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<Matrix<T>> for &'a Matrix<T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, T> Mul<Matrix<T>> for &'b MatrixSlice<'a, T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, T> Mul<Matrix<T>> for &'b MatrixSliceMut<'a, T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<Matrix<T>> for Matrix<T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<Matrix<T>> for MatrixSlice<'a, T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<Matrix<T>> for MatrixSliceMut<'a, T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: Matrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, T> Mul<MatrixSlice<'a, T>> for &'b Matrix<T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: MatrixSlice<'_, T>) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<MatrixSlice<'a, T>> for Matrix<T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: MatrixSlice<'_, T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'b, T> Mul<MatrixSliceMut<'a, T>> for &'b Matrix<T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: MatrixSliceMut<'_, T>) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<MatrixSliceMut<'a, T>> for Matrix<T>where
    T: Copy + Zero<Output = T> + Add<T> + Mul<T, Output = T> + Any,

Multiplies two matrices together.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, m: MatrixSliceMut<'_, T>) -> Matrix<T>

Performs the * operation.

impl<'a, 'm, T> Mul<PermutationMatrix<T>> for &'a Matrix<T>where
    T: Zero + Clone,

Right-multiply a matrix by a permutation matrix.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, rhs: PermutationMatrix<T>) -> Matrix<T>

Performs the * operation.

impl<T> Mul<PermutationMatrix<T>> for Matrix<T>

Right-multiply a matrix by a permutation matrix.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, rhs: PermutationMatrix<T>) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<T> for &'a Matrix<T>where
    T: Copy + Mul<T, Output = T>,

Scalar multiplication with matrix.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, f: T) -> Matrix<T>

Performs the * operation.

impl<T> Mul<T> for Matrix<T>where
    T: Copy + Mul<T, Output = T>,

Scalar multiplication with matrix.

Will reuse the memory allocated for the existing matrix.

type Output = Matrix<T>

The resulting type after applying the * operator.

fn mul(self, f: T) -> Matrix<T>

Performs the * operation.

impl<'a, T> Mul<Vector<T>> for &'a Matrix<T>where
    T: Zero<Output = T> + Mul<T, Output = T> + Add<T> + Copy,

Multiplies matrix by vector.

type Output = Vector<T>

The resulting type after applying the * operator.

fn mul(self, m: Vector<T>) -> Vector<T>

Performs the * operation.

impl<T> Mul<Vector<T>> for Matrix<T>where
    T: Zero<Output = T> + Mul<T, Output = T> + Add<T> + Copy,

Multiplies matrix by vector.

type Output = Vector<T>

The resulting type after applying the * operator.

fn mul(self, m: Vector<T>) -> Vector<T>

Performs the * operation.

impl<'a, T> MulAssign<&'a T> for Matrix<T>where
    T: Copy + Mul<T, Output = T>,

Performs multiplication assignment between a matrix and a scalar.

fn mul_assign(&mut self, _rhs: &T)

Performs the *= operation.

impl<T> MulAssign<T> for Matrix<T>where
    T: Copy + Mul<T, Output = T>,

Performs multiplication assignment between a matrix and a scalar.

fn mul_assign(&mut self, _rhs: T)

Performs the *= operation.

impl<'a, T> Neg for &'a Matrix<T>where
    T: Neg<Output = T> + Copy,

Gets negative of matrix.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn neg(self) -> Matrix<T>

Performs the unary - operation.

impl<T> Neg for Matrix<T>where
    T: Neg<Output = T> + Copy,

Gets negative of matrix.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn neg(self) -> Matrix<T>

Performs the unary - operation.

impl<T> PartialEq<Matrix<T>> for Matrix<T>where
    T: PartialEq<T>,

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, T> Sub<&'a Matrix<T>> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between two matrices.

This will reuse allocated memory from self.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, m: &Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, T> Sub<&'a T> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Scalar subtraction with matrix.

Will reuse the memory allocated for the existing matrix.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, f: &T) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, T> Sub<&'b Matrix<T>> for &'a Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between two matrices.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, m: &Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, T> Sub<&'b Matrix<T>> for MatrixSlice<'a, T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, m: &Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, T> Sub<&'b Matrix<T>> for MatrixSliceMut<'a, T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, m: &Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, T> Sub<&'b MatrixSlice<'a, T>> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, s: &MatrixSlice<'_, T>) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, T> Sub<&'b MatrixSliceMut<'a, T>> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, s: &MatrixSliceMut<'_, T>) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, T> Sub<&'b T> for &'a Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Scalar subtraction with matrix.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, f: &T) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, 'c, T> Sub<&'c Matrix<T>> for &'b MatrixSlice<'a, T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, m: &Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, 'c, T> Sub<&'c Matrix<T>> for &'b MatrixSliceMut<'a, T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, m: &Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, 'c, T> Sub<&'c MatrixSlice<'a, T>> for &'b Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, s: &MatrixSlice<'_, T>) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, 'c, T> Sub<&'c MatrixSliceMut<'a, T>> for &'b Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, s: &MatrixSliceMut<'_, T>) -> Matrix<T>

Performs the - operation.

impl<'a, T> Sub<Matrix<T>> for &'a Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between two matrices.

This will reuse allocated memory from m.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, m: Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, T> Sub<Matrix<T>> for &'b MatrixSlice<'a, T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, m: Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, T> Sub<Matrix<T>> for &'b MatrixSliceMut<'a, T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, m: Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<T> Sub<Matrix<T>> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between two matrices.

This will reuse allocated memory from self.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, m: Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, T> Sub<Matrix<T>> for MatrixSlice<'a, T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, m: Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, T> Sub<Matrix<T>> for MatrixSliceMut<'a, T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, m: Matrix<T>) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, T> Sub<MatrixSlice<'a, T>> for &'b Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, s: MatrixSlice<'_, T>) -> Matrix<T>

Performs the - operation.

impl<'a, T> Sub<MatrixSlice<'a, T>> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, s: MatrixSlice<'_, T>) -> Matrix<T>

Performs the - operation.

impl<'a, 'b, T> Sub<MatrixSliceMut<'a, T>> for &'b Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, s: MatrixSliceMut<'_, T>) -> Matrix<T>

Performs the - operation.

impl<'a, T> Sub<MatrixSliceMut<'a, T>> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction between Matrix and MatrixSlice.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, s: MatrixSliceMut<'_, T>) -> Matrix<T>

Performs the - operation.

impl<'a, T> Sub<T> for &'a Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Scalar subtraction with matrix.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, f: T) -> Matrix<T>

Performs the - operation.

impl<T> Sub<T> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Scalar subtraction with matrix.

Will reuse the memory allocated for the existing matrix.

type Output = Matrix<T>

The resulting type after applying the - operator.

fn sub(self, f: T) -> Matrix<T>

Performs the - operation.

impl<'a, T> SubAssign<&'a Matrix<T>> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction assignment between two matrices.

fn sub_assign(&mut self, _rhs: &Matrix<T>)

Performs the -= operation.

impl<'a, T> SubAssign<&'a T> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs subtraction assignment between a matrix and a scalar.

fn sub_assign(&mut self, _rhs: &T)

Performs the -= operation.

impl<'a, 'b, T> SubAssign<&'b Matrix<T>> for MatrixSliceMut<'a, T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction assignment between two matrices.

fn sub_assign(&mut self, _rhs: &Matrix<T>)

Performs the -= operation.

impl<'a, 'b, T> SubAssign<&'b MatrixSlice<'a, T>> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction assignment between two matrices.

fn sub_assign(&mut self, _rhs: &MatrixSlice<'_, T>)

Performs the -= operation.

impl<'a, 'b, T> SubAssign<&'b MatrixSliceMut<'a, T>> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction assignment between two matrices.

fn sub_assign(&mut self, _rhs: &MatrixSliceMut<'_, T>)

Performs the -= operation.

impl<T> SubAssign<Matrix<T>> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction assignment between two matrices.

fn sub_assign(&mut self, _rhs: Matrix<T>)

Performs the -= operation.

impl<'a, T> SubAssign<Matrix<T>> for MatrixSliceMut<'a, T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction assignment between two matrices.

fn sub_assign(&mut self, _rhs: Matrix<T>)

Performs the -= operation.

impl<'a, T> SubAssign<MatrixSlice<'a, T>> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction assignment between two matrices.

fn sub_assign(&mut self, _rhs: MatrixSlice<'_, T>)

Performs the -= operation.

impl<'a, T> SubAssign<MatrixSliceMut<'a, T>> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs elementwise subtraction assignment between two matrices.

fn sub_assign(&mut self, _rhs: MatrixSliceMut<'_, T>)

Performs the -= operation.

impl<T> SubAssign<T> for Matrix<T>where
    T: Copy + Sub<T, Output = T>,

Performs subtraction assignment between a matrix and a scalar.

fn sub_assign(&mut self, _rhs: T)

Performs the -= operation.

impl<T: Distribution> SupModel<Matrix<f64>, Matrix<f64>> for NaiveBayes<T>

Train and predict from the Naive Bayes model.

The input matrix must be rows made up of features. The target matrix should have indicator vectors in each row specifying the input class. e.g. [[1,0,0],[0,0,1]] shows class 1 first, then class 3.

fn train(
    &mut self,
    inputs: &Matrix<f64>,
    targets: &Matrix<f64>
) -> LearningResult<()>

Train the model using inputs and targets.

fn predict(&self, inputs: &Matrix<f64>) -> LearningResult<Matrix<f64>>

Predict output from inputs.

impl<T, A> SupModel<Matrix<f64>, Matrix<f64>> for NeuralNet<T, A>where
    T: Criterion,
    A: OptimAlgorithm<BaseNeuralNet<T>>,

Supervised learning for the Neural Network.

The model is trained using back propagation.

fn predict(&self, inputs: &Matrix<f64>) -> LearningResult<Matrix<f64>>

Predict neural network output using forward propagation.

fn train(
    &mut self,
    inputs: &Matrix<f64>,
    targets: &Matrix<f64>
) -> LearningResult<()>

Train the model using gradient optimization and back propagation.

impl<T: Kernel, U: MeanFunc> SupModel<Matrix<f64>, Vector<f64>> for GaussianProcess<T, U>

fn predict(&self, inputs: &Matrix<f64>) -> LearningResult<Vector<f64>>

Predict output from inputs.

fn train(
    &mut self,
    inputs: &Matrix<f64>,
    targets: &Vector<f64>
) -> LearningResult<()>

Train the model using data and outputs.

impl<C: Criterion> SupModel<Matrix<f64>, Vector<f64>> for GenLinearModel<C>

Supervised model trait for the GLM.

Predictions are made from the model by computing g^-1(Xb).

The model is trained using Iteratively Re-weighted Least Squares.

fn predict(&self, inputs: &Matrix<f64>) -> LearningResult<Vector<f64>>

Predict output from inputs.

fn train(
    &mut self,
    inputs: &Matrix<f64>,
    targets: &Vector<f64>
) -> LearningResult<()>

Train the model using inputs and targets.

impl SupModel<Matrix<f64>, Vector<f64>> for LinRegressor

fn train(
    &mut self,
    inputs: &Matrix<f64>,
    targets: &Vector<f64>
) -> LearningResult<()>

Train the linear regression model.

Takes training data and output values as input.

Examples

use rusty_machine::learning::lin_reg::LinRegressor;
use rusty_machine::linalg::Matrix;
use rusty_machine::linalg::Vector;
use rusty_machine::learning::SupModel;

let mut lin_mod = LinRegressor::default();
let inputs = Matrix::new(3,1, vec![2.0, 3.0, 4.0]);
let targets = Vector::new(vec![5.0, 6.0, 7.0]);

lin_mod.train(&inputs, &targets).unwrap();

fn predict(&self, inputs: &Matrix<f64>) -> LearningResult<Vector<f64>>

Predict output value from input data.

Model must be trained before prediction can be made.

impl<A> SupModel<Matrix<f64>, Vector<f64>> for LogisticRegressor<A>where
    A: OptimAlgorithm<BaseLogisticRegressor>,

fn train(
    &mut self,
    inputs: &Matrix<f64>,
    targets: &Vector<f64>
) -> LearningResult<()>

Train the logistic regression model.

Takes training data and output values as input.

Examples

use rusty_machine::learning::logistic_reg::LogisticRegressor;
use rusty_machine::linalg::Matrix;
use rusty_machine::linalg::Vector;
use rusty_machine::learning::SupModel;

let mut logistic_mod = LogisticRegressor::default();
let inputs = Matrix::new(3,2, vec![1.0, 2.0, 1.0, 3.0, 1.0, 4.0]);
let targets = Vector::new(vec![5.0, 6.0, 7.0]);

logistic_mod.train(&inputs, &targets).unwrap();

fn predict(&self, inputs: &Matrix<f64>) -> LearningResult<Vector<f64>>

Predict output value from input data.

Model must be trained before prediction can be made.

impl<K: Kernel> SupModel<Matrix<f64>, Vector<f64>> for SVM<K>

Train the model using the Pegasos algorithm and predict the model output from new data.

fn predict(&self, inputs: &Matrix<f64>) -> LearningResult<Vector<f64>>

Predict output from inputs.

fn train(
    &mut self,
    inputs: &Matrix<f64>,
    targets: &Vector<f64>
) -> LearningResult<()>

Train the model using inputs and targets.

impl<S: KNearestSearch> SupModel<Matrix<f64>, Vector<usize>> for KNNClassifier<S>

fn predict(&self, inputs: &Matrix<f64>) -> LearningResult<Vector<usize>>

Predict output from inputs.

fn train(
    &mut self,
    inputs: &Matrix<f64>,
    targets: &Vector<usize>
) -> LearningResult<()>

Train the model using inputs and targets.

impl<T: Float> TransformFitter<Matrix<T>, MinMaxScaler<T>> for MinMaxFitter<T>

fn fit(self, inputs: &Matrix<T>) -> LearningResult<MinMaxScaler<T>>

Fit the inputs to create the Transformer

impl<T: Float + FromPrimitive> TransformFitter<Matrix<T>, Standardizer<T>> for StandardizerFitter<T>

fn fit(self, inputs: &Matrix<T>) -> LearningResult<Standardizer<T>>

Fit the inputs to create the Transformer

impl<T: Float> Transformer<Matrix<T>> for MinMaxScaler<T>

fn transform(&mut self, inputs: Matrix<T>) -> Result<Matrix<T>, Error>

Transforms the inputs

impl<T: Float, M> Transformer<Matrix<T>> for Normalizer<T, M>where
    for<'a> M: MatrixNorm<T, MatrixSlice<'a, T>>,

fn transform(&mut self, inputs: Matrix<T>) -> Result<Matrix<T>, Error>

Transforms the inputs

impl<R: Rng, T> Transformer<Matrix<T>> for Shuffler<R>

The Shuffler will transform the input Matrix by shuffling its rows in place.

Under the hood this uses a Fisher-Yates shuffle.

fn transform(&mut self, inputs: Matrix<T>) -> LearningResult<Matrix<T>>

Transforms the inputs

impl<T: Float + FromPrimitive> Transformer<Matrix<T>> for Standardizer<T>

fn transform(&mut self, inputs: Matrix<T>) -> LearningResult<Matrix<T>>

Transforms the inputs

impl UnSupModel<Matrix<f64>, Matrix<f64>> for GaussianMixtureModel

fn train(&mut self, inputs: &Matrix<f64>) -> LearningResult<()>

Train the model using inputs.

fn predict(&self, inputs: &Matrix<f64>) -> LearningResult<Matrix<f64>>

Predict output from inputs.

impl UnSupModel<Matrix<f64>, Matrix<f64>> for PCA

Train the model and predict the model output from new data.

fn predict(&self, inputs: &Matrix<f64>) -> LearningResult<Matrix<f64>>

Predict output from inputs.

fn train(&mut self, inputs: &Matrix<f64>) -> LearningResult<()>

Train the model using inputs.

impl UnSupModel<Matrix<f64>, Vector<Option<usize>>> for DBSCAN

fn train(&mut self, inputs: &Matrix<f64>) -> LearningResult<()>

Train the classifier using input data.

fn predict(&self, inputs: &Matrix<f64>) -> LearningResult<Vector<Option<usize>>>

Predict output from inputs.

impl<InitAlg: Initializer> UnSupModel<Matrix<f64>, Vector<usize>> for KMeansClassifier<InitAlg>

fn predict(&self, inputs: &Matrix<f64>) -> LearningResult<Vector<usize>>

Predict classes from data.

Model must be trained.

fn train(&mut self, inputs: &Matrix<f64>) -> LearningResult<()>

Train the classifier using input data.

impl<T> Eq for Matrix<T>where
    T: Eq,

impl<T> StructuralEq for Matrix<T>

impl<T> StructuralPartialEq for Matrix<T>