Update document

rust-ndarray · Sep 24, 2022 · 3535eee · 3535eee
1 parent 1334d85
commit 3535eee
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/lax/src/eig.rs b/lax/src/eig.rs
@@ -1,4 +1,12 @@
 //! Eigenvalue problem for general matricies
+//!
+//! LAPACK correspondance
+//! ----------------------
+//!
+//! | f32   | f64   | c32   | c64   |
+//! |:------|:------|:------|:------|
+//! | sgeev | dgeev | cgeev | zgeev |
+//!
 
 use crate::{error::*, layout::MatrixLayout, *};
 use cauchy::*;

diff --git a/lax/src/lib.rs b/lax/src/lib.rs
@@ -58,7 +58,7 @@
 //! According to the property input metrix,
 //! there are several types of eigenvalue problem API
 //!
-//! - [Eig_] trait provides methods for eigenvalue problem for general matrix.
+//! - [eig] module for eigenvalue problem for general matrix.
 //! - [Eigh_] trait provides methods for eigenvalue problem for symmetric/hermite matrix.
 //!
 //! Singular Value Decomposition
@@ -146,6 +146,7 @@ pub trait Lapack:
 macro_rules! impl_lapack {
     ($s:ty) => {
         impl Lapack for $s {
+            /// Compute right eigenvalue and eigenvectors
             fn eig(
                 calc_v: bool,
                 l: MatrixLayout,