Fix function documentation (Reference-LAPACK PR747)

This commit is contained in:
Martin Kroeker 2022-11-20 22:46:58 +01:00 committed by GitHub
parent 31d2145988
commit e00f0fb26a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 41 additions and 41 deletions

View File

@ -1,4 +1,4 @@
*> \brief \b CLARSCL2 performs reciprocal diagonal scaling on a vector. *> \brief \b CLARSCL2 performs reciprocal diagonal scaling on a matrix.
* *
* =========== DOCUMENTATION =========== * =========== DOCUMENTATION ===========
* *
@ -34,7 +34,7 @@
*> *>
*> \verbatim *> \verbatim
*> *>
*> CLARSCL2 performs a reciprocal diagonal scaling on an vector: *> CLARSCL2 performs a reciprocal diagonal scaling on a matrix:
*> x <-- inv(D) * x *> x <-- inv(D) * x
*> where the REAL diagonal matrix D is stored as a vector. *> where the REAL diagonal matrix D is stored as a vector.
*> *>
@ -66,14 +66,14 @@
*> \param[in,out] X *> \param[in,out] X
*> \verbatim *> \verbatim
*> X is COMPLEX array, dimension (LDX,N) *> X is COMPLEX array, dimension (LDX,N)
*> On entry, the vector X to be scaled by D. *> On entry, the matrix X to be scaled by D.
*> On exit, the scaled vector. *> On exit, the scaled matrix.
*> \endverbatim *> \endverbatim
*> *>
*> \param[in] LDX *> \param[in] LDX
*> \verbatim *> \verbatim
*> LDX is INTEGER *> LDX is INTEGER
*> The leading dimension of the vector X. LDX >= M. *> The leading dimension of the matrix X. LDX >= M.
*> \endverbatim *> \endverbatim
* *
* Authors: * Authors:

View File

@ -1,4 +1,4 @@
*> \brief \b CLASCL2 performs diagonal scaling on a vector. *> \brief \b CLASCL2 performs diagonal scaling on a matrix.
* *
* =========== DOCUMENTATION =========== * =========== DOCUMENTATION ===========
* *
@ -34,9 +34,9 @@
*> *>
*> \verbatim *> \verbatim
*> *>
*> CLASCL2 performs a diagonal scaling on a vector: *> CLASCL2 performs a diagonal scaling on a matrix:
*> x <-- D * x *> x <-- D * x
*> where the diagonal REAL matrix D is stored as a vector. *> where the diagonal REAL matrix D is stored as a matrix.
*> *>
*> Eventually to be replaced by BLAS_cge_diag_scale in the new BLAS *> Eventually to be replaced by BLAS_cge_diag_scale in the new BLAS
*> standard. *> standard.
@ -66,14 +66,14 @@
*> \param[in,out] X *> \param[in,out] X
*> \verbatim *> \verbatim
*> X is COMPLEX array, dimension (LDX,N) *> X is COMPLEX array, dimension (LDX,N)
*> On entry, the vector X to be scaled by D. *> On entry, the matrix X to be scaled by D.
*> On exit, the scaled vector. *> On exit, the scaled matrix.
*> \endverbatim *> \endverbatim
*> *>
*> \param[in] LDX *> \param[in] LDX
*> \verbatim *> \verbatim
*> LDX is INTEGER *> LDX is INTEGER
*> The leading dimension of the vector X. LDX >= M. *> The leading dimension of the matrix X. LDX >= M.
*> \endverbatim *> \endverbatim
* *
* Authors: * Authors:

View File

