Skip to main content

Matrix

Struct Matrix 

Source
pub struct Matrix { /* private fields */ }

Implementations§

Source§

impl Matrix

Source

pub fn new(rows: usize, cols: usize) -> Self

Source

pub fn from_vec( data: Vec<f64>, rows: usize, cols: usize, ) -> Result<Self, String>

Source

pub fn identity(size: usize) -> Self

Source

pub fn rows(&self) -> usize

Source

pub fn cols(&self) -> usize

Source

pub fn transpose(&self) -> Matrix

Source

pub fn transpose_with_parallel(&self, parallel: bool) -> Matrix

Source

pub fn lu_decomposition(&self) -> Result<(Matrix, Matrix, Vec<usize>), String>

Source

pub fn lu_decomposition_with_tolerance( &self, singular_relative_epsilon: f64, ) -> Result<(Matrix, Matrix, Vec<usize>), String>

Source

pub fn solve_lu(&self, b: &Matrix) -> Result<Matrix, String>

Source

pub fn solve_lu_with_tolerance( &self, b: &Matrix, singular_relative_epsilon: f64, ) -> Result<Matrix, String>

Source

pub fn solve_least_squares_qr(&self, b: &Matrix) -> Result<Matrix, String>

Solve a (possibly non-square) least squares problem using Householder QR.

Solves min_x ||A x - b||_2, where A is self.

  • If rows >= cols, returns the standard least-squares solution.
  • If rows < cols, returns the minimum-norm solution among all minimizers.
Source

pub fn solve_least_squares_qr_with_parallel( &self, b: &Matrix, parallel: bool, ) -> Result<Matrix, String>

Source

pub fn solve_least_squares_qr_with_info( &self, b: &Matrix, ) -> Result<(Matrix, LeastSquaresQrInfo), String>

Solve a (possibly non-square) least squares problem using Householder QR, returning diagnostic information about rank and conditioning.

Source

pub fn solve_least_squares_qr_with_info_with_parallel( &self, b: &Matrix, parallel: bool, ) -> Result<(Matrix, LeastSquaresQrInfo), String>

Source

pub fn norm(&self) -> f64

Source

pub fn try_add(&self, rhs: &Matrix) -> Result<Matrix, MatrixError>

Source

pub fn try_sub(&self, rhs: &Matrix) -> Result<Matrix, MatrixError>

Source

pub fn try_mul(&self, rhs: &Matrix) -> Result<Matrix, MatrixError>

Source

pub fn try_mul_with_parallel( &self, rhs: &Matrix, parallel: bool, ) -> Result<Matrix, MatrixError>

Trait Implementations§

Source§

impl Add for &Matrix

Source§

type Output = Matrix

The resulting type after applying the + operator.
Source§

fn add(self, rhs: Self) -> Self::Output

Performs the + operation. Read more
Source§

impl Clone for Matrix

Source§

fn clone(&self) -> Matrix

Returns a duplicate of the value. Read more
1.0.0 · 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 Display for Matrix

Source§

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

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

impl Index<(usize, usize)> for Matrix

Source§

type Output = f64

The returned type after indexing.
Source§

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

Performs the indexing (container[index]) operation. Read more
Source§

impl IndexMut<(usize, usize)> for Matrix

Source§

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

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl Mul<f64> for &Matrix

Source§

type Output = Matrix

The resulting type after applying the * operator.
Source§

fn mul(self, scalar: f64) -> Self::Output

Performs the * operation. Read more
Source§

impl Mul for &Matrix

Source§

type Output = Matrix

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation. 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 · 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 Sub for &Matrix

Source§

type Output = Matrix

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation. Read more
Source§

impl StructuralPartialEq for Matrix

Auto Trait Implementations§

§

impl Freeze for Matrix

§

impl RefUnwindSafe for Matrix

§

impl Send for Matrix

§

impl Sync for Matrix

§

impl Unpin for Matrix

§

impl UnwindSafe for Matrix

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> 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<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<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> 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.