Struct crabsformer::Matrix

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

Matrix

TODO: add overview about matrix here.

1. how to create a matrix
2. Matrix operation
3. Indexing, etc.

Methods

impl<T> Matrix<T>

pub fn shape(&self) -> [usize; 2]

The shape of the matrix [nrows, ncols].

Examples

let W = matrix![
    3.0, 1.0;
    4.0, 1.0;
    5.0, 9.0;
];
assert_eq!(W.shape(), [3, 2]);

pub fn full(shape: [usize; 2], value: T) -> Matrix<T> where
    T: FromPrimitive + Num + Copy, 

Create a new matrix of given shape shape and type T, filled with value.

Examples

let W = Matrix::full([5, 5], 2.5);

pub fn full_like(m: &Matrix<T>, value: T) -> Matrix<T> where
    T: FromPrimitive + Num + Copy, 

Create a new matrix that have the same shape and type as matrix m, filled with value.

Examples

let w1 = matrix![3.0, 1.0; 4.0, 1.0];
let w2 = Matrix::full_like(&w1, 3.1415);

pub fn zeros(shape: [usize; 2]) -> Matrix<T> where
    T: FromPrimitive + Num + Copy, 

Create a new matrix of given shape shape and type T, filled with zeros. You need to explicitly annotate the numeric type.

Examples

let W: Matrix<i32> = Matrix::zeros([5, 5]);

pub fn zeros_like(m: &Matrix<T>) -> Matrix<T> where
    T: FromPrimitive + Num + Copy, 

Create a new matrix that have the same shape and type as matrix m, filled with zeros.

Examples

let W1 = matrix![3.0, 1.0; 4.0, 1.0];
let W2 = Matrix::zeros_like(&W1);

pub fn ones(shape: [usize; 2]) -> Matrix<T> where
    T: FromPrimitive + Num + Copy, 

Create a new matrix of given shaoe shape and type T, filled with ones. You need to explicitly annotate the numeric type.

Examples

let W: Matrix<i32> = Matrix::ones([3, 5]);

pub fn ones_like(m: &Matrix<T>) -> Matrix<T> where
    T: FromPrimitive + Num + Copy, 

Create a new matrix that have the same shape and type as matrix m, filled with ones.

Examples

let W1 = matrix![3, 1; 4, 1; 5, 9];
let W2 = Matrix::ones_like(&W1);

pub fn power(&self, exp: usize) -> Matrix<T> where
    T: FromPrimitive + Num + Copy, 

Raises each elements of matrix to the power of exp, using exponentiation by squaring.

Examples

let W1 = matrix![3, 1, 4; 1, 5, 9];
let W2 = W1.power(2);
assert_eq!(W2, matrix![9, 1, 16; 1, 25, 81]);

pub fn uniform(shape: [usize; 2], low: T, high: T) -> Matrix<T> where
    T: Num + SampleUniform + Copy, 

Create a new matrix of the given shape shape and populate it with random samples from a uniform distribution over the half-open interval [low, high) (includes low, but excludes high).

Examples

let W = Matrix::uniform([5, 5], 0.0, 1.0);

impl Matrix<f64>

pub fn normal(shape: [usize; 2], mean: f64, std_dev: f64) -> Matrix<f64>

Create a new matrix of the given shape shape and populate it with random samples from a normal distribution N(mean, std_dev**2).

Examples

let W = Matrix::normal([5, 5], 0.0, 1.0); // Gaussian mean=0.0 std_dev=1.0

Trait Implementations

impl<T> PartialEq<Matrix<T>> for Matrix<T> where
    T: Num + Copy, 

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

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

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

This method tests for !=.

impl<T> IntoIterator for Matrix<T>

type Item = Vector<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<Vector<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> From<Vec<Vec<T>>> for Matrix<T> where
    T: Num + Copy, 

fn from(source: Vec<Vec<T>>) -> Self

Performs the conversion.

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

type Output = Vector<T>

The returned type after indexing.

fn index(&self, i: usize) -> &Vector<T>

Performs the indexing (container[index]) operation.