Skip to content

Commit 3535eee

Browse files
committed
Update document
1 parent 1334d85 commit 3535eee

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

lax/src/eig.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
//! Eigenvalue problem for general matricies
2+
//!
3+
//! LAPACK correspondance
4+
//! ----------------------
5+
//!
6+
//! | f32 | f64 | c32 | c64 |
7+
//! |:------|:------|:------|:------|
8+
//! | sgeev | dgeev | cgeev | zgeev |
9+
//!
210
311
use crate::{error::*, layout::MatrixLayout, *};
412
use cauchy::*;

lax/src/lib.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
//! According to the property input metrix,
5959
//! there are several types of eigenvalue problem API
6060
//!
61-
//! - [Eig_] trait provides methods for eigenvalue problem for general matrix.
61+
//! - [eig] module for eigenvalue problem for general matrix.
6262
//! - [Eigh_] trait provides methods for eigenvalue problem for symmetric/hermite matrix.
6363
//!
6464
//! Singular Value Decomposition
@@ -146,6 +146,7 @@ pub trait Lapack:
146146
macro_rules! impl_lapack {
147147
($s:ty) => {
148148
impl Lapack for $s {
149+
/// Compute right eigenvalue and eigenvectors
149150
fn eig(
150151
calc_v: bool,
151152
l: MatrixLayout,

0 commit comments

Comments
 (0)