Struct RingMatrix 

pub struct RingMatrix { /* private fields */ }

Matrix of ring elements over Z_m.

Implementations

impl RingMatrix

pub fn new(rows: Vec<RingVector>) -> Self

Create a new matrix from rows of ring elements.

Panics

Panics when the rows are empty, ragged, or use different moduli.

pub fn try_new(rows: Vec<RingVector>) -> Result<Self, RingError>

Try to create a new matrix from rows of ring elements.

Errors

Returns RingError::DimensionMismatch for an empty or ragged matrix and RingError::ModulusMismatch when the rows use different moduli.

pub fn zero(row_count: usize, col_count: usize, modulus: u64) -> Self

Create a zero matrix.

Panics

Panics if row_count == 0 or col_count == 0.

pub fn from_values(rows: &[Vec<u64>], modulus: u64) -> Self

Create a matrix from raw values.

pub fn identity(size: usize, modulus: u64) -> Self

Create the identity matrix of size n.

Panics

Panics if size == 0.

pub const fn rows(&self) -> usize

Number of rows.

pub const fn cols(&self) -> usize

Number of columns.

pub const fn modulus(&self) -> u64

Modulus shared by all matrix entries.

pub fn row_vectors(&self) -> &[RingVector]

Borrow the matrix rows.

pub fn row(&self, index: usize) -> &RingVector

Borrow one row.

pub fn get(&self, row: usize, col: usize) -> RingElement

Get one entry.

pub fn set(&mut self, row: usize, col: usize, value: RingElement)

Set one entry.

Panics

Panics if the index is out of bounds or the element modulus does not match the matrix modulus.

pub fn to_values(&self) -> Vec<Vec<u64>>

Convert to raw values.

pub fn transpose(&self) -> Self

Return the transpose of this matrix.

pub fn permute_columns(&self, permutation: &[usize]) -> Result<Self, RingError>

Reorder columns according to permutation, where each new column j comes from old column permutation[j].

Errors

Returns RingError::DimensionMismatch when the permutation has the wrong length or contains duplicates/out-of-range indices.

pub fn select_columns(&self, columns: &[usize]) -> Result<Self, RingError>

Select columns in the provided order.

Errors

Returns RingError::DimensionMismatch when a requested column is out of range.

pub fn mul_vector(&self, vector: &RingVector) -> Result<RingVector, RingError>

Multiply this matrix by a column vector.

Errors

Returns RingError::DimensionMismatch or RingError::ModulusMismatch when the operands are incompatible.

pub fn left_mul_vector( &self, vector: &RingVector, ) -> Result<RingVector, RingError>

Multiply a row vector by this matrix.

Errors

Returns RingError::DimensionMismatch or RingError::ModulusMismatch when the operands are incompatible.

pub fn try_mul(&self, other: &Self) -> Result<Self, RingError>

Multiply this matrix by another matrix.

Errors

Returns RingError::DimensionMismatch or RingError::ModulusMismatch when the operands are incompatible.

pub fn inverse(&self) -> Result<Self, RingError>

Compute the inverse of a square matrix with Gauss-Jordan elimination.

Errors

Returns RingError::DimensionMismatch if the matrix is not square and RingError::SingularMatrix if no invertible pivot can be found.

Trait Implementations

impl Clone for RingMatrix

fn clone(&self) -> RingMatrix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RingMatrix

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RingMatrix

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RingMatrix

fn eq(&self, other: &RingMatrix) -> 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 Serialize for RingMatrix

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RingMatrix

impl StructuralPartialEq for RingMatrix