Skip to content

Commit ee38384

Browse files
committed
Move implement comment to Eig_ trait document
1 parent 25800c9 commit ee38384

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

lax/src/eig.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@ use num_traits::{ToPrimitive, Zero};
44

55
#[cfg_attr(doc, katexit::katexit)]
66
/// Eigenvalue problem for general matrix
7+
///
8+
/// LAPACK assumes a column-major input. A row-major input can
9+
/// be interpreted as the transpose of a column-major input. So,
10+
/// for row-major inputs, we we want to solve the following,
11+
/// given the column-major input `A`:
12+
///
13+
/// A^T V = V Λ ⟺ V^T A = Λ V^T ⟺ conj(V)^H A = Λ conj(V)^H
14+
///
15+
/// So, in this case, the right eigenvectors are the conjugates
16+
/// of the left eigenvectors computed with `A`, and the
17+
/// eigenvalues are the eigenvalues computed with `A`.
718
pub trait Eig_: Scalar {
819
/// Compute right eigenvalue and eigenvectors $Ax = \lambda x$
920
///

0 commit comments

Comments
 (0)