Struct MdsMatrix

pub struct MdsMatrix<const STATE_SIZE: usize, const STATE_SIZE_MINUS_1: usize, const NUM_ELEMENTS: usize, const NUM_ELEMENTS_STATE_SIZE_MINUS_1_2: usize>(pub SquareMatrix<STATE_SIZE, NUM_ELEMENTS>);

Represents an MDS (maximum distance separable) matrix.

Tuple Fields

0: SquareMatrix<STATE_SIZE, NUM_ELEMENTS>

Implementations

impl<const STATE_SIZE: usize, const STATE_SIZE_MINUS_1: usize, const NUM_ELEMENTS: usize, const NUM_ELEMENTS_STATE_SIZE_MINUS_1_2: usize> MdsMatrix<STATE_SIZE, STATE_SIZE_MINUS_1, NUM_ELEMENTS, NUM_ELEMENTS_STATE_SIZE_MINUS_1_2>

pub fn from_elements(elements: &[Fq]) -> 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 transpose(&self) -> Self

pub fn inverse(&self) -> SquareMatrix<STATE_SIZE, NUM_ELEMENTS>

Compute inverse of MDS matrix

pub fn v(&self) -> Matrix<1, STATE_SIZE_MINUS_1, STATE_SIZE_MINUS_1>

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<STATE_SIZE_MINUS_1, 1, STATE_SIZE_MINUS_1>

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<STATE_SIZE_MINUS_1, NUM_ELEMENTS_STATE_SIZE_MINUS_1_2>

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

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

Create a new matrix from a slice 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.

Trait Implementations

impl<const STATE_SIZE: usize, const STATE_SIZE_MINUS_1: usize, const NUM_ELEMENTS: usize, const NUM_ELEMENTS_STATE_SIZE_MINUS_1_2: usize> Clone for MdsMatrix<STATE_SIZE, STATE_SIZE_MINUS_1, NUM_ELEMENTS, NUM_ELEMENTS_STATE_SIZE_MINUS_1_2>

fn clone( &self, ) -> MdsMatrix<STATE_SIZE, STATE_SIZE_MINUS_1, NUM_ELEMENTS, NUM_ELEMENTS_STATE_SIZE_MINUS_1_2>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const STATE_SIZE: usize, const STATE_SIZE_MINUS_1: usize, const NUM_ELEMENTS: usize, const NUM_ELEMENTS_STATE_SIZE_MINUS_1_2: usize> Debug for MdsMatrix<STATE_SIZE, STATE_SIZE_MINUS_1, NUM_ELEMENTS, NUM_ELEMENTS_STATE_SIZE_MINUS_1_2>

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

Formats the value using the given formatter.

impl<const STATE_SIZE: usize, const STATE_SIZE_MINUS_1: usize, const NUM_ELEMENTS: usize, const NUM_ELEMENTS_STATE_SIZE_MINUS_1_2: usize> MatrixOperations for MdsMatrix<STATE_SIZE, STATE_SIZE_MINUS_1, NUM_ELEMENTS, NUM_ELEMENTS_STATE_SIZE_MINUS_1_2>

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 STATE_SIZE: usize, const STATE_SIZE_MINUS_1: usize, const NUM_ELEMENTS: usize, const NUM_ELEMENTS_STATE_SIZE_MINUS_1_2: usize> PartialEq for MdsMatrix<STATE_SIZE, STATE_SIZE_MINUS_1, NUM_ELEMENTS, NUM_ELEMENTS_STATE_SIZE_MINUS_1_2>

fn eq( &self, other: &MdsMatrix<STATE_SIZE, STATE_SIZE_MINUS_1, NUM_ELEMENTS, NUM_ELEMENTS_STATE_SIZE_MINUS_1_2>, ) -> 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 STATE_SIZE: usize, const STATE_SIZE_MINUS_1: usize, const NUM_ELEMENTS: usize, const NUM_ELEMENTS_STATE_SIZE_MINUS_1_2: usize> Eq for MdsMatrix<STATE_SIZE, STATE_SIZE_MINUS_1, NUM_ELEMENTS, NUM_ELEMENTS_STATE_SIZE_MINUS_1_2>

impl<const STATE_SIZE: usize, const STATE_SIZE_MINUS_1: usize, const NUM_ELEMENTS: usize, const NUM_ELEMENTS_STATE_SIZE_MINUS_1_2: usize> StructuralPartialEq for MdsMatrix<STATE_SIZE, STATE_SIZE_MINUS_1, NUM_ELEMENTS, NUM_ELEMENTS_STATE_SIZE_MINUS_1_2>