mod decompose;
mod solve;
use crate::domain::real::RealScalar;
use leto::{Array1, Array2, ArrayView1, ArrayView2, Result};
#[derive(Debug, Clone)]
pub struct FullPivLuDecomposition<T> {
lu: Vec<T>,
row_perm: Vec<usize>,
col_perm: Vec<usize>,
sign: i8,
rank: usize,
n: usize,
}
impl<T: RealScalar> FullPivLuDecomposition<T> {
#[must_use]
pub fn rank(&self) -> usize {
self.rank
}
#[must_use]
pub fn lu_factors(&self) -> &[T] {
&self.lu
}
#[must_use]
pub fn det(&self) -> T {
if self.rank < self.n {
return T::ZERO;
}
let mut product = if self.sign >= 0 {
T::ONE
} else {
T::ZERO.sub(T::ONE)
};
for k in 0..self.n {
product = product.mul(self.lu[k * self.n + k]);
}
product
}
#[must_use]
pub fn l(&self) -> Array2<T> {
let n = self.n;
let mut values = vec![T::ZERO; n * n];
for i in 0..n {
for j in 0..n {
values[i * n + j] = match i.cmp(&j) {
core::cmp::Ordering::Greater => self.lu[i * n + j],
core::cmp::Ordering::Equal => T::ONE,
core::cmp::Ordering::Less => T::ZERO,
};
}
}
Array2::from_shape_vec([n, n], values).expect("L shape matches storage")
}
#[must_use]
pub fn u(&self) -> Array2<T> {
let n = self.n;
let mut values = vec![T::ZERO; n * n];
for i in 0..n {
for j in i..n {
values[i * n + j] = self.lu[i * n + j];
}
}
Array2::from_shape_vec([n, n], values).expect("U shape matches storage")
}
#[must_use]
pub fn row_permutation(&self) -> &[usize] {
&self.row_perm
}
#[must_use]
pub fn col_permutation(&self) -> &[usize] {
&self.col_perm
}
pub fn solve(&self, rhs: &ArrayView1<'_, T>) -> Result<Array1<T>> {
solve::solve(&self.as_factored(), rhs)
}
pub fn inv(&self) -> Result<Array2<T>> {
solve::inverse(&self.as_factored())
}
fn as_factored(&self) -> decompose::Factored<T> {
decompose::Factored {
lu: self.lu.clone(),
row_perm: self.row_perm.clone(),
col_perm: self.col_perm.clone(),
sign: self.sign,
rank: self.rank,
n: self.n,
}
}
}
pub fn full_piv_lu<T: RealScalar>(matrix: &ArrayView2<'_, T>) -> Result<FullPivLuDecomposition<T>> {
let f = decompose::factor(matrix)?;
Ok(FullPivLuDecomposition {
lu: f.lu,
row_perm: f.row_perm,
col_perm: f.col_perm,
sign: f.sign,
rank: f.rank,
n: f.n,
})
}