Struct Matrix

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

A matrix over a field.

Implementations

impl<F: Field> Matrix<F>

pub fn m(&self) -> usize

pub fn n(&self) -> usize

impl<F: Field> Matrix<F>

pub fn new(m: usize, n: usize, elements: &[F]) -> Result<Self, Error>

pub fn zeros(m: usize, n: usize) -> Self

pub fn identity(n: usize) -> Self

pub fn elements(&self) -> &[F]

pub fn random(m: usize, n: usize, rng: impl RngCore) -> Self

pub fn dim(&self) -> (usize, usize)

pub fn copy_from(&mut self, other: &Self)

pub fn mul_into(a: &Self, b: &Self, c: &mut Self)

pub fn mul_vec_into<FE: ExtensionField<F>>(&self, x: &[FE], y: &mut [FE])

pub fn inverse_into(&self, out: &mut Self) -> Result<(), Error>

Invert a square matrix

Throws

• Error::MatrixNotSquare
• Error::MatrixIsSingular

Preconditions

• out - must have the same dimensions as self

Trait Implementations

impl<F: Field> Add for &Matrix<F>

type Output = Matrix<F>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Matrix<F>

Performs the + operation.

impl<F: Field> AddAssign<&Matrix<F>> for Matrix<F>

fn add_assign(&mut self, rhs: &Self)

Performs the += operation.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

type Output = F

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

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

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

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

fn eq(&self, other: &Matrix<F>) -> 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<F: Field> Sub for &Matrix<F>

type Output = Matrix<F>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Matrix<F>

Performs the - operation.

impl<F: Field> SubAssign<&Matrix<F>> for Matrix<F>

fn sub_assign(&mut self, rhs: &Self)

Performs the -= operation.

impl<F: Eq + Field> Eq for Matrix<F>

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