Struct poseidon_parameters::MdsMatrix

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

Represents an MDS (maximum distance separable) matrix.

Tuple Fields

0: SquareMatrix<F>

Implementations

impl<F: PrimeField> MdsMatrix<F>

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

Instantiate an MDS matrix from a list of elements.

Security

You must ensure this matrix was generated securely, using the Cauchy method in fixed_cauchy_matrix or using the random subsampling method described in the original paper.

pub fn inverse(&self) -> SquareMatrix<F>

Compute inverse of MDS matrix

pub fn v(&self) -> Matrix<F>

Return the elements M_{0,1} .. M_{0,t} from the first row

Ref: p.20 of the Poseidon paper

pub fn w(&self) -> Matrix<F>

Return the elements M_{1,0} .. M_{t,0}from the first column

Ref: p.20 of the Poseidon paper

pub fn hat(&self) -> SquareMatrix<F>

Compute the (t - 1) x (t - 1) Mhat matrix from the MDS matrix

This is simply the MDS matrix with the first row and column removed

Ref: p.20 of the Poseidon paper

Trait Implementations

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

fn clone(&self) -> MdsMatrix<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 MdsMatrix<F>

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

Formats the value using the given formatter.

impl<F: PrimeField> From<MdsMatrix<F>> for Vec<Vec<F>>

fn from(val: MdsMatrix<F>) -> Self

Converts to this type from the input type.

impl<F: PrimeField> MatrixOperations<F> for MdsMatrix<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: PartialEq + PrimeField> PartialEq<MdsMatrix<F>> for MdsMatrix<F>

fn eq(&self, other: &MdsMatrix<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: Eq + PrimeField> Eq for MdsMatrix<F>

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

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