@ -1,4 +1,4 @@
*> \brief \b DLARSCL2 performs reciprocal diagonal scaling on a vector. *> \brief \b DLARSCL2 performs reciprocal diagonal scaling on a matrix.
* *
* =========== DOCUMENTATION =========== * =========== DOCUMENTATION ===========
* *
@ -33,7 +33,7 @@
*> *>
*> \verbatim *> \verbatim
*> *>
*> DLARSCL2 performs a reciprocal diagonal scaling on an vector: *> DLARSCL2 performs a reciprocal diagonal scaling on a matrix:
*> x <-- inv(D) * x *> x <-- inv(D) * x
*> where the diagonal matrix D is stored as a vector. *> where the diagonal matrix D is stored as a vector.
*> *>
@ -65,14 +65,14 @@
*> \param[in,out] X *> \param[in,out] X
*> \verbatim *> \verbatim
*> X is DOUBLE PRECISION array, dimension (LDX,N) *> X is DOUBLE PRECISION array, dimension (LDX,N)
*> On entry, the vector X to be scaled by D. *> On entry, the matrix X to be scaled by D.
*> On exit, the scaled vector. *> On exit, the scaled matrix.
*> \endverbatim *> \endverbatim
*> *>
*> \param[in] LDX *> \param[in] LDX
*> \verbatim *> \verbatim
*> LDX is INTEGER *> LDX is INTEGER
*> The leading dimension of the vector X. LDX >= M. *> The leading dimension of the matrix X. LDX >= M.
*> \endverbatim *> \endverbatim
* *
* Authors: * Authors:

View File

@ -1,4 +1,4 @@
*> \brief \b DLASCL2 performs diagonal scaling on a vector. *> \brief \b DLASCL2 performs diagonal scaling on a matrix.
* *
* =========== DOCUMENTATION =========== * =========== DOCUMENTATION ===========
* *
@ -33,7 +33,7 @@
*> *>
*> \verbatim *> \verbatim
*> *>
*> DLASCL2 performs a diagonal scaling on a vector: *> DLASCL2 performs a diagonal scaling on a matrix:
*> x <-- D * x *> x <-- D * x
*> where the diagonal matrix D is stored as a vector. *> where the diagonal matrix D is stored as a vector.
*> *>
@ -65,14 +65,14 @@
*> \param[in,out] X *> \param[in,out] X
*> \verbatim *> \verbatim
*> X is DOUBLE PRECISION array, dimension (LDX,N) *> X is DOUBLE PRECISION array, dimension (LDX,N)
*> On entry, the vector X to be scaled by D. *> On entry, the matrix X to be scaled by D.
*> On exit, the scaled vector. *> On exit, the scaled matrix.
*> \endverbatim *> \endverbatim
*> *>
*> \param[in] LDX *> \param[in] LDX
*> \verbatim *> \verbatim
*> LDX is INTEGER *> LDX is INTEGER
*> The leading dimension of the vector X. LDX >= M. *> The leading dimension of the matrix X. LDX >= M.
*> \endverbatim *> \endverbatim
* *
* Authors: * Authors:

View File

@ -1,4 +1,4 @@
*> \brief \b SLARSCL2 performs reciprocal diagonal scaling on a vector. *> \brief \b SLARSCL2 performs reciprocal diagonal scaling on a matrix.
* *
* =========== DOCUMENTATION =========== * =========== DOCUMENTATION ===========
* *
@ -33,7 +33,7 @@
*> *>
*> \verbatim *> \verbatim
*> *>
*> SLARSCL2 performs a reciprocal diagonal scaling on an vector: *> SLARSCL2 performs a reciprocal diagonal scaling on a matrix:
*> x <-- inv(D) * x *> x <-- inv(D) * x
*> where the diagonal matrix D is stored as a vector. *> where the diagonal matrix D is stored as a vector.
*> *>
@ -65,14 +65,14 @@
*> \param[in,out] X *> \param[in,out] X
*> \verbatim *> \verbatim
*> X is REAL array, dimension (LDX,N) *> X is REAL array, dimension (LDX,N)
*> On entry, the vector X to be scaled by D. *> On entry, the matrix X to be scaled by D.
*> On exit, the scaled vector. *> On exit, the scaled matrix.
*> \endverbatim *> \endverbatim
*> *>
*> \param[in] LDX *> \param[in] LDX
*> \verbatim *> \verbatim
*> LDX is INTEGER *> LDX is INTEGER
*> The leading dimension of the vector X. LDX >= M. *> The leading dimension of the matrix X. LDX >= M.
*> \endverbatim *> \endverbatim
* *
* Authors: * Authors:

View File

