Fix *2st_kernels.f: unify doc comments
authoreugene.chereshnev <eugenechereshnev@gmail.com>
Fri, 24 Mar 2017 20:28:23 +0000 (13:28 -0700)
committereugene.chereshnev <eugenechereshnev@gmail.com>
Fri, 24 Mar 2017 23:57:28 +0000 (16:57 -0700)
SRC/chb2st_kernels.f
SRC/dsb2st_kernels.f
SRC/ssb2st_kernels.f
SRC/zhb2st_kernels.f

index 77ddaed..fef90ad 100644 (file)
 *  Arguments:
 *  ==========
 *
-*> @param[in] n
-*>          The order of the matrix A.
-*>
-*> @param[in] nb
-*>          The size of the band.
-*>
-*> @param[in, out] A
-*>          A pointer to the matrix A.
-*>
-*> @param[in] lda
-*>          The leading dimension of the matrix A.
+*> \param[in] UPLO
+*> \verbatim
+*>          UPLO is CHARACTER*1
+*> \endverbatim
 *>
-*> @param[out] V
-*>          COMPLEX array, dimension 2*n if eigenvalues only are
-*>          requested or to be queried for vectors.
+*> \param[in] WANTZ
+*> \verbatim
+*>          WANTZ is LOGICAL which indicate if Eigenvalue are requested or both
+*>          Eigenvalue/Eigenvectors.
+*> \endverbatim
 *>
-*> @param[out] TAU
-*>          COMPLEX array, dimension (2*n).
-*>          The scalar factors of the Householder reflectors are stored
-*>          in this array.
+*> \param[in] TTYPE
+*> \verbatim
+*>          TTYPE is INTEGER
+*> \endverbatim
 *>
-*> @param[in] st
+*> \param[in] ST
+*> \verbatim
+*>          ST is INTEGER
 *>          internal parameter for indices.
+*> \endverbatim
 *>
-*> @param[in] ed
+*> \param[in] ED
+*> \verbatim
+*>          ED is INTEGER
 *>          internal parameter for indices.
+*> \endverbatim
 *>
-*> @param[in] sweep
+*> \param[in] SWEEP
+*> \verbatim
+*>          SWEEP is INTEGER
 *>          internal parameter for indices.
+*> \endverbatim
 *>
-*> @param[in] Vblksiz
-*>          internal parameter for indices.
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER. The order of the matrix A.
+*> \endverbatim
 *>
-*> @param[in] wantz
-*>          logical which indicate if Eigenvalue are requested or both
-*>          Eigenvalue/Eigenvectors.
+*> \param[in] NB
+*> \verbatim
+*>          NB is INTEGER. The size of the band.
+*> \endverbatim
+*>
+*> \param[in] IB
+*> \verbatim
+*>          IB is INTEGER.
+*> \endverbatim
+*>
+*> \param[in, out] A
+*> \verbatim
+*>          A is COMPLEX array. A pointer to the matrix A.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*>          LDA is INTEGER. The leading dimension of the matrix A.
+*> \endverbatim
+*>
+*> \param[out] V
+*> \verbatim
+*>          V is COMPLEX array, dimension 2*n if eigenvalues only are
+*>          requested or to be queried for vectors.
+*> \endverbatim
+*>
+*> \param[out] TAU
+*> \verbatim
+*>          TAU is COMPLEX array, dimension (2*n).
+*>          The scalar factors of the Householder reflectors are stored
+*>          in this array.
+*> \endverbatim
+*>
+*> \param[in] LDVT
+*> \verbatim
+*>          LDVT is INTEGER.
+*> \endverbatim
 *>
-*> @param[in] work
-*>          Workspace of size nb.
+*> \param[in] WORK
+*> \verbatim
+*>          WORK is COMPLEX array. Workspace of size nb.
+*> \endverbatim
 *>
 *> \par Further Details:
 *  =====================
index afed526..988ffc8 100644 (file)
 *  Arguments:
 *  ==========
 *
-*> @param[in] n
-*>          The order of the matrix A.
-*>
-*> @param[in] nb
-*>          The size of the band.
-*>
-*> @param[in, out] A
-*>          A pointer to the matrix A.
-*>
-*> @param[in] lda
-*>          The leading dimension of the matrix A.
+*> \param[in] UPLO
+*> \verbatim
+*>          UPLO is CHARACTER*1
+*> \endverbatim
 *>
-*> @param[out] V
-*>          DOUBLE PRECISION array, dimension 2*n if eigenvalues only are
-*>          requested or to be queried for vectors.
+*> \param[in] WANTZ
+*> \verbatim
+*>          WANTZ is LOGICAL which indicate if Eigenvalue are requested or both
+*>          Eigenvalue/Eigenvectors.
+*> \endverbatim
 *>
