Doc string corrections

This commit is contained in:
metric-space 2022-02-12 02:52:18 -05:00
parent 91b7e05072
commit 7510d48673
2 changed files with 2 additions and 1 deletions

View File

@ -13,7 +13,7 @@ use na::{DefaultAllocator, Matrix, OMatrix, OVector, Scalar};
use lapack; use lapack;
/// Generalized eigenvalues and generalized eigenvectors(left and right) of a pair of N*N square matrices. /// Generalized eigenvalues and generalized eigenvectors (left and right) of a pair of N*N square matrices.
/// ///
/// Each generalized eigenvalue (lambda) satisfies determinant(A - lambda*B) = 0 /// Each generalized eigenvalue (lambda) satisfies determinant(A - lambda*B) = 0
/// ///

View File

@ -14,6 +14,7 @@ use na::{DefaultAllocator, Matrix, OMatrix, OVector, Scalar};
use lapack; use lapack;
/// QZ decomposition of a pair of N*N square matrices. /// QZ decomposition of a pair of N*N square matrices.
///
/// Retrieves the left and right matrices of Schur Vectors (VSL and VSR) /// Retrieves the left and right matrices of Schur Vectors (VSL and VSR)
/// the upper-quasitriangular matrix `S` and upper triangular matrix `T` such that the /// the upper-quasitriangular matrix `S` and upper triangular matrix `T` such that the
/// decomposed input matrix `a` equals `VSL * S * VSL.transpose()` and /// decomposed input matrix `a` equals `VSL * S * VSL.transpose()` and