Struct Matrix 

pub struct Matrix<F> { /* private fields */ }

Represents a matrix of field elements, of arbitrary dimensions

This is in row major order, so consider processing elements in the same row first, for locality.

Implementations

impl<F: Additive> Matrix<F>

pub fn init(rows: usize, cols: usize, data: impl Iterator<Item = F>) -> Self

Initialize a matrix, with dimensions, and data to pull from.

Any extra data is ignored, any data not supplied is treated as 0.

pub fn as_polynomials( &self, min_coefficients: usize, ) -> Option<PolynomialVector<F>>

Interpret the columns of this matrix as polynomials, with at least min_coefficients.

This will, in fact, produce a matrix padded to the next power of 2 of that number.

This will return None if min_coefficients < self.rows, which would mean discarding data, instead of padding it.

pub fn mul(&self, other: &Self) -> Self

where F: Ring,

Multiply this matrix by another.

This assumes that the number of columns in this matrix match the number of rows in the other matrix.

impl<F> Matrix<F>

pub const fn rows(&self) -> usize

pub const fn cols(&self) -> usize

pub fn iter(&self) -> impl Iterator<Item = &[F]>

Iterate over the rows of this matrix.

impl<F: Random> Matrix<F>

pub fn rand(rng: impl CryptoRng, rows: usize, cols: usize) -> Self

where F: Additive,

Create a random matrix with certain dimensions.

Trait Implementations

impl<F: Clone> Clone for Matrix<F>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for Matrix<F>

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

Formats the value using the given formatter.

impl<F: EncodeSize> EncodeSize for Matrix<F>

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

fn encode_inline_size(&self) -> usize

Returns the encoded size excluding bytes passed to BufsMut::push during Write::write_bufs. Used to size the fixed working buffer for inline writes, so it must not be less than the bytes written inline. Override alongside Write::write_bufs for types where large byte fields go via push, or the working buffer will over-allocate.

impl<F> Index<(usize, usize)> for Matrix<F>

type Output = F

The returned type after indexing.

fn index(&self, (i, j): (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<F> Index<usize> for Matrix<F>

type Output = [F]

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<F> IndexMut<(usize, usize)> for Matrix<F>

fn index_mut(&mut self, (i, j): (usize, usize)) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<F> IndexMut<usize> for Matrix<F>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<F: PartialEq> PartialEq for Matrix<F>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<F: Read> Read for Matrix<F>

type Cfg = (usize, <F as Read>::Cfg)

The Cfg type parameter allows passing configuration during the read process. This is crucial for safely decoding untrusted data, for example, by providing size limits for collections or strings.

fn read_cfg( buf: &mut impl Buf, (max_els, f_cfg): &Self::Cfg, ) -> Result<Self, Error>

Reads a value from the buffer using the provided configuration cfg.

impl<F: PartialEq> StructuralPartialEq for Matrix<F>

impl<F: Write> Write for Matrix<F>

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

fn write_bufs(&self, buf: &mut impl BufsMut)

Writes to a BufsMut, allowing existing byte chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.