Struct Matrix

pub struct Matrix<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize> {
    pub elements: [Fq; N_ELEMENTS],
}

Represents a matrix over PrimeField elements.

This matrix can be used to represent row or column vectors.

Fields

elements: [Fq; N_ELEMENTS]

Elements of the matrix, stored in a fixed-size array.

Implementations

impl<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize> Matrix<N_ROWS, N_COLS, N_ELEMENTS>

pub fn transpose(&self) -> Matrix<N_COLS, N_ROWS, N_ELEMENTS>

pub const fn new_from_known(elements: [Fq; N_ELEMENTS]) -> Self

Create a new matrix from a slice of elements.

impl<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize> Matrix<N_ROWS, N_COLS, N_ELEMENTS>

pub fn row_vector(&self, i: usize) -> Matrix<1, N_COLS, N_ELEMENTS>

Get row vector at a specified row index

Trait Implementations

impl<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize> Clone for Matrix<N_ROWS, N_COLS, N_ELEMENTS>

fn clone(&self) -> Matrix<N_ROWS, N_COLS, N_ELEMENTS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize> Debug for Matrix<N_ROWS, N_COLS, N_ELEMENTS>

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

Formats the value using the given formatter.

impl<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize> MatrixOperations for Matrix<N_ROWS, N_COLS, N_ELEMENTS>

fn new(elements: &[Fq]) -> Self

Create a new matrix

fn elements(&self) -> &[Fq]

Access elements as an array of arrays

fn get_element(&self, i: usize, j: usize) -> Fq

Get element[i,j]

fn set_element(&mut self, i: usize, j: usize, val: Fq)

Set element[i,j]

fn n_rows(&self) -> usize

Number of rows

fn n_cols(&self) -> usize

Number of columns

fn hadamard_product(&self, rhs: &Self) -> Result<Self, PoseidonParameterError>

where Self: Sized,

Compute Hadamard (element-wise) product

fn iter_rows(&self) -> Chunks<'_, Fq>

Get rows

impl<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize> Mul<Fq> for Matrix<N_ROWS, N_COLS, N_ELEMENTS>

Multiply scalar by Matrix

type Output = Matrix<N_ROWS, N_COLS, N_ELEMENTS>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize> PartialEq for Matrix<N_ROWS, N_COLS, N_ELEMENTS>

fn eq(&self, other: &Matrix<N_ROWS, N_COLS, N_ELEMENTS>) -> 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<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize> Eq for Matrix<N_ROWS, N_COLS, N_ELEMENTS>

impl<const N_ROWS: usize, const N_COLS: usize, const N_ELEMENTS: usize> StructuralPartialEq for Matrix<N_ROWS, N_COLS, N_ELEMENTS>