Skip to content

Commit 7432f02

Browse files
termoshtttermoshtt
committed
Unify LAPACK correspondance table
1 parent e94e03d commit 7432f02

3 files changed

Lines changed: 43 additions & 50 deletions

File tree

‎lax/src/cholesky.rs‎

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,9 @@ pub trait Cholesky_: Sized {
2222
/// LAPACK correspondance
2323
/// ----------------------
2424
///
25-
/// | f32 | f64 | c32 | c64 |
26-
/// |:---------|:---------|:---------|:---------|
27-
/// | [spotrf] | [dpotrf] | [cpotrf] | [zpotrf] |
28-
///
29-
/// [spotrf]: https://netlib.org/lapack/explore-html/d8/db2/group__real_p_ocomputational_gaaf31db7ab15b4f4ba527a3d31a15a58e.html
30-
/// [dpotrf]: https://netlib.org/lapack/explore-html/d1/d7a/group__double_p_ocomputational_ga2f55f604a6003d03b5cd4a0adcfb74d6.html
31-
/// [cpotrf]: https://netlib.org/lapack/explore-html/d8/d6c/group__variants_p_ocomputational_ga4e85f48dbd837ccbbf76aa077f33de19.html
32-
/// [zpotrf]: https://netlib.org/lapack/explore-html/d3/d8d/group__complex16_p_ocomputational_ga93e22b682170873efb50df5a79c5e4eb.html
25+
/// | f32 | f64 | c32 | c64 |
26+
/// |:-------|:-------|:-------|:-------|
27+
/// | spotrf | dpotrf | cpotrf | zpotrf |
3328
///
3429
fn cholesky(l: MatrixLayout, uplo: UPLO, a: &mut [Self]) -> Result<()>;
3530

@@ -38,14 +33,9 @@ pub trait Cholesky_: Sized {
3833
/// LAPACK correspondance
3934
/// ----------------------
4035
///
41-
/// | f32 | f64 | c32 | c64 |
42-
/// |:---------|:---------|:---------|:---------|
43-
/// | [spotri] | [dpotri] | [cpotri] | [zpotri] |
44-
///
45-
/// [spotri]: https://netlib.org/lapack/explore-html/d8/db2/group__real_p_ocomputational_ga4c381894bb34b1583fcc0dceafc5bea1.html
46-
/// [dpotri]: https://netlib.org/lapack/explore-html/d1/d7a/group__double_p_ocomputational_ga9dfc04beae56a3b1c1f75eebc838c14c.html
47-
/// [cpotri]: https://netlib.org/lapack/explore-html/d6/df6/group__complex_p_ocomputational_ga52b8da4d314abefaee93dd5c1ed7739e.html
48-
/// [zpotri]: https://netlib.org/lapack/explore-html/d3/d8d/group__complex16_p_ocomputational_gaf37e3b8bbacd3332e83ffb3f1018bcf1.html
36+
/// | f32 | f64 | c32 | c64 |
37+
/// |:-------|:-------|:-------|:-------|
38+
/// | spotri | dpotri | cpotri | zpotri |
4939
///
5040
fn inv_cholesky(l: MatrixLayout, uplo: UPLO, a: &mut [Self]) -> Result<()>;
5141

@@ -54,14 +44,9 @@ pub trait Cholesky_: Sized {
5444
/// LAPACK correspondance
5545
/// ----------------------
5646
///
57-
/// | f32 | f64 | c32 | c64 |
58-
/// |:---------|:---------|:---------|:---------|
59-
/// | [spotrs] | [dpotrs] | [cpotrs] | [zpotrs] |
60-
///
61-
/// [spotrs]: https://netlib.org/lapack/explore-html/d8/db2/group__real_p_ocomputational_gaf5cc1531aa5ffe706533fbca343d55dd.html
62-
/// [dpotrs]: https://netlib.org/lapack/explore-html/d1/d7a/group__double_p_ocomputational_ga167aa0166c4ce726385f65e4ab05e7c1.html
63-
/// [cpotrs]: https://netlib.org/lapack/explore-html/d6/df6/group__complex_p_ocomputational_gad9052b4b70569dfd6e8943971c9b38b2.html
64-
/// [zpotrs]: https://netlib.org/lapack/explore-html/d3/d8d/group__complex16_p_ocomputational_gaa2116ea574b01efda584dff0b74c9fcd.html
47+
/// | f32 | f64 | c32 | c64 |
48+
/// |:-------|:-------|:-------|:-------|
49+
/// | spotrs | dpotrs | cpotrs | zpotrs |
6550
///
6651
fn solve_cholesky(l: MatrixLayout, uplo: UPLO, a: &[Self], b: &mut [Self]) -> Result<()>;
6752
}

‎lax/src/solve.rs‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,35 @@ pub trait Solve_: Scalar + Sized {
3232
/// - On this case, `return_code` in [Error::LapackComputationalFailure] means
3333
/// `return_code`-th diagonal element of $U$ becomes zero.
3434
///
35+
/// LAPACK correspondance
36+
/// ----------------------
37+
///
38+
/// | f32 | f64 | c32 | c64 |
39+
/// |:-------|:-------|:-------|:-------|
40+
/// | sgetrf | dgetrf | cgetrf | zgetrf |
41+
///
3542
fn lu(l: MatrixLayout, a: &mut [Self]) -> Result<Pivot>;
3643

37-
/// Compute inverse matrix $A^{-1}$ from the output of LU-factorization
44+
/// Compute inverse matrix $A^{-1}$ from the output of LU-decomposition
45+
///
46+
/// LAPACK correspondance
47+
/// ----------------------
48+
///
49+
/// | f32 | f64 | c32 | c64 |
50+
/// |:-------|:-------|:-------|:-------|
51+
/// | sgetri | dgetri | cgetri | zgetri |
52+
///
3853
fn inv(l: MatrixLayout, a: &mut [Self], p: &Pivot) -> Result<()>;
3954

40-
/// Solve linear equations $Ax = b$ using the output of LU-factorization
55+
/// Solve linear equations $Ax = b$ using the output of LU-decomposition
56+
///
57+
/// LAPACK correspondance
58+
/// ----------------------
59+
///
60+
/// | f32 | f64 | c32 | c64 |
61+
/// |:-------|:-------|:-------|:-------|
62+
/// | sgetrs | dgetrs | cgetrs | zgetrs |
63+
///
4164
fn solve(l: MatrixLayout, t: Transpose, a: &[Self], p: &Pivot, b: &mut [Self]) -> Result<()>;
4265
}
4366

‎lax/src/solveh.rs‎

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,9 @@ pub trait Solveh_: Sized {
2424
/// LAPACK correspondance
2525
/// ----------------------
2626
///
27-
/// | f32 | f64 | c32 | c64 |
28-
/// |:---------|:---------|:---------|:---------|
29-
/// | [ssytrf] | [dsytrf] | [chetrf] | [zhetrf] |
30-
///
31-
/// [ssytrf]: https://netlib.org/lapack/explore-html/d0/d14/group__real_s_ycomputational_ga12d2e56511cf7df066712c61d9acec45.html
32-
/// [dsytrf]: https://netlib.org/lapack/explore-html/d3/db6/group__double_s_ycomputational_gad91bde1212277b3e909eb6af7f64858a.html
33-
/// [chetrf]: https://netlib.org/lapack/explore-html/d4/d74/group__complex_h_ecomputational_ga081dd1908e46d064c2bf0a1f6b664b86.html
34-
/// [zhetrf]: https://netlib.org/lapack/explore-html/d3/d80/group__complex16_h_ecomputational_gadc84a5c9818ee12ea19944623131bd52.html
27+
/// | f32 | f64 | c32 | c64 |
28+
/// |:-------|:-------|:-------|:-------|
29+
/// | ssytrf | dsytrf | chetrf | zhetrf |
3530
///
3631
fn bk(l: MatrixLayout, uplo: UPLO, a: &mut [Self]) -> Result<Pivot>;
3732

@@ -40,14 +35,9 @@ pub trait Solveh_: Sized {
4035
/// LAPACK correspondance
4136
/// ----------------------
4237
///
43-
/// | f32 | f64 | c32 | c64 |
44-
/// |:---------|:---------|:---------|:---------|
45-
/// | [ssytri] | [dsytri] | [chetri] | [zhetri] |
46-
///
47-
/// [ssytri]: https://netlib.org/lapack/explore-html/d0/d14/group__real_s_ycomputational_gaef378ec0761234aac417f487b43b7a8b.html
48-
/// [dsytri]: https://netlib.org/lapack/explore-html/d3/db6/group__double_s_ycomputational_ga75e09b4299b7955044a3bbf84c46b593.html
49-
/// [chetri]: https://netlib.org/lapack/explore-html/d4/d74/group__complex_h_ecomputational_gad87a6a1ac131c5635d47ac440e672bcf.html
50-
/// [zhetri]: https://netlib.org/lapack/explore-html/d3/d80/group__complex16_h_ecomputational_ga4d9cfa0653de400029b8051996ce1e96.html
38+
/// | f32 | f64 | c32 | c64 |
39+
/// |:-------|:-------|:-------|:-------|
40+
/// | ssytri | dsytri | chetri | zhetri |
5141
///
5242
fn invh(l: MatrixLayout, uplo: UPLO, a: &mut [Self], ipiv: &Pivot) -> Result<()>;
5343

@@ -56,14 +46,9 @@ pub trait Solveh_: Sized {
5646
/// LAPACK correspondance
5747
/// ----------------------
5848
///
59-
/// | f32 | f64 | c32 | c64 |
60-
/// |:---------|:---------|:---------|:---------|
61-
/// | [ssytrs] | [dsytrs] | [chetrs] | [zhetrs] |
62-
///
63-
/// [ssytrs]: https://netlib.org/lapack/explore-html/d0/d14/group__real_s_ycomputational_gae20133a1119b69a7319783ff982c8c62.html
64-
/// [dsytrs]: https://netlib.org/lapack/explore-html/d3/db6/group__double_s_ycomputational_ga6a223e61effac7232e98b422f147f032.html
65-
/// [chetrs]: https://netlib.org/lapack/explore-html/d4/d74/group__complex_h_ecomputational_ga6f9d8da222ffaa7b7535efc922faa1dc.html
66-
/// [zhetrs]: https://netlib.org/lapack/explore-html/d3/d80/group__complex16_h_ecomputational_gacf697e3bb72c5fd88cd90972999401dd.html
49+
/// | f32 | f64 | c32 | c64 |
50+
/// |:-------|:-------|:-------|:-------|
51+
/// | ssytrs | dsytrs | chetrs | zhetrs |
6752
///
6853
fn solveh(l: MatrixLayout, uplo: UPLO, a: &[Self], ipiv: &Pivot, b: &mut [Self]) -> Result<()>;
6954
}

0 commit comments

Comments
 (0)