Some documents

Author: termoshtt

src/cholesky.rs

@@ -1,4 +1,6 @@
 //! Cholesky decomposition
+//!
+//! https://en.wikipedia.org/wiki/Cholesky_decomposition
 
 use ndarray::*;
 
@@ -10,15 +12,18 @@ use super::types::*;
 
 pub use lapack_traits::UPLO;
 
+/// Cholesky decomposition of matrix reference
 pub trait Cholesky {
     type Output;
     fn cholesky(&self, UPLO) -> Result<Self::Output>;
 }
 
+/// Cholesky decomposition
 pub trait CholeskyInto: Sized {
     fn cholesky_into(self, UPLO) -> Result<Self>;
 }
 
+/// Cholesky decomposition of mutable reference of matrix
 pub trait CholeskyMut {
     fn cholesky_mut(&mut self, UPLO) -> Result<&mut Self>;
 }

src/eigh.rs

@@ -9,14 +9,14 @@ use super::layout::*;
 use super::operator::*;
 use super::types::*;
 
-/// Eigenvalue decomposition of Hermite matrix
+/// Eigenvalue decomposition of Hermite matrix reference
 pub trait Eigh {
     type EigVal;
     type EigVec;
     fn eigh(&self, UPLO) -> Result<(Self::EigVal, Self::EigVec)>;
 }
 
-/// Eigenvalue decomposition of Hermite matrix
+/// Eigenvalue decomposition of mutable reference of Hermite matrix
 pub trait EighMut {
     type EigVal;
     fn eigh_mut(&mut self, UPLO) -> Result<(Self::EigVal, &mut Self)>;

src/qr.rs

@@ -1,4 +1,6 @@
 //! QR decomposition
+//!
+//! https://en.wikipedia.org/wiki/QR_decomposition
 
 use ndarray::*;
 use num_traits::Zero;