#[cfg(feature = "serde-serialize")] use serde::{Deserialize, Serialize}; use num::Zero; use num_complex::Complex; use crate::ComplexHelper; use na::allocator::Allocator; use na::dimension::{Const, Dim, DimMin, DimMinimum}; use na::{DefaultAllocator, Matrix, OMatrix, OVector, Scalar}; use lapack; /// The QR decomposition of a general matrix. #[cfg_attr(feature = "serde-serialize", derive(Serialize, Deserialize))] #[cfg_attr( feature = "serde-serialize", serde(bound(serialize = "DefaultAllocator: Allocator + Allocator>, OMatrix: Serialize, OVector>: Serialize")) )] #[cfg_attr( feature = "serde-serialize", serde(bound(deserialize = "DefaultAllocator: Allocator + Allocator>, OMatrix: Deserialize<'de>, OVector>: Deserialize<'de>")) )] #[derive(Clone, Debug)] pub struct QR, C: Dim> where DefaultAllocator: Allocator + Allocator>, { qr: OMatrix, tau: OVector>, } impl, C: Dim> Copy for QR where DefaultAllocator: Allocator + Allocator>, OMatrix: Copy, OVector>: Copy, { } impl, C: Dim> QR where DefaultAllocator: Allocator + Allocator> + Allocator, C> + Allocator>, { /// Computes the QR decomposition of the matrix `m`. pub fn new(mut m: OMatrix) -> Self { let (nrows, ncols) = m.shape_generic(); let mut info = 0; let mut tau = Matrix::zeros_generic(nrows.min(ncols), Const::<1>); if nrows.value() == 0 || ncols.value() == 0 { return Self { qr: m, tau }; } let lwork = T::xgeqrf_work_size( nrows.value() as i32, ncols.value() as i32, m.as_mut_slice(), nrows.value() as i32, tau.as_mut_slice(), &mut info, ); let mut work = vec![T::zero(); lwork as usize]; T::xgeqrf( nrows.value() as i32, ncols.value() as i32, m.as_mut_slice(), nrows.value() as i32, tau.as_mut_slice(), &mut work, lwork, &mut info, ); Self { qr: m, tau } } /// Retrieves the upper trapezoidal submatrix `R` of this decomposition. #[inline] #[must_use] pub fn r(&self) -> OMatrix, C> { let (nrows, ncols) = self.qr.shape_generic(); self.qr.rows_generic(0, nrows.min(ncols)).upper_triangle() } } impl, C: Dim> QR where DefaultAllocator: Allocator + Allocator> + Allocator, C> + Allocator>, { /// Retrieves the matrices `(Q, R)` of this decompositions. pub fn unpack( self, ) -> ( OMatrix>, OMatrix, C>, ) { (self.q(), self.r()) } /// Computes the orthogonal matrix `Q` of this decomposition. #[inline] #[must_use] pub fn q(&self) -> OMatrix> { let (nrows, ncols) = self.qr.shape_generic(); let min_nrows_ncols = nrows.min(ncols); if min_nrows_ncols.value() == 0 { return OMatrix::from_element_generic(nrows, min_nrows_ncols, T::zero()); } let mut q = self .qr .generic_view((0, 0), (nrows, min_nrows_ncols)) .into_owned(); let mut info = 0; let nrows = nrows.value() as i32; let lwork = T::xorgqr_work_size( nrows, min_nrows_ncols.value() as i32, self.tau.len() as i32, q.as_mut_slice(), nrows, self.tau.as_slice(), &mut info, ); let mut work = vec![T::zero(); lwork as usize]; T::xorgqr( nrows, min_nrows_ncols.value() as i32, self.tau.len() as i32, q.as_mut_slice(), nrows, self.tau.as_slice(), &mut work, lwork, &mut info, ); q } } /* * * Lapack functions dispatch. * */ /// Trait implemented by scalar types for which Lapack function exist to compute the /// QR decomposition. pub trait QRScalar: Scalar + Copy { fn xgeqrf( m: i32, n: i32, a: &mut [Self], lda: i32, tau: &mut [Self], work: &mut [Self], lwork: i32, info: &mut i32, ); fn xgeqrf_work_size( m: i32, n: i32, a: &mut [Self], lda: i32, tau: &mut [Self], info: &mut i32, ) -> i32; } /// Trait implemented by reals for which Lapack function exist to compute the /// QR decomposition. pub trait QRReal: QRScalar { #[allow(missing_docs)] fn xorgqr( m: i32, n: i32, k: i32, a: &mut [Self], lda: i32, tau: &[Self], work: &mut [Self], lwork: i32, info: &mut i32, ); #[allow(missing_docs)] fn xorgqr_work_size( m: i32, n: i32, k: i32, a: &mut [Self], lda: i32, tau: &[Self], info: &mut i32, ) -> i32; } macro_rules! qr_scalar_impl( ($N: ty, $xgeqrf: path) => ( impl QRScalar for $N { #[inline] fn xgeqrf(m: i32, n: i32, a: &mut [Self], lda: i32, tau: &mut [Self], work: &mut [Self], lwork: i32, info: &mut i32) { unsafe { $xgeqrf(m, n, a, lda, tau, work, lwork, info) } } #[inline] fn xgeqrf_work_size(m: i32, n: i32, a: &mut [Self], lda: i32, tau: &mut [Self], info: &mut i32) -> i32 { let mut work = [ Zero::zero() ]; let lwork = -1 as i32; unsafe { $xgeqrf(m, n, a, lda, tau, &mut work, lwork, info); } ComplexHelper::real_part(work[0]) as i32 } } ) ); macro_rules! qr_real_impl( ($N: ty, $xorgqr: path) => ( impl QRReal for $N { #[inline] fn xorgqr(m: i32, n: i32, k: i32, a: &mut [Self], lda: i32, tau: &[Self], work: &mut [Self], lwork: i32, info: &mut i32) { unsafe { $xorgqr(m, n, k, a, lda, tau, work, lwork, info) } } #[inline] fn xorgqr_work_size(m: i32, n: i32, k: i32, a: &mut [Self], lda: i32, tau: &[Self], info: &mut i32) -> i32 { let mut work = [ Zero::zero() ]; let lwork = -1 as i32; unsafe { $xorgqr(m, n, k, a, lda, tau, &mut work, lwork, info); } ComplexHelper::real_part(work[0]) as i32 } } ) ); qr_scalar_impl!(f32, lapack::sgeqrf); qr_scalar_impl!(f64, lapack::dgeqrf); qr_scalar_impl!(Complex, lapack::cgeqrf); qr_scalar_impl!(Complex, lapack::zgeqrf); qr_real_impl!(f32, lapack::sorgqr); qr_real_impl!(f64, lapack::dorgqr);