-*> @param[out] TAU
-*>          DOUBLE PRECISION array, dimension (2*n).
-*>          The scalar factors of the Householder reflectors are stored
-*>          in this array.
+*> \param[in] TTYPE
+*> \verbatim
+*>          TTYPE is INTEGER
+*> \endverbatim
 *>
-*> @param[in] st
+*> \param[in] ST
+*> \verbatim
+*>          ST is INTEGER
 *>          internal parameter for indices.
+*> \endverbatim
 *>
-*> @param[in] ed
+*> \param[in] ED
+*> \verbatim
+*>          ED is INTEGER
 *>          internal parameter for indices.
+*> \endverbatim
 *>
-*> @param[in] sweep
+*> \param[in] SWEEP
+*> \verbatim
+*>          SWEEP is INTEGER
 *>          internal parameter for indices.
+*> \endverbatim
 *>
-*> @param[in] Vblksiz
-*>          internal parameter for indices.
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER. The order of the matrix A.
+*> \endverbatim
 *>
-*> @param[in] wantz
-*>          logical which indicate if Eigenvalue are requested or both
-*>          Eigenvalue/Eigenvectors.
+*> \param[in] NB
+*> \verbatim
+*>          NB is INTEGER. The size of the band.
+*> \endverbatim
+*>
+*> \param[in] IB
+*> \verbatim
+*>          IB is INTEGER.
+*> \endverbatim
+*>
+*> \param[in, out] A
+*> \verbatim
+*>          A is DOUBLE PRECISION array. A pointer to the matrix A.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*>          LDA is INTEGER. The leading dimension of the matrix A.
+*> \endverbatim
+*>
+*> \param[out] V
+*> \verbatim
+*>          V is DOUBLE PRECISION array, dimension 2*n if eigenvalues only are
+*>          requested or to be queried for vectors.
+*> \endverbatim
+*>
+*> \param[out] TAU
+*> \verbatim
+*>          TAU is DOUBLE PRECISION array, dimension (2*n).
+*>          The scalar factors of the Householder reflectors are stored
+*>          in this array.
+*> \endverbatim
+*>
+*> \param[in] LDVT
+*> \verbatim
+*>          LDVT is INTEGER.
+*> \endverbatim
 *>
-*> @param[in] work
-*>          Workspace of size nb.
+*> \param[in] WORK
+*> \verbatim
+*>          WORK is DOUBLE PRECISION array. Workspace of size nb.
+*> \endverbatim
 *>
 *> \par Further Details:
 *  =====================
index 7183c9a..4d046d8 100644 (file)
 *  Arguments:
 *  ==========
 *
-*> @param[in] n
-*>          The order of the matrix A.
-*>
-*> @param[in] nb
-*>          The size of the band.
-*>
-*> @param[in, out] A
-*>          A pointer to the matrix A.
-*>
-*> @param[in] lda
-*>          The leading dimension of the matrix A.
+*> \param[in] UPLO
+*> \verbatim
+*>          UPLO is CHARACTER*1
+*> \endverbatim
 *>
-*> @param[out] V
-*>          REAL array, dimension 2*n if eigenvalues only are
-*>          requested or to be queried for vectors.
+*> \param[in] WANTZ
+*> \verbatim
+*>          WANTZ is LOGICAL which indicate if Eigenvalue are requested or both
+*>          Eigenvalue/Eigenvectors.
+*> \endverbatim
 *>
-*> @param[out] TAU
-*>          REAL array, dimension (2*n).
-*>          The scalar factors of the Householder reflectors are stored
-*>          in this array.
+*> \param[in] TTYPE
+*> \verbatim
+*>          TTYPE is INTEGER
+*> \endverbatim
 *>
-*> @param[in] st
+*> \param[in] ST
+*> \verbatim
+*>          ST is INTEGER
 *>          internal parameter for indices.
+*> \endverbatim
 *>
-*> @param[in] ed
+*> \param[in] ED
+*> \verbatim
+*>          ED is INTEGER
 *>          internal parameter for indices.
+*> \endverbatim
 *>
-*> @param[in] sweep
+*> \param[in] SWEEP
+*> \verbatim
+*>          SWEEP is INTEGER
 *>          internal parameter for indices.
+*> \endverbatim
 *>
-*> @param[in] Vblksiz
-*>          internal parameter for indices.
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER. The order of the matrix A.
+*> \endverbatim
 *>