@ -1,4 +1,4 @@
*> \brief \b SLASCL2 performs diagonal scaling on a vector. *> \brief \b SLASCL2 performs diagonal scaling on a matrix.
* *
* =========== DOCUMENTATION =========== * =========== DOCUMENTATION ===========
* *
@ -33,7 +33,7 @@
*> *>
*> \verbatim *> \verbatim
*> *>
*> SLASCL2 performs a diagonal scaling on a vector: *> SLASCL2 performs a diagonal scaling on a matrix:
*> x <-- D * x *> x <-- D * x
*> where the diagonal matrix D is stored as a vector. *> where the diagonal matrix D is stored as a vector.
*> *>
@ -65,14 +65,14 @@
*> \param[in,out] X *> \param[in,out] X
*> \verbatim *> \verbatim
*> X is REAL array, dimension (LDX,N) *> X is REAL array, dimension (LDX,N)
*> On entry, the vector X to be scaled by D. *> On entry, the matrix X to be scaled by D.
*> On exit, the scaled vector. *> On exit, the scaled matrix.
*> \endverbatim *> \endverbatim
*> *>
*> \param[in] LDX *> \param[in] LDX
*> \verbatim *> \verbatim
*> LDX is INTEGER *> LDX is INTEGER
*> The leading dimension of the vector X. LDX >= M. *> The leading dimension of the matrix X. LDX >= M.
*> \endverbatim *> \endverbatim
* *
* Authors: * Authors:

View File

@ -1,4 +1,4 @@
*> \brief \b ZLARSCL2 performs reciprocal diagonal scaling on a vector. *> \brief \b ZLARSCL2 performs reciprocal diagonal scaling on a matrix.
* *
* =========== DOCUMENTATION =========== * =========== DOCUMENTATION ===========
* *
@ -34,7 +34,7 @@
*> *>
*> \verbatim *> \verbatim
*> *>
*> ZLARSCL2 performs a reciprocal diagonal scaling on an vector: *> ZLARSCL2 performs a reciprocal diagonal scaling on a matrix:
*> x <-- inv(D) * x *> x <-- inv(D) * x
*> where the DOUBLE PRECISION diagonal matrix D is stored as a vector. *> where the DOUBLE PRECISION diagonal matrix D is stored as a vector.
*> *>
@ -66,14 +66,14 @@
*> \param[in,out] X *> \param[in,out] X
*> \verbatim *> \verbatim
*> X is COMPLEX*16 array, dimension (LDX,N) *> X is COMPLEX*16 array, dimension (LDX,N)
*> On entry, the vector X to be scaled by D. *> On entry, the matrix X to be scaled by D.
*> On exit, the scaled vector. *> On exit, the scaled matrix.
*> \endverbatim *> \endverbatim
*> *>
*> \param[in] LDX *> \param[in] LDX
*> \verbatim *> \verbatim
*> LDX is INTEGER *> LDX is INTEGER
*> The leading dimension of the vector X. LDX >= M. *> The leading dimension of the matrix X. LDX >= M.
*> \endverbatim *> \endverbatim
* *
* Authors: * Authors:

View File

@ -1,4 +1,4 @@
*> \brief \b ZLASCL2 performs diagonal scaling on a vector. *> \brief \b ZLASCL2 performs diagonal scaling on a matrix.
* *
* =========== DOCUMENTATION =========== * =========== DOCUMENTATION ===========
* *
@ -34,7 +34,7 @@
*> *>
*> \verbatim *> \verbatim
*> *>
*> ZLASCL2 performs a diagonal scaling on a vector: *> ZLASCL2 performs a diagonal scaling on a matrix:
*> x <-- D * x *> x <-- D * x
*> where the DOUBLE PRECISION diagonal matrix D is stored as a vector. *> where the DOUBLE PRECISION diagonal matrix D is stored as a vector.
*> *>
@ -66,14 +66,14 @@
*> \param[in,out] X *> \param[in,out] X
*> \verbatim *> \verbatim
*> X is COMPLEX*16 array, dimension (LDX,N) *> X is COMPLEX*16 array, dimension (LDX,N)
*> On entry, the vector X to be scaled by D. *> On entry, the matrix X to be scaled by D.
*> On exit, the scaled vector. *> On exit, the scaled matrix.
*> \endverbatim *> \endverbatim
*> *>
*> \param[in] LDX *> \param[in] LDX
*> \verbatim *> \verbatim
*> LDX is INTEGER *> LDX is INTEGER
*> The leading dimension of the vector X. LDX >= M. *> The leading dimension of the matrix X. LDX >= M.
*> \endverbatim *> \endverbatim
* *
* Authors: * Authors: