Skip to content

Commit 83f229b

Browse files
committed
doxygen: ensure all groups are listed
1 parent cee3652 commit 83f229b

File tree

7 files changed

+107
-39
lines changed

7 files changed

+107
-39
lines changed

compute/zgeinv.c

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -148,15 +148,13 @@ int plasma_zgeinv(int m, int n, plasma_complex64_t *pA, int lda, int *ipiv)
148148
*
149149
* @ingroup plasma_geinv
150150
*
151-
* Computes the inverse of a complex Hermitian
152-
* positive definite matrix A using the Cholesky factorization.
151+
* Computes the inverse of a general matrix A using the LU factorization.
153152
*
154153
*******************************************************************************
155154
*
156155
* @param[in] A
157-
* On entry, the Hermitian positive definite matrix A.
158-
* On exit, the upper or lower triangle of the (Hermitian)
159-
* inverse of A, overwriting the input factor U or L.
156+
* On entry, the general matrix A.
157+
* On exit, the inverse of A.
160158
*
161159
* @param[out] ipiv
162160
* The pivot indices; for 1 <= i <= min(m,n), row i of the

core_blas/core_zgbtype1cb.c

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
/**
3030
*****************************************************************************
3131
*
32-
* @ingroup core_zgbtype1cb
32+
* @ingroup core_tbbrd_type1
3333
*
3434
* core_zgbtype1cb is a kernel that will operate on a region (triangle) of data
3535
* bounded by st and ed. This kernel eliminate a column by an column-wise
@@ -149,7 +149,7 @@ void plasma_core_zgbtype1cb (plasma_enum_t uplo, int n, int nb,
149149
/* ========================
150150
* UPPER CASE
151151
* ========================*/
152-
// Eliminate the row at st-1
152+
// Eliminate the row at st-1
153153
*VP(vpos) = 1.;
154154
for(i=1; i<len; i++){
155155
*VP(vpos+i) = conj(*AU(st-1, st+i));
@@ -158,12 +158,12 @@ void plasma_core_zgbtype1cb (plasma_enum_t uplo, int n, int nb,
158158
ctmp = conj(*AU(st-1, st));
159159
LAPACKE_zlarfg_work(len, &ctmp, VP(vpos+1), 1, TAUP(taupos) );
160160
*AU(st-1, st) = ctmp;
161-
// Apply right on A(st:ed,st:ed)
161+
// Apply right on A(st:ed,st:ed)
162162
ctmp = *TAUP(taupos);
163163
LAPACKE_zlarfx_work(LAPACK_COL_MAJOR, 'R',
164164
len, len, VP(vpos), ctmp, AU(st, st), LDX, WORK);
165165

166-
// Eliminate the created col at st
166+
// Eliminate the created col at st
167167
*VQ(vpos) = 1.;
168168
memcpy( VQ(vpos+1), AU(st+1, st), (len-1)*sizeof(plasma_complex64_t) );
169169
memset( AU(st+1, st), 0, (len-1)*sizeof(plasma_complex64_t) );
@@ -176,16 +176,16 @@ void plasma_core_zgbtype1cb (plasma_enum_t uplo, int n, int nb,
176176
/* ========================
177177
* LOWER CASE
178178
* ========================*/
179-
// Eliminate the col at st-1
179+
// Eliminate the col at st-1
180180
*VQ(vpos) = 1.;
181181
memcpy( VQ(vpos+1), AL(st+1, st-1), (len-1)*sizeof(plasma_complex64_t) );
182182
memset( AL(st+1, st-1), 0, (len-1)*sizeof(plasma_complex64_t) );
183183
LAPACKE_zlarfg_work(len, AL(st, st-1), VQ(vpos+1), 1, TAUQ(taupos) );
184-
// Apply left on A(st:ed,st:ed)
184+
// Apply left on A(st:ed,st:ed)
185185
ctmp = conj(*TAUQ(taupos));
186186
LAPACKE_zlarfx_work(LAPACK_COL_MAJOR, 'L',
187187
len, len, VQ(vpos), ctmp, AL(st, st), LDX, WORK);
188-
// Eliminate the created row at st
188+
// Eliminate the created row at st
189189
*VP(vpos) = 1.;
190190
for(i=1; i<len; i++){
191191
*VP(vpos+i) = conj(*AL(st, st+i));

core_blas/core_zgbtype2cb.c

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
/***************************************************************************//**
3030
*
31-
* @ingroup core_zgbtype2cb
31+
* @ingroup core_tbbrd_type2
3232
*
3333
* core_zgbtype2cb is a kernel that will operate on a region (triangle) of data
3434
* bounded by st and ed. This kernel apply the right update remaining from the
@@ -154,7 +154,7 @@ void plasma_core_zgbtype2cb (plasma_enum_t uplo, int n, int nb,
154154
findVTpos(n, nb, Vblksiz, sweep, st,
155155
&vpos, &taupos, &tpos, &blkid);
156156
}
157-
// Apply remaining Left commming from type1/3_upper
157+
// Apply remaining Left commming from type1/3_upper
158158
ctmp = conj(*TAUQ(taupos));
159159
LAPACKE_zlarfx_work(LAPACK_COL_MAJOR, 'L',
160160
lem, len, VQ(vpos), ctmp, AU(st, J1), LDX, WORK);
@@ -168,13 +168,13 @@ void plasma_core_zgbtype2cb (plasma_enum_t uplo, int n, int nb,
168168
findVTpos(n,nb,Vblksiz,sweep,J1, &vpos, &taupos, &tpos, &blkid);
169169
}
170170

171-
// Remove the top row of the created bulge
171+
// Remove the top row of the created bulge
172172
*VP(vpos) = 1.;
173173
for(i=1; i<len; i++){
174174
*VP(vpos+i) = conj(*AU(st, J1+i));
175175
*AU(st, J1+i) = 0.;
176176
}
177-
// Eliminate the row at st
177+
// Eliminate the row at st
178178
ctmp = conj(*AU(st, J1));
179179
LAPACKE_zlarfg_work(len, &ctmp, VP(vpos+1), 1, TAUP(taupos) );
180180
*AU(st, J1) = ctmp;
@@ -200,7 +200,7 @@ void plasma_core_zgbtype2cb (plasma_enum_t uplo, int n, int nb,
200200
findVTpos(n, nb, Vblksiz, sweep, st,
201201
&vpos, &taupos, &tpos, &blkid);
202202
}
203-
// Apply remaining Right commming from type1/3_lower
203+
// Apply remaining Right commming from type1/3_lower
204204
ctmp = (*TAUP(taupos));
205205
LAPACKE_zlarfx_work(LAPACK_COL_MAJOR, 'R',
206206
len, lem, VP(vpos), ctmp, AL(J1, st), LDX, WORK);
@@ -217,7 +217,7 @@ void plasma_core_zgbtype2cb (plasma_enum_t uplo, int n, int nb,
217217
*VQ(vpos) = 1.;
218218
memcpy(VQ(vpos+1), AL(J1+1, st), (len-1)*sizeof(plasma_complex64_t));
219219
memset(AL(J1+1, st), 0, (len-1)*sizeof(plasma_complex64_t));
220-
// Eliminate the col at st
220+
// Eliminate the col at st
221221
LAPACKE_zlarfg_work(len, AL(J1, st), VQ(vpos+1), 1, TAUQ(taupos) );
222222
/*
223223
* Apply left on A(J1:J2,st+1:ed)

core_blas/core_zgbtype3cb.c

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
/***************************************************************************//**
3030
*
31-
* @ingroup core_zgbtype3cb
31+
* @ingroup core_tbbrd_type3
3232
*
3333
* core_zgbtype3cb is a kernel that will operate on a region (triangle) of data
3434
* bounded by st and ed. This kernel apply a left+right update on the hermitian
@@ -144,12 +144,12 @@ void plasma_core_zgbtype3cb(plasma_enum_t uplo, int n, int nb,
144144
/* ========================
145145
* UPPER CASE
146146
* ========================*/
147-
// Apply right on A(st:ed,st:ed)
147+
// Apply right on A(st:ed,st:ed)
148148
ctmp = *TAUP(taupos);
149149
LAPACKE_zlarfx_work(LAPACK_COL_MAJOR, 'R',
150150
len, len, VP(vpos), ctmp, AU(st, st), LDX, WORK);
151151

152-
// Eliminate the created col at st
152+
// Eliminate the created col at st
153153
*VQ(vpos) = 1.;
154154
memcpy( VQ(vpos+1), AU(st+1, st), (len-1)*sizeof(plasma_complex64_t) );
155155
memset( AU(st+1, st), 0, (len-1)*sizeof(plasma_complex64_t) );
@@ -162,7 +162,7 @@ void plasma_core_zgbtype3cb(plasma_enum_t uplo, int n, int nb,
162162
/* ========================
163163
* LOWER CASE
164164
* ========================*/
165-
// Apply left on A(st:ed,st:ed)
165+
// Apply left on A(st:ed,st:ed)
166166
ctmp = conj(*TAUQ(taupos));
167167
LAPACKE_zlarfx_work(LAPACK_COL_MAJOR, 'L',
168168
len, len, VQ(vpos), ctmp, AL(st, st), LDX, WORK);
@@ -180,7 +180,7 @@ void plasma_core_zgbtype3cb(plasma_enum_t uplo, int n, int nb,
180180
LAPACKE_zlarfx_work(LAPACK_COL_MAJOR, 'R',
181181
lenj, len, VP(vpos), ctmp, AL(st+1, st), LDX, WORK);
182182
}
183-
// end of uplo case
183+
// end of uplo case
184184
return;
185185
}
186186
/***************************************************************************/

core_blas/core_zlacpy_band.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
/*******************************************************************************
1919
*
20-
* @ingroup core_plasma_complex64_t
20+
* @ingroup core_lacpy
2121
*
2222
* plasma_core_zlacpy copies a sub-block A of a band matrix stored in LAPACK's band format
2323
* to a corresponding sub-block B of a band matrix in PLASMA's band format
@@ -128,7 +128,7 @@ void plasma_core_omp_zlacpy_lapack2tile_band(plasma_enum_t uplo,
128128

129129
/*******************************************************************************
130130
*
131-
* @ingroup core_plasma_complex64_t
131+
* @ingroup core_lacpy
132132
*
133133
* plasma_core_zlacpy copies all or part of a two-dimensional matrix A to another
134134
* matrix B

core_blas/core_zlarfb_gemm.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
/***************************************************************************//**
1818
*
19-
* @ingroup CORE_plasma_Complex64_t
19+
* @ingroup core_larfb
2020
*
2121
* CORE_zlarfb_gemm applies a complex block reflector H or its transpose H'
2222
* to a complex M-by-N matrix C, from either the left or the right.

docs/doxygen/groups.dox

Lines changed: 83 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@
2323
@brief Solves \f$ Ax = b \f$ using LU factorization for general matrices
2424
@{
2525
@defgroup plasma_gesv gesv: Solves Ax = b using LU factorization (driver)
26+
@defgroup plasma_geinv geinv: LU inverse
2627
@defgroup plasma_getrf getrf: LU factorization
2728
@defgroup plasma_getrs getrs: LU forward and back solves
28-
@defgroup plasma_getri getri: LU inverse
29+
@defgroup plasma_getri getri: LU inverse using factorization
2930
@defgroup plasma_gerfs gerfs: Refine solution
3031
@defgroup group_gesv_aux Auxiliary routines
3132
@{
@@ -34,6 +35,14 @@
3435
@}
3536
@}
3637

38+
@defgroup group_gesv General band matrices: LU
39+
@brief Solves \f$ Ax = b \f$ using LU factorization for general band matrices
40+
@{
41+
@defgroup plasma_gbsv gbsv: Solves Ax = b using LU factorization (driver)
42+
@defgroup plasma_gbtrf gbtrf: LU factorization
43+
@defgroup plasma_gbtrs gbtrs: LU forward and back solves
44+
@}
45+
3746
@defgroup group_gels General matrices: least squares
3847
@brief Solves \f$ Ax \approx b \f$ where \f$ A \f$ is rectangular
3948
@see group_orthogonal
@@ -47,17 +56,27 @@
4756
@brief Solves \f$ Ax = b \f$ using Cholesky factorization for SPD/HPD matrices
4857
@{
4958
@defgroup plasma_posv posv: Solves Ax = b using Cholesky factorization (driver)
59+
@defgroup plasma_poinv poinv: Cholesky inverse
5060
@defgroup plasma_potrf potrf: Cholesky factorization
5161
@defgroup plasma_potrs potrs: Cholesky forward and back solves
52-
@defgroup plasma_potri potri: Cholesky inverse
62+
@defgroup plasma_potri potri: Cholesky inverse using factorization
5363
@defgroup plasma_porfs porfs: Refine solution
5464
@defgroup group_posv_aux Auxiliary routines
5565
@{
5666
@defgroup plasma_potf2 potf2: Cholesky panel factorization
5767
@defgroup plasma_lauum lauum: Multiplies triangular matrices; used in potri
68+
@defgroup core_lauum core_lauum
5869
@}
5970
@}
6071

72+
@defgroup group_pbsv Symmetric/Hermitian positive definite band: Cholesky
73+
@brief Solves \f$ Ax = b \f$ using Cholesky factorization for SPD/HPD matrices
74+
@{
75+
@defgroup plasma_pbsv pbsv: Solves Ax = b using Cholesky factorization (driver)
76+
@defgroup plasma_pbtrf pbtrf: Cholesky factorization
77+
@defgroup plasma_pbtrs pbtrs: Cholesky forward and back solves
78+
@}
79+
6180
@defgroup group_hesv Symmetric/Hermitian indefinite
6281
@brief Solves \f$ Ax = b \f$ using indefinite factorization for symmetric/Hermitian matrices
6382
@{
@@ -133,12 +152,15 @@
133152
@defgroup plasma_heev sy/heev: Solves using QR iteration (driver)
134153
@defgroup plasma_heevd sy/heevd: Solves using divide-and-conquer (driver)
135154
@defgroup plasma_heevr sy/heevr: Solves using MRRR (driver)
155+
@defgroup plasma_stevx stevx: Solves tridiagonal using bisection
156+
@defgroup plasma_stevx2 stevx2: Solves tridiagonal using bisection
136157

137158
@defgroup plasma_hetrd sy/hetrd: Tridiagonal reduction
138159
@defgroup plasma_unmtr or/unmtr: Multiplies by Q from tridiagonal reduction
139160
@defgroup plasma_ungtr or/ungtr: Generates Q from tridiagonal reduction
140161
@defgroup group_heev_aux Auxiliary routines
141162
@{
163+
@defgroup plasma_laebz laebz: Subdivides bracket in bisection.
142164
@}
143165
@}
144166

@@ -247,6 +269,9 @@
247269
@defgroup plasma_syr2 syr2: Symmetric rank 2 update
248270
@brief \f$ A = \alpha xy^T + \alpha yx^T + A \f$
249271

272+
@defgroup plasma_tradd tradd: Add triangular matrices
273+
@brief \f$ B = \alpha A + \beta B \f$
274+
250275
@defgroup plasma_trmv trmv: Triangular matrix-vector multiply
251276
@brief \f$ x = Ax \f$
252277

@@ -275,6 +300,9 @@
275300
@defgroup plasma_gemm gemm: General matrix multiply: C = AB + C
276301
@brief \f$ C = \alpha \;op(A) \;op(B) + \beta C \f$
277302

303+
@defgroup plasma_gbmm gbmm: General band matrix multiply: C = AB + C
304+
@brief \f$ C = \alpha \;op(A) \;op(B) + \beta C \f$
305+
278306
@defgroup plasma_hemm hemm: Hermitian matrix multiply
279307
@brief \f$ C = \alpha A B + \beta C \f$
280308
or \f$ C = \alpha B A + \beta C \f$ where \f$ A \f$ is Hermitian
@@ -323,13 +351,19 @@
323351

324352
@defgroup group_norms Matrix norms
325353
@{
326-
@defgroup plasma_lange lange: General matrix norm
354+
@defgroup plasma_lange lange: General matrix norm
327355
@brief 1, Frobenius, or Infinity norm; or largest element
328356

329-
@defgroup plasma_lanhe lansy/he: Symmetric/Hermitian matrix norm
357+
@defgroup plasma_langb langb: General band matrix norm
330358
@brief 1, Frobenius, or Infinity norm; or largest element
331359

332-
@defgroup plasma_lantr lantr: Triangular matrix norm
360+
@defgroup plasma_lanhe lanhe: Hermitian matrix norm
361+
@brief 1, Frobenius, or Infinity norm; or largest element
362+
363+
@defgroup plasma_lansy lansy: Symmetric matrix norm
364+
@brief 1, Frobenius, or Infinity norm; or largest element
365+
366+
@defgroup plasma_lantr lantr: Triangular matrix norm
333367
@brief 1, Frobenius, or Infinity norm; or largest element
334368
@}
335369
@}
@@ -415,6 +449,9 @@
415449
@defgroup core_syr2 syr2: Symmetric rank 2 update
416450
@brief \f$ A = \alpha xy^T + \alpha yx^T + A \f$
417451

452+
@defgroup core_tradd tradd: Add triangular matrices
453+
@brief \f$ B = \alpha A + \beta B \f$
454+
418455
@defgroup core_trmv trmv: Triangular matrix-vector multiply
419456
@brief \f$ x = Ax \f$
420457

@@ -433,6 +470,12 @@
433470
@defgroup core_laset laset: Set matrix to constants
434471
@brief \f$ A_{ij} = \f$ diag if \f$ i=j \f$;
435472
\f$ A_{ij} = \f$ offdiag otherwise.
473+
474+
@defgroup core_laswp laswp: Swap rows of general matrix
475+
@brief \f$ A = P A \f$
476+
477+
@defgroup core_heswp heswp: Swap rows of Hermitian matrix
478+
@brief \f$ A = P A P^T \f$
436479
@}
437480

438481
@defgroup core_blas3 Level 3: matrix-matrix operations, O(n^3) work
@@ -506,17 +549,44 @@
506549

507550
@defgroup core_solvers Linear system solvers
508551
@{
509-
@defgroup core_potrf potrf: Cholesky factorization
552+
@defgroup core_potrf potrf: Cholesky factorization of a tile
553+
@}
554+
555+
@defgroup core_orthogonal Orthogonal/unitary factorizations
556+
@{
510557
@defgroup core_geqrt geqrt: QR factorization of a tile
511-
@defgroup core_tsqrt tsqrt: QR factorization of a rectangular matrix of two tiles
512-
@defgroup core_unmqr unmqr: Apply Householder reflectors from QR to a tile
513-
@defgroup core_tsmqr tsmqr: Apply Householder reflectors from QR to a rectangular matrix of two tiles
514558
@defgroup core_gelqt gelqt: LQ factorization of a tile
515-
@defgroup core_tslqt tslqt: LQ factorization of a rectangular matrix of two tiles
559+
560+
@defgroup core_unmqr unmqr: Apply Householder reflectors from QR to a tile
516561
@defgroup core_unmlq unmlq: Apply Householder reflectors from LQ to a tile
517-
@defgroup core_tsmlq tsmlq: Apply Householder reflectors from LQ to a rectangular matrix of two tiles
518-
@defgroup core_pamm pamm: Updating a matrix using two tiles
519-
@defgroup core_parfb parfb: Apply Householder reflectors to a rectangular matrix of two tiles
562+
563+
@defgroup core_tsqrt tsqrt: QR factorization of triangle-square tiles
564+
@defgroup core_tslqt tslqt: LQ factorization of triangle-square tiles
565+
566+
@defgroup core_tsmqr tsmqr: Apply Householder reflectors from QR of triangle-square tiles
567+
@defgroup core_tsmlq tsmlq: Apply Householder reflectors from LQ of triangle-square tiles
568+
569+
@defgroup core_ttqrt ttqrt: QR factorization of triangle-triangle tiles
570+
@defgroup core_ttlqt ttlqt: LQ factorization of triangle-triangle tiles
571+
572+
@defgroup core_ttmqr ttmqr: Apply Householder reflectors from QR of triangle-triangle tiles
573+
@defgroup core_ttmlq ttmlq: Apply Householder reflectors from LQ of triangle-triangle tiles
574+
575+
@defgroup core_parfb parfb: Apply Householder reflectors to two tiles
576+
@defgroup core_pamm pamm: pentagonal matrix-matrix multiply
577+
@defgroup core_pemv pemv: pentagonal matrix-vector multiply
578+
@}
579+
580+
@defgroup core_eig Eigenvalue routines
581+
@{
582+
@defgroup core_hegst hegst: Hermitian generalized to standard problem
583+
@}
584+
585+
@defgroup core_svd SVD routines
586+
@{
587+
@defgroup core_tbbrd_type1 tbbrd_type1: bulge-chasing, first diag tile
588+
@defgroup core_tbbrd_type2 tbbrd_type2: bulge-chasing, off-diag tile
589+
@defgroup core_tbbrd_type3 tbbrd_type3: bulge-chasing, diag tiles
520590
@}
521591
@}
522592

0 commit comments

Comments
 (0)