Struct poseidon_parameters::v2::SquareMatrix

pub struct SquareMatrix<F: PrimeField>(pub Matrix<F>);

Represents a square matrix over PrimeField elements

Tuple Fields

0: Matrix<F>

Implementations

impl<F: PrimeField> SquareMatrix<F>

pub fn from_vec(elements: Vec<F>) -> Self

Create a SquareMatrix from a vector of elements.

pub fn row_vector(&self, i: usize) -> Matrix<F>

Get row vector at a specified row index.

pub fn new_2x2(a: F, b: F, c: F, d: F) -> SquareMatrix<F>

Create a 2x2 SquareMatrix from four elements.

Trait Implementations

impl<F: Clone + PrimeField> Clone for SquareMatrix<F>

fn clone(&self) -> SquareMatrix<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + PrimeField> Debug for SquareMatrix<F>

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

Formats the value using the given formatter.

impl<F: PrimeField> MatrixOperations<F> for SquareMatrix<F>

fn new(n_rows: usize, n_cols: usize, elements: Vec<F>) -> Self

Create a new matrix

fn elements(&self) -> &Vec<F>

Access elements as a vector

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

Get element[i,j]

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

Set element[i,j]

fn rows(&self) -> Vec<&[F]>

Get rows

fn n_rows(&self) -> usize

Number of rows

fn n_cols(&self) -> usize

Number of columns

fn transpose(&self) -> Self

Take transpose of the matrix

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

Compute Hadamard (element-wise) product

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

Get rows in chunks

impl<F: PrimeField> Mul<F> for SquareMatrix<F>

Multiply scalar by SquareMatrix

type Output = SquareMatrix<F>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<F: PartialEq + PrimeField> PartialEq<SquareMatrix<F>> for SquareMatrix<F>

fn eq(&self, other: &SquareMatrix<F>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F: PrimeField> SquareMatrixOperations<F> for SquareMatrix<F>

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

Compute the inverse of the matrix

fn identity(dim: usize) -> Self

Construct a dim x dim 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) -> F

Compute the matrix determinant

impl<F: Eq + PrimeField> Eq for SquareMatrix<F>

impl<F: PrimeField> StructuralEq for SquareMatrix<F>

impl<F: PrimeField> StructuralPartialEq for SquareMatrix<F>