Struct SquareMatrix

pub struct SquareMatrix<const N_ROWS: usize, const N_ELEMENTS: usize>(pub Matrix<N_ROWS, N_ROWS, N_ELEMENTS>);

Represents a square matrix over PrimeField elements

Tuple Fields

0: Matrix<N_ROWS, N_ROWS, N_ELEMENTS>

Implementations

impl<const N_ROWS: usize, const N_ELEMENTS: usize> SquareMatrix<N_ROWS, N_ELEMENTS>

pub fn transpose(&self) -> Self

impl<const N_ROWS: usize, const N_ELEMENTS: usize> SquareMatrix<N_ROWS, N_ELEMENTS>

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

Get row vector at a specified row index.

pub fn new_2x2(a: Fq, b: Fq, c: Fq, d: Fq) -> SquareMatrix<2, 4>

Create a 2x2 SquareMatrix from four elements.

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

Create a new matrix from a slice of elements.

Trait Implementations

impl<const N_ROWS: usize, const N_ELEMENTS: usize> Clone for SquareMatrix<N_ROWS, N_ELEMENTS>

fn clone(&self) -> SquareMatrix<N_ROWS, 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_ELEMENTS: usize> Debug for SquareMatrix<N_ROWS, N_ELEMENTS>

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

Formats the value using the given formatter.

impl<const N_ROWS: usize, const N_ELEMENTS: usize> MatrixOperations for SquareMatrix<N_ROWS, 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_ELEMENTS: usize> Mul<Fq> for SquareMatrix<N_ROWS, N_ELEMENTS>

Multiply scalar by SquareMatrix

type Output = SquareMatrix<N_ROWS, 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_ELEMENTS: usize> PartialEq for SquareMatrix<N_ROWS, N_ELEMENTS>

fn eq(&self, other: &SquareMatrix<N_ROWS, 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_ELEMENTS: usize> SquareMatrixOperations for SquareMatrix<N_ROWS, N_ELEMENTS>

fn inverse(&self) -> Result<Self, PoseidonParameterError>

Compute the inverse of the matrix

fn identity() -> Self

Construct an identity matrix

fn minors(&self) -> Self

Compute the (unsigned) minors of this matrix

fn cofactors(&self) -> Self

Compute the cofactor matrix, i.e. $C_{ij} = (-1)^{i+j}$

fn determinant(&self) -> Fq

Compute the matrix determinant

impl<const N_ROWS: usize, const N_ELEMENTS: usize> Eq for SquareMatrix<N_ROWS, N_ELEMENTS>

impl<const N_ROWS: usize, const N_ELEMENTS: usize> StructuralPartialEq for SquareMatrix<N_ROWS, N_ELEMENTS>