diff options
author | julie <julielangou@users.noreply.github.com> | 2011-10-06 06:53:11 +0000 |
---|---|---|
committer | julie <julielangou@users.noreply.github.com> | 2011-10-06 06:53:11 +0000 |
commit | e1d39294aee16fa6db9ba079b14442358217db71 (patch) | |
tree | 30e5aa04c1f6596991fda5334f63dfb9b8027849 /SRC/slaeda.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/slaeda.f')
-rw-r--r-- | SRC/slaeda.f | 240 |
1 files changed, 164 insertions, 76 deletions
diff --git a/SRC/slaeda.f b/SRC/slaeda.f index 32041351..ca0ed247 100644 --- a/SRC/slaeda.f +++ b/SRC/slaeda.f @@ -1,94 +1,182 @@ - SUBROUTINE SLAEDA( N, TLVLS, CURLVL, CURPBM, PRMPTR, PERM, GIVPTR, - $ GIVCOL, GIVNUM, Q, QPTR, Z, ZTEMP, INFO ) -* -* -- LAPACK routine (version 3.2.2) -- -* -- LAPACK is a software package provided by Univ. of Tennessee, -- -* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..-- -* June 2010 -* -* .. Scalar Arguments .. - INTEGER CURLVL, CURPBM, INFO, N, TLVLS -* .. -* .. Array Arguments .. - INTEGER GIVCOL( 2, * ), GIVPTR( * ), PERM( * ), - $ PRMPTR( * ), QPTR( * ) - REAL GIVNUM( 2, * ), Q( * ), Z( * ), ZTEMP( * ) -* .. -* +*> \brief \b SLAEDA +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE SLAEDA( N, TLVLS, CURLVL, CURPBM, PRMPTR, PERM, GIVPTR, +* GIVCOL, GIVNUM, Q, QPTR, Z, ZTEMP, INFO ) +* +* .. Scalar Arguments .. +* INTEGER CURLVL, CURPBM, INFO, N, TLVLS +* .. +* .. Array Arguments .. +* INTEGER GIVCOL( 2, * ), GIVPTR( * ), PERM( * ), +* $ PRMPTR( * ), QPTR( * ) +* REAL GIVNUM( 2, * ), Q( * ), Z( * ), ZTEMP( * ) +* .. +* * Purpose * ======= * -* SLAEDA computes the Z vector corresponding to the merge step in the -* CURLVLth step of the merge process with TLVLS steps for the CURPBMth -* problem. +*>\details \b Purpose: +*>\verbatim +*> +*> SLAEDA computes the Z vector corresponding to the merge step in the +*> CURLVLth step of the merge process with TLVLS steps for the CURPBMth +*> problem. +*> +*>\endverbatim * * Arguments * ========= * -* N (input) INTEGER -* The dimension of the symmetric tridiagonal matrix. N >= 0. -* -* TLVLS (input) INTEGER -* The total number of merging levels in the overall divide and -* conquer tree. -* -* CURLVL (input) INTEGER -* The current level in the overall merge routine, -* 0 <= curlvl <= tlvls. -* -* CURPBM (input) INTEGER -* The current problem in the current level in the overall -* merge routine (counting from upper left to lower right). -* -* PRMPTR (input) INTEGER array, dimension (N lg N) -* Contains a list of pointers which indicate where in PERM a -* level's permutation is stored. PRMPTR(i+1) - PRMPTR(i) -* indicates the size of the permutation and incidentally the -* size of the full, non-deflated problem. -* -* PERM (input) INTEGER array, dimension (N lg N) -* Contains the permutations (from deflation and sorting) to be -* applied to each eigenblock. -* -* GIVPTR (input) INTEGER array, dimension (N lg N) -* Contains a list of pointers which indicate where in GIVCOL a -* level's Givens rotations are stored. GIVPTR(i+1) - GIVPTR(i) -* indicates the number of Givens rotations. -* -* GIVCOL (input) INTEGER array, dimension (2, N lg N) -* Each pair of numbers indicates a pair of columns to take place -* in a Givens rotation. -* -* GIVNUM (input) REAL array, dimension (2, N lg N) -* Each number indicates the S value to be used in the -* corresponding Givens rotation. -* -* Q (input) REAL array, dimension (N**2) -* Contains the square eigenblocks from previous levels, the -* starting positions for blocks are given by QPTR. +*> \param[in] N +*> \verbatim +*> N is INTEGER +*> The dimension of the symmetric tridiagonal matrix. N >= 0. +*> \endverbatim +*> +*> \param[in] TLVLS +*> \verbatim +*> TLVLS is INTEGER +*> The total number of merging levels in the overall divide and +*> conquer tree. +*> \endverbatim +*> +*> \param[in] CURLVL +*> \verbatim +*> CURLVL is INTEGER +*> The current level in the overall merge routine, +*> 0 <= curlvl <= tlvls. +*> \endverbatim +*> +*> \param[in] CURPBM +*> \verbatim +*> CURPBM is INTEGER +*> The current problem in the current level in the overall +*> merge routine (counting from upper left to lower right). +*> \endverbatim +*> +*> \param[in] PRMPTR +*> \verbatim +*> PRMPTR is INTEGER array, dimension (N lg N) +*> Contains a list of pointers which indicate where in PERM a +*> level's permutation is stored. PRMPTR(i+1) - PRMPTR(i) +*> indicates the size of the permutation and incidentally the +*> size of the full, non-deflated problem. +*> \endverbatim +*> +*> \param[in] PERM +*> \verbatim +*> PERM is INTEGER array, dimension (N lg N) +*> Contains the permutations (from deflation and sorting) to be +*> applied to each eigenblock. +*> \endverbatim +*> +*> \param[in] GIVPTR +*> \verbatim +*> GIVPTR is INTEGER array, dimension (N lg N) +*> Contains a list of pointers which indicate where in GIVCOL a +*> level's Givens rotations are stored. GIVPTR(i+1) - GIVPTR(i) +*> indicates the number of Givens rotations. +*> \endverbatim +*> +*> \param[in] GIVCOL +*> \verbatim +*> GIVCOL is INTEGER array, dimension (2, N lg N) +*> Each pair of numbers indicates a pair of columns to take place +*> in a Givens rotation. +*> \endverbatim +*> +*> \param[in] GIVNUM +*> \verbatim +*> GIVNUM is REAL array, dimension (2, N lg N) +*> Each number indicates the S value to be used in the +*> corresponding Givens rotation. +*> \endverbatim +*> +*> \param[in] Q +*> \verbatim +*> Q is REAL array, dimension (N**2) +*> Contains the square eigenblocks from previous levels, the +*> starting positions for blocks are given by QPTR. +*> \endverbatim +*> +*> \param[in] QPTR +*> \verbatim +*> QPTR is INTEGER array, dimension (N+2) +*> Contains a list of pointers which indicate where in Q an +*> eigenblock is stored. SQRT( QPTR(i+1) - QPTR(i) ) indicates +*> the size of the block. +*> \endverbatim +*> +*> \param[out] Z +*> \verbatim +*> Z is REAL array, dimension (N) +*> On output this vector contains the updating vector (the last +*> row of the first sub-eigenvector matrix and the first row of +*> the second sub-eigenvector matrix). +*> \endverbatim +*> +*> \param[out] ZTEMP +*> \verbatim +*> ZTEMP is REAL array, dimension (N) +*> \endverbatim +*> +*> \param[out] INFO +*> \verbatim +*> INFO is INTEGER +*> = 0: successful exit. +*> < 0: if INFO = -i, the i-th argument had an illegal value. +*> \endverbatim +*> +* +* Authors +* ======= * -* QPTR (input) INTEGER array, dimension (N+2) -* Contains a list of pointers which indicate where in Q an -* eigenblock is stored. SQRT( QPTR(i+1) - QPTR(i) ) indicates -* the size of the block. +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. * -* Z (output) REAL array, dimension (N) -* On output this vector contains the updating vector (the last -* row of the first sub-eigenvector matrix and the first row of -* the second sub-eigenvector matrix). +*> \date November 2011 * -* ZTEMP (workspace) REAL array, dimension (N) +*> \ingroup auxOTHERcomputational * -* INFO (output) INTEGER -* = 0: successful exit. -* < 0: if INFO = -i, the i-th argument had an illegal value. * * Further Details * =============== +*>\details \b Further \b Details +*> \verbatim +*> +*> Based on contributions by +*> Jeff Rutter, Computer Science Division, University of California +*> at Berkeley, USA +*> +*> \endverbatim +*> +* ===================================================================== + SUBROUTINE SLAEDA( N, TLVLS, CURLVL, CURPBM, PRMPTR, PERM, GIVPTR, + $ GIVCOL, GIVNUM, Q, QPTR, Z, ZTEMP, INFO ) * -* Based on contributions by -* Jeff Rutter, Computer Science Division, University of California -* at Berkeley, USA +* -- LAPACK computational routine (version 3.2.2) -- +* -- LAPACK is a software package provided by Univ. of Tennessee, -- +* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..-- +* November 2011 +* +* .. Scalar Arguments .. + INTEGER CURLVL, CURPBM, INFO, N, TLVLS +* .. +* .. Array Arguments .. + INTEGER GIVCOL( 2, * ), GIVPTR( * ), PERM( * ), + $ PRMPTR( * ), QPTR( * ) + REAL GIVNUM( 2, * ), Q( * ), Z( * ), ZTEMP( * ) +* .. * * ===================================================================== * |