Skip to content

Commit a621b1b

Browse files
committed
Update module-level documents
1 parent e381bf2 commit a621b1b

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

lax/src/cholesky.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Factorize positive-definite symmetric/Hermitian matrices using Cholesky algorithm
2+
13
use super::*;
24
use crate::{error::*, layout::*};
35
use cauchy::*;

lax/src/lib.rs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,8 +228,6 @@ pub trait Lapack: OperatorNorm_ + Triangular_ + Tridiagonal_ + Rcond_ {
228228
/// 1. Factorize given matrix $A$ into upper ($U$) or lower ($L$) form with diagonal matrix $D$
229229
/// 2. Then solve linear equation $Ax = b$, and/or calculate inverse matrix $A^{-1}$
230230
///
231-
/// [BK]: https://doi.org/10.2307/2005787
232-
///
233231
fn bk(l: MatrixLayout, uplo: UPLO, a: &mut [Self]) -> Result<Pivot>;
234232

235233
/// Compute inverse matrix $A^{-1}$ using the result of [Lapack::bk]

lax/src/solveh.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
//! Factorize symmetric/Hermitian matrix using [Bunch-Kaufman diagonal pivoting method][BK]
2+
//!
3+
//! [BK]: https://doi.org/10.2307/2005787
4+
//!
5+
16
use crate::{error::*, layout::MatrixLayout, *};
27
use cauchy::*;
38
use num_traits::{ToPrimitive, Zero};

0 commit comments

Comments
 (0)