-*> @param[in] wantz
-*>          logical which indicate if Eigenvalue are requested or both
-*>          Eigenvalue/Eigenvectors.
+*> \param[in] NB
+*> \verbatim
+*>          NB is INTEGER. The size of the band.
+*> \endverbatim
+*>
+*> \param[in] IB
+*> \verbatim
+*>          IB is INTEGER.
+*> \endverbatim
+*>
+*> \param[in, out] A
+*> \verbatim
+*>          A is REAL array. A pointer to the matrix A.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*>          LDA is INTEGER. The leading dimension of the matrix A.
+*> \endverbatim
+*>
+*> \param[out] V
+*> \verbatim
+*>          V is REAL array, dimension 2*n if eigenvalues only are
+*>          requested or to be queried for vectors.
+*> \endverbatim
+*>
+*> \param[out] TAU
+*> \verbatim
+*>          TAU is REAL array, dimension (2*n).
+*>          The scalar factors of the Householder reflectors are stored
+*>          in this array.
+*> \endverbatim
+*>
+*> \param[in] LDVT
+*> \verbatim
+*>          LDVT is INTEGER.
+*> \endverbatim
+*>
+*> \param[in] WORK
+*> \verbatim
+*>          WORK is REAL array. Workspace of size nb.
+*> \endverbatim
+*> @param[in] n
+*>          The order of the matrix A.
 *>
-*> @param[in] work
-*>          Workspace of size nb.
 *>
 *> \par Further Details:
 *  =====================
index e4114b5..862eb9d 100644 (file)
 *  Arguments:
 *  ==========
 *
-*> @param[in] n
-*>          The order of the matrix A.
-*>
-*> @param[in] nb
-*>          The size of the band.
-*>
-*> @param[in, out] A
-*>          A pointer to the matrix A.
-*>
-*> @param[in] lda
-*>          The leading dimension of the matrix A.
+*> \param[in] UPLO
+*> \verbatim
+*>          UPLO is CHARACTER*1
+*> \endverbatim
 *>
-*> @param[out] V
-*>          COMPLEX*16 array, dimension 2*n if eigenvalues only are
-*>          requested or to be queried for vectors.
+*> \param[in] WANTZ
+*> \verbatim
+*>          WANTZ is LOGICAL which indicate if Eigenvalue are requested or both
+*>          Eigenvalue/Eigenvectors.
+*> \endverbatim
 *>
-*> @param[out] TAU
-*>          COMPLEX*16 array, dimension (2*n).
-*>          The scalar factors of the Householder reflectors are stored
-*>          in this array.
+*> \param[in] TTYPE
+*> \verbatim
+*>          TTYPE is INTEGER
+*> \endverbatim
 *>
-*> @param[in] st
+*> \param[in] ST
+*> \verbatim
+*>          ST is INTEGER
 *>          internal parameter for indices.
+*> \endverbatim
 *>
-*> @param[in] ed
+*> \param[in] ED
+*> \verbatim
+*>          ED is INTEGER
 *>          internal parameter for indices.
+*> \endverbatim
 *>
-*> @param[in] sweep
+*> \param[in] SWEEP
+*> \verbatim
+*>          SWEEP is INTEGER
 *>          internal parameter for indices.
+*> \endverbatim
 *>
-*> @param[in] Vblksiz
-*>          internal parameter for indices.
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER. The order of the matrix A.
+*> \endverbatim
 *>
-*> @param[in] wantz
-*>          logical which indicate if Eigenvalue are requested or both
-*>          Eigenvalue/Eigenvectors.
+*> \param[in] NB
+*> \verbatim
+*>          NB is INTEGER. The size of the band.
+*> \endverbatim
+*>
+*> \param[in] IB
+*> \verbatim
+*>          IB is INTEGER.
+*> \endverbatim
+*>
+*> \param[in, out] A
+*> \verbatim
+*>          A is COMPLEX*16 array. A pointer to the matrix A.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*>          LDA is INTEGER. The leading dimension of the matrix A.
+*> \endverbatim
+*>
+*> \param[out] V
+*> \verbatim
+*>          V is COMPLEX*16 array, dimension 2*n if eigenvalues only are
+*>          requested or to be queried for vectors.
+*> \endverbatim
+*>
+*> \param[out] TAU
+*> \verbatim
+*>          TAU is COMPLEX*16 array, dimension (2*n).
+*>          The scalar factors of the Householder reflectors are stored
+*>          in this array.
+*> \endverbatim
+*>
+*> \param[in] LDVT
+*> \verbatim
+*>          LDVT is INTEGER.
+*> \endverbatim
 *>
-*> @param[in] work
-*>          Workspace of size nb.
+*> \param[in] WORK
+*> \verbatim
+*>          WORK is COMPLEX*16 array. Workspace of size nb.
+*> \endverbatim
 *>
 *> \par Further Details:
 *  =====================