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/srscl.f | |
| parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
| download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip | |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/srscl.f')
| -rw-r--r-- | SRC/srscl.f | 103 |
1 files changed, 77 insertions, 26 deletions
diff --git a/SRC/srscl.f b/SRC/srscl.f index 272a5614..c023ce3c 100644 --- a/SRC/srscl.f +++ b/SRC/srscl.f @@ -1,9 +1,85 @@ +*> \brief \b SRSCL +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE SRSCL( N, SA, SX, INCX ) +* +* .. Scalar Arguments .. +* INTEGER INCX, N +* REAL SA +* .. +* .. Array Arguments .. +* REAL SX( * ) +* .. +* +* Purpose +* ======= +* +*>\details \b Purpose: +*>\verbatim +*> +*> SRSCL multiplies an n-element real vector x by the real scalar 1/a. +*> This is done without overflow or underflow as long as +*> the final result x/a does not overflow or underflow. +*> +*>\endverbatim +* +* Arguments +* ========= +* +*> \param[in] N +*> \verbatim +*> N is INTEGER +*> The number of components of the vector x. +*> \endverbatim +*> +*> \param[in] SA +*> \verbatim +*> SA is REAL +*> The scalar a which is used to divide each component of x. +*> SA must be >= 0, or the subroutine will divide by zero. +*> \endverbatim +*> +*> \param[in,out] SX +*> \verbatim +*> SX is REAL array, dimension +*> (1+(N-1)*abs(INCX)) +*> The n-element vector x. +*> \endverbatim +*> +*> \param[in] INCX +*> \verbatim +*> INCX is INTEGER +*> The increment between successive values of the vector SX. +*> > 0: SX(1) = X(1) and SX(1+(i-1)*INCX) = x(i), 1< i<= n +*> \endverbatim +*> +* +* Authors +* ======= +* +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. +* +*> \date November 2011 +* +*> \ingroup realOTHERauxiliary +* +* ===================================================================== SUBROUTINE SRSCL( N, SA, SX, INCX ) * * -- LAPACK auxiliary routine (version 3.2) -- * -- LAPACK is a software package provided by Univ. of Tennessee, -- * -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..-- -* November 2006 +* November 2011 * * .. Scalar Arguments .. INTEGER INCX, N @@ -13,31 +89,6 @@ REAL SX( * ) * .. * -* Purpose -* ======= -* -* SRSCL multiplies an n-element real vector x by the real scalar 1/a. -* This is done without overflow or underflow as long as -* the final result x/a does not overflow or underflow. -* -* Arguments -* ========= -* -* N (input) INTEGER -* The number of components of the vector x. -* -* SA (input) REAL -* The scalar a which is used to divide each component of x. -* SA must be >= 0, or the subroutine will divide by zero. -* -* SX (input/output) REAL array, dimension -* (1+(N-1)*abs(INCX)) -* The n-element vector x. -* -* INCX (input) INTEGER -* The increment between successive values of the vector SX. -* > 0: SX(1) = X(1) and SX(1+(i-1)*INCX) = x(i), 1< i<= n -* * ===================================================================== * * .. Parameters .. |