Struct Matrix

pub struct Matrix { /* private fields */ }

A simple 2-dimensional matrix with basic operations

Implementations

impl Matrix

pub fn new(rows: usize, cols: usize) -> Self

Creates a new matrix with the given number of rows and columns, initialized to zero.

pub fn random(rng: &mut StdRng, rows: usize, cols: usize) -> Self

Creates a new matrix with the given number of rows and columns, initialized with random values between -1.0 and 1.0.

pub fn from_vec(rows: usize, cols: usize, data: Vec<f64>) -> Self

Creates a new matrix from a 2D vector. The outer vector represents the rows, and the inner vectors represent the columns. Panics if the inner vectors have different lengths.

pub fn from_col_vec(data: Vec<f64>) -> Self

Creates a new matrix from a column vector.

pub fn transpose(&self) -> Self

Transposes the matrix.

pub fn rows(&self) -> usize

Returns the number of rows in the matrix.

pub fn cols(&self) -> usize

Returns the number of columns in the matrix.

pub fn col(&self, col: usize) -> Vec<f64>

Returns the column at the given index as a vector. Panics if the index is out of bounds.

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

Returns a reference to the data in the matrix.

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

Returns a mutable reference to the data in the matrix.

pub fn get(&self, row: usize, col: usize) -> f64

Returns the value at the given row and column. Panics if the indices are out of bounds.

pub fn get_mut(&mut self, row: usize, col: usize) -> &mut f64

Returns a mutable reference to the value at the given row and column. Panics if the indices are out of bounds.

pub fn set(&mut self, row: usize, col: usize, value: f64)

Sets the value at the given row and column. Panics if the indices are out of bounds.

pub fn apply<F>(&mut self, f: F)

where F: Fn(f64) -> f64,

pub fn hadamard_product(&mut self, other: &Matrix)

pub fn multiply_matrix(&self, other: &Matrix) -> Matrix

Trait Implementations

impl Add<&Matrix> for Matrix

fn add(self, other: &Matrix) -> Matrix

Adds two matrices together, component-wise. Panics if the matrices have different dimensions.

type Output = Matrix

The resulting type after applying the + operator.

impl AddAssign<&Matrix> for Matrix

fn add_assign(&mut self, other: &Matrix)

Adds another matrix to this matrix, component-wise. Panics if the matrices have different dimensions. This is an in-place operation.

impl Clone for Matrix

fn clone(&self) -> Matrix

Returns a duplicate 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 Default for Matrix

fn default() -> Matrix

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Matrix

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Mul<&Matrix> for &Matrix

type Output = Matrix

The resulting type after applying the * operator.

fn mul(self, other: &Matrix) -> Matrix

Performs the * operation.

impl Mul<f64> for Matrix

fn mul(self, scalar: f64) -> Matrix

Multiplies the matrix by a scalar.

type Output = Matrix

The resulting type after applying the * operator.

impl MulAssign<f64> for Matrix

fn mul_assign(&mut self, scalar: f64)

Multiplies the matrix by a scalar in-place.

impl PartialEq for Matrix

fn eq(&self, other: &Matrix) -> 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 Serialize for Matrix

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<&Matrix> for Matrix

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

Subtracts another matrix from this matrix, component-wise. Panics if the matrices have different dimensions.

type Output = Matrix

The resulting type after applying the - operator.

impl SubAssign<&Matrix> for Matrix

fn sub_assign(&mut self, other: &Matrix)

Performs the -= operation.

impl StructuralPartialEq for Matrix