Struct BinMatrix 

pub struct BinMatrix { /* private fields */ }

Structure to represent matrices

Implementations

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 from_slices<T: AsRef<[u64]>>(rows: &[T], rowlen: usize) -> BinMatrix

Create a new matrix from slices

pub fn count_ones(&self) -> u32

Get the hamming weight for single-row or single-column matrices (ie. vectors)

Panics if nrows > 1 && ncols > 1

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

Construct a randomized matrix

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

Construct a BinMatrix from the raw mzd pointer

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 nrows(&self) -> usize

Get the number of rows

O(1)

pub fn ncols(&self) -> usize

Get the number of columns

O(1)

pub fn get_word(&self, row: usize, column: usize) -> Word

Get a single word from the matrix at a certain offset

pub unsafe fn get_word_unchecked(&self, row: usize, column: usize) -> Word

Get a particular word from the matrix Does not do any bounds checking!

pub fn get_word_mut(&self, row: usize, column: usize) -> &mut Word

Get a mutable reference to a particular word in the matrix

pub unsafe fn get_word_mut_unchecked( &self, row: usize, column: usize, ) -> &mut Word

Get a mutable reference to a particular word in the matrix without bounds checking.

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. Makes a copy.

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

pub fn mul_slice(&self, other: &[u64]) -> BinMatrix

Multiply a matrix by a vector represented as a u64

Trait Implementations

impl<'a> Add for &'a BinMatrix

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

Add up two matrices

type Output = BinMatrix

The resulting type after applying the + operator.

impl Add for BinMatrix

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

Add up two matrices, re-uses memory of A

type Output = BinMatrix

The resulting type after applying the + operator.

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

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

Add up two matrices, re-uses memory of A

impl AddAssign for BinMatrix

fn add_assign(&mut self, other: BinMatrix)

Add up two matrices, re-uses memory of A

impl Clone for BinMatrix

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinMatrix

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

Formats the value using the given formatter.

impl Drop for BinMatrix

fn drop(&mut self)

Executes the destructor for this type.

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

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

computes v^T * A

type Output = BinVector

The resulting type after applying the * operator.

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

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

Computes (A * v^T)

type Output = BinVector

The resulting type after applying the * operator.

impl Mul<BinMatrix> for BinVector

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

computes v^T * A

type Output = BinVector

The resulting type after applying the * operator.

impl Mul<BinVector> for BinMatrix

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

Computes (A * v^T)

type Output = BinVector

The resulting type after applying the * operator.

impl<'a> Mul for &'a BinMatrix

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

Computes the product of two matrices

type Output = BinMatrix

The resulting type after applying the * operator.

impl Mul for BinMatrix

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

Computes the product of two matrices

type Output = BinMatrix

The resulting type after applying the * operator.

impl PartialEq for BinMatrix

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

impl Send for BinMatrix

impl Sync for BinMatrix