Struct Matrix 

pub struct Matrix(/* private fields */);

A matrix (in the linear algebra sense) of rational numbers.

Implementations

impl Matrix

pub fn new(m: Vec<Vec<R64>>) -> Self

The caller is responsible for making sure the input is valid, meaning that no rows are empty, and each row is the same size. Failing to do so could lead to undefined behaviour or panics later on.

pub fn from_row_vecs(m: Vec<RowVec>) -> Self

The caller is responsible for making sure the input is valid, meaning that no rows are empty, and each row is the same size. Failing to do so could lead to undefined behaviour or panics later on.

pub fn from_int_vecs(m: Vec<Vec<i64>>) -> Self

The caller is responsible for making sure the input is valid, meaning that no rows are empty, and each row is the same size. Failing to do so could lead to undefined behaviour or panics later on.

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

pub fn empty() -> Self

pub fn rref(&mut self)

Puts the matrix into Reduced Row Echelon Form.

pub fn ref(&mut self)

Puts the matrix into (unreduced) Row Echelon Form.

pub fn leader_sort(&mut self)

Sort the rows of the matrix such the ones with the leftmost leaders (ie, leftmost non-zero entries) come first. All-zero rows are at the bottom.

use aoclib_rs::matrix::Matrix;

let mut m = Matrix::from_int_vecs(vec![
    vec![0, 2, 3, 4],
    vec![2, 3, 6, 3],
    vec![0, 0, 4, 5],
    vec![0, 0, 0, 3],
    vec![0, 5, 6, 3],
    vec![0, 0, 0, 0],
    vec![3, 4, 2, 6],
]);
m.leader_sort();

assert_eq!(
    m,
    Matrix::from_int_vecs(vec![
        vec![2, 3, 6, 3],
        vec![3, 4, 2, 6],
        vec![0, 2, 3, 4],
        vec![0, 5, 6, 3],
        vec![0, 0, 4, 5],
        vec![0, 0, 0, 3],
        vec![0, 0, 0, 0],
    ])
);

pub fn eliminate_below_leader(&mut self, row: usize)

Perform a step in row reduction by eliminating the entries in the same column as row’s leader for all rows below row.

pub fn eliminate( &mut self, selected_row: usize, other_row: usize, leader_col: usize, )

Perform a step in row reduction by eliminating the other_row entry corresponding to leader_col (which is the column of the leader in selected_row).

use aoclib_rs::matrix::Matrix;

let mut m = Matrix::from_int_vecs(vec![vec![0, 2, 3, 4], vec![2, 4, 6, 3]]);
m.eliminate(0, 1, 1);

assert_eq!(
    m,
    Matrix::from_int_vecs(vec![vec![0, 2, 3, 4], vec![2, 0, 0, -5]])
);

pub fn normalize(&mut self)

Divides rows to ensure that each leader is 1.

pub fn eliminate_above_leader(&mut self, row: usize)

Perform a step in row reduction by eliminating the entries in the same column as row’s leader for all rows above row.

pub fn add_assign(&mut self, rhs: &Self) -> Result<()>

Implements a “+=” operation (without actually defining the operator) which returns an error if the 2 Matrixes are of different sizes.

pub fn add(&self, rhs: &Self) -> Result<Self>

Implements a “+” operation (without actually defining the operator) which returns an error if the 2 Matrixes are of different sizes.

pub fn is_empty(&self) -> bool

pub fn matrix_mul(&self, rhs: &Self) -> Result<Self>

Implements matrix multiplication. Returns errors if the two matrices are incorrect sizes for multiplication.

pub fn append_row(&mut self, r: RowVec)

Appends a RowVec to the bottom of the matrix. Note that the caller is responsible for ensuring the RowVec is the correct size. Appending RowVecs of the wrong size could lead to undefined behaviour or panics later on.

pub fn remove_row(&mut self, i: usize)

Remove row i from the Matrix.

pub fn height(&self) -> usize

pub fn width(&self) -> usize

pub fn iter(&self) -> impl Iterator<Item = &RowVec>

Returns an iterator over rows of the Matrix.

pub fn is_zeros(&self) -> bool

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

Returns a new matrix with a single column whose contents are a copy of a column c from the original matrix.

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.

impl Display for Matrix

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

Formats the value using the given formatter.

impl Index<(usize, usize)> for Matrix

type Output = Ratio<i64>

The returned type after indexing.

fn index(&self, index: (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for Matrix

type Output = RowVec

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<(usize, usize)> for Matrix

fn index_mut(&mut self, index: (usize, usize)) -> &mut Self::Output

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

impl IndexMut<usize> for Matrix

fn index_mut(&mut self, index: usize) -> &mut Self::Output

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

impl IntoIterator for Matrix

type Item = RowVec

The type of the elements being iterated over.

type IntoIter = IntoIter<<Matrix as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Mul<Ratio<i64>> for Matrix

type Output = Matrix

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Ratio<i64>> for Matrix

fn mul_assign(&mut self, rhs: R64)

Performs the *= operation.

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