Skip to main content

Qr

Struct Qr 

Source
pub struct Qr<T> { /* private fields */ }
Expand description

The QR decomposition A = Q·R of an m × n matrix by Householder reflections: Q of m × min(m, n) with orthonormal columns (unitary for complex elements), R of min(m, n) × n upper triangular with a real diagonal. From Matrix::qr.

§Examples

use a::math::matrix::Matrix;

let a: Matrix<f64> = Matrix::from_rows(&[[3.0, 1.0], [4.0, 2.0]]);
let qr = a.qr();
let (q, r) = (qr.q(), qr.r());
assert!((&q * &r - &a).as_slice().iter().all(|x| x.abs() < 1e-15));
assert!((&q.transpose() * &q - Matrix::identity(2)).as_slice().iter().all(|x| x.abs() < 1e-15));
assert!((r[(0, 0)].abs() - 5.0).abs() < 1e-15);

Implementations§

Source§

impl<T: Scalar> Qr<T>

Source

pub fn q(&self) -> Matrix<T>

Q, m × min(m, n), with orthonormal columns.

Source

pub fn q_full(&self) -> Matrix<T>

The whole m × m unitary Q, whose first min(m, n) columns are q.

Source

pub fn r(&self) -> Matrix<T>

R, min(m, n) × n, upper triangular.

Source

pub fn solve(&self, b: &Matrix<T>) -> Option<Matrix<T>>

The X of the least squares, which makes ‖A·X - B‖ the smallest, for m ≥ n: the solution of R·X = Q*·B, or None when a diagonal element of R is zero, the columns of A dependent. For a square matrix it solves A·X = B.

§Panics

Panics if the matrix has fewer rows than columns, or B not as many rows as it.

Trait Implementations§

Source§

impl<T: Clone> Clone for Qr<T>

Source§

fn clone(&self) -> Self

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<T: Debug> Debug for Qr<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Qr<T>
where Matrix<T>: Freeze, Vec<T>: Freeze,

§

impl<T> RefUnwindSafe for Qr<T>

§

impl<T> Send for Qr<T>
where Matrix<T>: Send, Vec<T>: Send,

§

impl<T> Sync for Qr<T>
where Matrix<T>: Sync, Vec<T>: Sync,

§

impl<T> Unpin for Qr<T>
where Matrix<T>: Unpin, Vec<T>: Unpin,

§

impl<T> UnsafeUnpin for Qr<T>

§

impl<T> UnwindSafe for Qr<T>

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.