Struct m4ri_rust::friendly::BinMatrix

pub struct BinMatrix { /* fields omitted */ }

Structure to represent matrices

Methods

impl BinMatrix

pub fn zero(rows: usize, cols: usize) -> BinMatrix

Create a zero matrix

pub fn new(rows: Vec<BinVector>) -> BinMatrix

Create a new matrix

pub fn random(rows: usize, columns: usize) -> BinMatrix

pub fn from_mzd(mzd: *mut Mzd) -> BinMatrix

pub fn identity(rows: usize) -> BinMatrix

Get an identity matrix

pub fn augmented(&self, other: &BinMatrix) -> BinMatrix

Augment the matrix: [A] [B] => [A B]

pub fn stacked(&self, other: &BinMatrix) -> BinMatrix

Stack the matrix with another and return the result

pub fn rank(&self) -> usize

Get the rank of the matrix

Does an echelonization and throws it away!

pub fn echelonize(&mut self) -> usize

Echelonize this matrix in-place

Return: the rank of the matrix

pub fn inverted(&self) -> BinMatrix

Compute the inverse of this matrix, returns a new matrix

pub fn transposed(&self) -> BinMatrix

Compute the transpose of the matrix

pub fn transpose(&self) -> BinMatrix

Deprecated

pub fn nrows(&self) -> usize

Get the number of rows

O(1)

pub fn ncols(&self) -> usize

Get the number of columns

O(1)

pub fn as_vector(&self) -> BinVector

Get as a vector

Works both on single-column and single-row matrices

pub fn bit(&self, row: usize, col: usize) -> bool

Get a certain bit

pub fn get_window(
    &self,
    start_row: usize,
    start_col: usize,
    high_row: usize,
    high_col: usize
) -> BinMatrix

Get a window from the matrix

pub fn set_window(
    &mut self,
    start_row: usize,
    start_col: usize,
    other: &BinMatrix
)

Set a window in the matrix to another matrix

Currently does bit-by-bit, should use more optimal means if alignment allows it

Trait Implementations

impl Drop for BinMatrix

fn drop(&mut self)

Executes the destructor for this type.

impl Sync for BinMatrix

impl PartialEq<BinMatrix> for BinMatrix

fn eq(&self, other: &BinMatrix) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Clone for BinMatrix

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for BinMatrix

impl Debug for BinMatrix

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

Formats the value using the given formatter.

impl<'a> Add<&'a BinMatrix> for &'a BinMatrix

type Output = BinMatrix

The resulting type after applying the + operator.

fn add(self, other: &BinMatrix) -> Self::Output

Add up two matrices

impl Add<BinMatrix> for BinMatrix

type Output = BinMatrix

The resulting type after applying the + operator.

fn add(self, other: BinMatrix) -> Self::Output

Add up two matrices, re-uses memory of A

impl Mul<BinMatrix> for BinMatrix

type Output = BinMatrix

The resulting type after applying the * operator.

fn mul(self, other: BinMatrix) -> Self::Output

Computes the product of two matrices

impl<'a> Mul<&'a BinMatrix> for &'a BinMatrix

type Output = BinMatrix

The resulting type after applying the * operator.

fn mul(self, other: &BinMatrix) -> Self::Output

Computes the product of two matrices

impl<'a> Mul<&'a BinVector> for &'a BinMatrix

type Output = BinVector

The resulting type after applying the * operator.

fn mul(self, other: &BinVector) -> Self::Output

Computes (A * v^T)

impl Mul<BinVector> for BinMatrix

type Output = BinVector

The resulting type after applying the * operator.

fn mul(self, other: BinVector) -> Self::Output

Computes (A * v^T)

impl<'a> Mul<&'a BinMatrix> for &'a BinVector

type Output = BinVector

The resulting type after applying the * operator.

fn mul(self, other: &BinMatrix) -> Self::Output

computes v^T * A

impl Mul<BinMatrix> for BinVector

type Output = BinVector

The resulting type after applying the * operator.

fn mul(self, other: BinMatrix) -> Self::Output

computes v^T * A

impl AddAssign<BinMatrix> for BinMatrix

fn add_assign(&mut self, other: BinMatrix)

Add up two matrices, re-uses memory of A

impl<'a> AddAssign<&'a BinMatrix> for BinMatrix

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

Add up two matrices, re-uses memory of A