Add doc for traits and errors

Author: termoshtt

src/assert.rs

@@ -5,6 +5,7 @@ use ndarray::*;
 use super::types::*;
 use super::norm::*;
 
+/// check two values are close in terms of the relative torrence
 pub fn rclose<A, Tol>(test: A, truth: A, rtol: Tol) -> Result<Tol, Tol>
     where A: Field + Absolute<Output = Tol>,
           Tol: RealField
@@ -13,6 +14,7 @@ pub fn rclose<A, Tol>(test: A, truth: A, rtol: Tol) -> Result<Tol, Tol>
     if dev < rtol { Ok(dev) } else { Err(dev) }
 }
 
+/// check two values are close in terms of the absolute torrence
 pub fn aclose<A, Tol>(test: A, truth: A, atol: Tol) -> Result<Tol, Tol>
     where A: Field + Absolute<Output = Tol>,
           Tol: RealField

src/error.rs

@@ -6,6 +6,7 @@ use ndarray::{Ixs, ShapeError};
 
 pub type Result<T> = ::std::result::Result<T, LinalgError>;
 
+/// Master Error type of this crate
 #[derive(Debug, EnumError)]
 pub enum LinalgError {
     NotSquare(NotSquareError),
@@ -15,6 +16,7 @@ pub enum LinalgError {
     Shape(ShapeError),
 }
 
+/// Error from LAPACK
 #[derive(Debug, new)]
 pub struct LapackError {
     pub return_code: i32,
@@ -38,6 +40,7 @@ impl From<i32> for LapackError {
     }
 }
 
+/// Error that matrix is not square
 #[derive(Debug, new)]
 pub struct NotSquareError {
     pub rows: i32,
@@ -56,6 +59,7 @@ impl error::Error for NotSquareError {
     }
 }
 
+/// Error that strides of the array is not supported
 #[derive(Debug, new)]
 pub struct StrideError {
     pub s0: Ixs,
@@ -74,6 +78,7 @@ impl error::Error for StrideError {
     }
 }
 
+/// Error that the memory is not aligned continously
 #[derive(Debug, new)]
 pub struct MemoryContError {}
 

src/generate.rs

@@ -8,6 +8,7 @@ use super::layout::*;
 use super::types::*;
 use super::error::*;
 
+/// Hermite conjugate matrix
 pub fn conjugate<A, Si, So>(a: &ArrayBase<Si, Ix2>) -> ArrayBase<So, Ix2>
     where A: Conjugate,
           Si: Data<Elem = A>,
@@ -20,6 +21,7 @@ pub fn conjugate<A, Si, So>(a: &ArrayBase<Si, Ix2>) -> ArrayBase<So, Ix2>
     a
 }
 
+/// Generate random array
 pub fn random<A, S, Sh, D>(sh: Sh) -> ArrayBase<S, D>
     where A: RandNormal,
           S: DataOwned<Elem = A>,

src/types.rs

@@ -36,14 +36,17 @@ trait_alias!(Field: LapackScalar,
 
 trait_alias!(RealField: Field, Float);
 
+/// Define associating real float type
 pub trait AssociatedReal: Sized {
     type Real: Float + Mul<Self, Output = Self>;
 }
+
+/// Define associating complex type
 pub trait AssociatedComplex: Sized {
     type Complex;
 }
 
-/// Field with norm
+/// Define `abs()` more generally
 pub trait Absolute {
     type Output: RealField;
     fn squared(&self) -> Self::Output;
@@ -52,14 +55,17 @@ pub trait Absolute {
     }
 }
 
+/// Define `sqrt()` more generally
 pub trait SquareRoot {
     fn sqrt(&self) -> Self;
 }
 
+/// Complex conjugate value
 pub trait Conjugate: Copy {
     fn conj(self) -> Self;
 }
 
+/// Scalars which can be initialized from Gaussian random number
 pub trait RandNormal {
     fn randn<R: Rng>(&mut R) -> Self;
 }