Skip to main content

Matrix

Struct Matrix 

Source
pub struct Matrix {
    pub rows: usize,
    pub cols: usize,
    /* private fields */
}
Expand description

A dense symbolic matrix stored in row-major order.

Fields§

§rows: usize§cols: usize

Implementations§

Source§

impl Matrix

Source

pub fn new(rows: Vec<Vec<ExprId>>) -> Result<Self, MatrixError>

Create a matrix from row-major nested vectors.

Source

pub fn zeros(rows: usize, cols: usize, pool: &ExprPool) -> Self

Create a zero matrix (all entries are pool.integer(0)).

Source

pub fn identity(n: usize, pool: &ExprPool) -> Self

Create an identity matrix.

Source

pub fn get(&self, r: usize, c: usize) -> ExprId

Get entry at row r, column c (0-indexed).

Source

pub fn set(&mut self, r: usize, c: usize, val: ExprId)

Set entry at row r, column c.

Source

pub fn row(&self, r: usize) -> Vec<ExprId>

Get a row as a vector.

Source

pub fn col(&self, c: usize) -> Vec<ExprId>

Get a column as a vector.

Source

pub fn transpose(&self) -> Self

Transpose.

Source

pub fn add( &self, other: &Matrix, pool: &ExprPool, ) -> Result<Matrix, MatrixError>

Element-wise addition.

Source

pub fn sub( &self, other: &Matrix, pool: &ExprPool, ) -> Result<Matrix, MatrixError>

Element-wise subtraction.

Source

pub fn mul( &self, other: &Matrix, pool: &ExprPool, ) -> Result<Matrix, MatrixError>

Matrix multiplication (self is m×k, other is k×n → result is m×n).

Source

pub fn scale(&self, scalar: ExprId, pool: &ExprPool) -> Matrix

Scalar multiplication.

Source

pub fn simplify_entries(&self, pool: &ExprPool) -> Matrix

Simplify all entries.

Source

pub fn det(&self, pool: &ExprPool) -> Result<ExprId, MatrixError>

Determinant using Bareiss algorithm (exact over integers, symbolic otherwise).

Source

pub fn entries(&self) -> &[ExprId]

Return a flat reference to all entries.

Source

pub fn to_nested(&self) -> Vec<Vec<ExprId>>

Return entries as a nested Vec<Vec<ExprId>>.

Source

pub fn characteristic_polynomial_lambda_minus_m( &self, pool: &ExprPool, ) -> Result<(ExprId, ExprId), EigenError>

V2-17 — det(λI − M) as a pooled expression plus the fresh λ symbol used.

Source

pub fn eigenvalues( &self, pool: &ExprPool, ) -> Result<Vec<(ExprId, usize)>, EigenError>

V2-17 — Algebraic eigenvalues (value, multiplicity) for matrices whose characteristic polynomial factors over ℚ into linear and quadratic terms.

Source

pub fn eigenvectors( &self, pool: &ExprPool, ) -> Result<Vec<(ExprId, usize, Vec<Matrix>)>, EigenError>

V2-17 — Eigenvalue tuples (λ, multiplicity, column eigenvectors).

Source

pub fn diagonalize( &self, pool: &ExprPool, ) -> Result<(Matrix, Matrix), EigenError>

V2-17 — (P, D) with M·P == P·D when diagonalizable in the ℚ-splitting-field sense.

Source§

impl Matrix

Source

pub fn display(&self, pool: &ExprPool) -> String

Trait Implementations§

Source§

impl Clone for Matrix

Source§

fn clone(&self) -> Matrix

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Matrix

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Matrix

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Matrix

Source§

impl StructuralPartialEq for Matrix

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.