Struct Matrix2D

pub struct Matrix2D<T: FieldElement> {
    pub dimensions: (usize, usize),
    pub values: Vec<T>,
}

A two dimensional matrix implementation

Fields

dimensions: (usize, usize)

values: Vec<T>

Implementations

impl<T: FieldElement> Matrix2D<T>

pub const JL_PROJECTION_SIZE: usize = 256usize

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

Create a new 2 dimensional matrix of specified rows and columns

pub fn identity(n: usize) -> Self

Return an identity matrix of size n

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

Return a zero matrix of the specified dimensions

pub fn column(&self, index: usize) -> Vector<T>

Retrieve a column by index. Panics if the index is greater than or equal to the number of columns.

pub fn row(&self, index: usize) -> Vector<T>

Retrieve a row by index. Panics if the index is greater than or equal to the number of rows.

pub fn split_vertical( &self, m1_height: usize, m2_height: usize, ) -> (Matrix2D<T>, Matrix2D<T>)

Take the matrix and split it into 2 matrices vertically. e.g. take the first m1_height rows and return them as a matrix, and return the remaining rows as the m2 matrix.

pub fn compose_vertical(&self, other: Self) -> Self

Compose the matrix self with another matrix vertically.

pub fn compose_horizontal(&self, other: Self) -> Self

Compose the matrix self with another matrix horizontally.

pub fn sample_uniform<R: Rng>(rows: usize, columns: usize, rng: &mut R) -> Self

Sample a uniform random matrix of the specified dimensions from the underlying field.

pub fn sample_jl<R: Rng>(input_dimension: usize, rng: &mut R) -> Self

Build a johnson-lindenstrauss projection matrix with an input vector size of input_dimension. Returns a matrix of dimension Matrix2d::JL_PROJECTION_SIZE x input_dimension.

Implemented as defined in LaBRADOR section 4 (bottom of page 9).

Trait Implementations

impl<T: FieldElement> Add for Matrix2D<T>

type Output = Matrix2D<T>

The resulting type after applying the + operator.

fn add(self, other: Matrix2D<T>) -> Matrix2D<T>

Performs the + operation.

impl<T: Clone + FieldElement> Clone for Matrix2D<T>

fn clone(&self) -> Matrix2D<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de, T> Deserialize<'de> for Matrix2D<T>

where T: Deserialize<'de> + FieldElement,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: FieldElement> Display for Matrix2D<T>

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

Formats the value using the given formatter.

impl<T: FieldElement> Mul<T> for Matrix2D<T>

fn mul(self, other: T) -> Matrix2D<T>

We’ll assume any provided vector is a column vector and multiply column-wise by the matrix.

type Output = Matrix2D<T>

The resulting type after applying the * operator.

impl<T: FieldElement> Mul<Vector<T>> for Matrix2D<T>

type Output = Vector<T>

The resulting type after applying the * operator.

fn mul(self, other: Vector<T>) -> Vector<T>

Performs the * operation.

impl<T: PartialEq + FieldElement> PartialEq for Matrix2D<T>

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

where T: Serialize + FieldElement,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: FieldElement> StructuralPartialEq for Matrix2D<T>