mathru 0.16.2

Fundamental algorithms for scientific computing in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

use crate::algebra::linear::matrix::{General, UpperTriangular};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use std::clone::Clone;

pub trait QRDecomposition<T> {
    fn dec_qr(&self) -> Result<QRDec<T>, ()>;
}

/// Result of QR decomposition
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone)]
pub struct QRDec<T> {
    q: General<T>,
    r: UpperTriangular<T>,
}

impl<T> QRDec<T> {
    pub(super) fn new(q: General<T>, r: UpperTriangular<T>) -> QRDec<T> {
        QRDec { q, r }
    }

    /// Return the q matrix of the QR decomposition
    ///
    /// # Arguments
    ///
    /// * `self`
    pub fn q(self) -> General<T> {
        self.q
    }

    /// Return the r matrix of the qr decomposition
    pub fn r(self) -> UpperTriangular<T> {
        self.r
    }

    pub fn qr(self) -> (General<T>, UpperTriangular<T>) {
        (self.q, self.r)
    }
}