Fill module documents

Author: termoshtt

src/cholesky.rs

@@ -1,3 +1,4 @@
+//! Cholesky decomposition
 
 use ndarray::*;
 use num_traits::Zero;

src/eigh.rs

@@ -1,3 +1,4 @@
+//! Eigenvalue decomposition for Hermite matrices
 
 use ndarray::*;
 

src/generate.rs

@@ -1,3 +1,4 @@
+//! Generator functions for matrices
 
 use ndarray::*;
 use std::ops::*;

src/lapack_traits/cholesky.rs

@@ -1,4 +1,4 @@
-//! implement Cholesky decomposition
+//! Cholesky decomposition
 
 use lapack::c;
 

src/lapack_traits/eigh.rs

@@ -1,3 +1,4 @@
+//! Eigenvalue decomposition for Hermite matrices
 
 use lapack::c;
 use num_traits::Zero;
@@ -8,6 +9,7 @@ use layout::Layout;
 
 use super::{into_result, UPLO};
 
+/// Wraps `*syev` for real and `*heev` for complex
 pub trait Eigh_: AssociatedReal {
     fn eigh(calc_eigenvec: bool, Layout, UPLO, a: &mut [Self]) -> Result<Vec<Self::Real>>;
 }

src/lapack_traits/mod.rs

@@ -1,3 +1,4 @@
+//! Define traits wrapping LAPACK routines
 
 pub mod opnorm;
 pub mod qr;
@@ -33,6 +34,7 @@ pub fn into_result<T>(info: i32, val: T) -> Result<T> {
     }
 }
 
+/// Upper/Lower specification for seveal usages
 #[derive(Debug, Clone, Copy)]
 #[repr(u8)]
 pub enum UPLO {

src/lapack_traits/opnorm.rs

@@ -1,4 +1,4 @@
-//! Implement Operator norms for matrices
+//! Operator norms of matrices
 
 use lapack::c;
 use lapack::c::Layout::ColumnMajor as cm;

src/lapack_traits/qr.rs

@@ -1,4 +1,4 @@
-//! Implement QR decomposition
+//! QR decomposition
 
 use std::cmp::min;
 use num_traits::Zero;
@@ -10,6 +10,7 @@ use layout::Layout;
 
 use super::into_result;
 
+/// Wraps `*geqrf` and `*orgqr` (`*ungqr` for complex numbers)
 pub trait QR_: Sized {
     fn householder(Layout, a: &mut [Self]) -> Result<Vec<Self>>;
     fn q(Layout, a: &mut [Self], tau: &[Self]) -> Result<()>;

src/lapack_traits/solve.rs

@@ -1,3 +1,4 @@
+//! Solve linear problem using LU decomposition
 
 use lapack::c;
 
@@ -9,6 +10,7 @@ use super::{Transpose, into_result};
 
 pub type Pivot = Vec<i32>;
 
+/// Wraps `*getrf`, `*getri`, and `*getrs`
 pub trait Solve_: Sized {
     fn lu(Layout, a: &mut [Self]) -> Result<Pivot>;
     fn inv(Layout, a: &mut [Self], &Pivot) -> Result<()>;

src/lapack_traits/svd.rs

@@ -1,4 +1,4 @@
-//! Implement Operator norms for matrices
+//! Singular-value decomposition
 
 use lapack::c;
 use num_traits::Zero;
@@ -17,12 +17,17 @@ enum FlagSVD {
     No = b'N',
 }
 
+/// Result of SVD
 pub struct SVDOutput<A: AssociatedReal> {
+    /// diagonal values
     pub s: Vec<A::Real>,
+    /// Unitary matrix for destination space
     pub u: Option<Vec<A>>,
+    /// Unitary matrix for departure space
     pub vt: Option<Vec<A>>,
 }
 
+/// Wraps `*gesvd`
 pub trait SVD_: AssociatedReal {
     fn svd(Layout, calc_u: bool, calc_vt: bool, a: &mut [Self]) -> Result<SVDOutput<Self>>;
 }