Struct Matrix 

pub struct Matrix {
    pub rows: usize,
    pub cols: usize,
    pub data: Vec<f32>,
}

Represents a 2D matrix with dimensions and data.

This is the core data structure for all linear algebra operations in the library. It can represent both regular matrices and vectors (as 1D matrices with either one row or one column).

Examples

Creating a new matrix:

use metal_matrix::Matrix;

// Create a 3x3 zero matrix
let mut matrix = Matrix::new(3, 3);

// Set some values
matrix.set(0, 0, 1.0);
matrix.set(1, 1, 2.0);
matrix.set(2, 2, 3.0);

Creating a vector:

use metal_matrix::Matrix;

// Create a column vector
let vector = Matrix::vector(vec![1.0, 2.0, 3.0]);
assert_eq!(vector.rows, 3);
assert_eq!(vector.cols, 1);

Fields

rows: usize

Number of rows in the matrix

cols: usize

Number of columns in the matrix

data: Vec<f32>

Matrix data in row-major order

Implementations

impl Matrix

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

Create a new matrix with given dimensions, initialized with zeros.

Arguments

• rows - Number of rows
• cols - Number of columns

Returns

A new matrix of the specified dimensions, filled with zeros.

pub fn with_data(rows: usize, cols: usize, data: Vec<f32>) -> Result<Self>

Create a new matrix with given dimensions and data.

Arguments

• rows - Number of rows
• cols - Number of columns
• data - Vector of data in row-major order

Returns

A Result containing the new matrix or an error if the data length doesn’t match dimensions.

Errors

Returns an error if data.len() != rows * cols.

pub fn vector(data: Vec<f32>) -> Self

Create a column vector (1D matrix) with given data.

Arguments

• data - Vector of data

Returns

A new matrix with dimensions (data.len(), 1).

pub fn identity(n: usize) -> Self

Create an identity matrix of size n×n.

Arguments

• n - Size of the square matrix

Returns

A new n×n identity matrix (ones on the diagonal, zeros elsewhere).

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

Get element at position (row, col).

Arguments

• row - Row index (0-based)
• col - Column index (0-based)

Returns

The value at the specified position.

Panics

Panics if the indices are out of bounds.

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

Set element at position (row, col).

Arguments

• row - Row index (0-based)
• col - Column index (0-based)
• value - Value to set

Panics

Panics if the indices are out of bounds.

pub fn is_vector(&self) -> bool

Check if this matrix is a vector (1D matrix).

Returns

true if the matrix has either one row or one column, false otherwise.

pub fn vector_size(&self) -> usize

Get the size of the matrix if it’s a vector.

Returns

The number of elements if the matrix is a vector, or 0 if it’s not a vector.

pub fn vector_get(&self, index: usize) -> Result<f32>

Get vector element at index (for 1D matrices).

Arguments

• index - Element index (0-based)

Returns

A Result containing the value at the specified index or an error if the matrix is not a vector.

Errors

Returns an error if the matrix is not a vector.

pub fn row(&self, row: usize) -> Self

Extract a row as a new Matrix.

Arguments

• row - Row index (0-based)

Returns

A new 1×n matrix containing the specified row.

Panics

Panics if the row index is out of bounds.

pub fn column(&self, col: usize) -> Self

Extract a column as a new Matrix.

Arguments

• col - Column index (0-based)

Returns

A new m×1 matrix containing the specified column.

Panics

Panics if the column index is out of bounds.

Trait Implementations

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.