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/scsum1.f | |
| parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
| download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip | |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/scsum1.f')
| -rw-r--r-- | SRC/scsum1.f | 95 |
1 files changed, 71 insertions, 24 deletions
diff --git a/SRC/scsum1.f b/SRC/scsum1.f index bc7207ac..a5c88ae3 100644 --- a/SRC/scsum1.f +++ b/SRC/scsum1.f @@ -1,39 +1,86 @@ - REAL FUNCTION SCSUM1( N, CX, INCX ) +*> \brief \b SCSUM1 * -* -- 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 +* =========== DOCUMENTATION =========== * -* .. Scalar Arguments .. - INTEGER INCX, N -* .. -* .. Array Arguments .. - COMPLEX CX( * ) -* .. +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ * +* Definition +* ========== +* +* REAL FUNCTION SCSUM1( N, CX, INCX ) +* +* .. Scalar Arguments .. +* INTEGER INCX, N +* .. +* .. Array Arguments .. +* COMPLEX CX( * ) +* .. +* * Purpose * ======= * -* SCSUM1 takes the sum of the absolute values of a complex -* vector and returns a single precision result. -* -* Based on SCASUM from the Level 1 BLAS. -* The change is to use the 'genuine' absolute value. -* -* Contributed by Nick Higham for use with CLACON. +*>\details \b Purpose: +*>\verbatim +*> +*> SCSUM1 takes the sum of the absolute values of a complex +*> vector and returns a single precision result. +*> +*> Based on SCASUM from the Level 1 BLAS. +*> The change is to use the 'genuine' absolute value. +*> +*> Contributed by Nick Higham for use with CLACON. +*> +*>\endverbatim * * Arguments * ========= * -* N (input) INTEGER -* The number of elements in the vector CX. +*> \param[in] N +*> \verbatim +*> N is INTEGER +*> The number of elements in the vector CX. +*> \endverbatim +*> +*> \param[in] CX +*> \verbatim +*> CX is COMPLEX array, dimension (N) +*> The vector whose elements will be summed. +*> \endverbatim +*> +*> \param[in] INCX +*> \verbatim +*> INCX is INTEGER +*> The spacing between successive values of CX. INCX > 0. +*> \endverbatim +*> +* +* Authors +* ======= +* +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. * -* CX (input) COMPLEX array, dimension (N) -* The vector whose elements will be summed. +*> \date November 2011 * -* INCX (input) INTEGER -* The spacing between successive values of CX. INCX > 0. +*> \ingroup complexOTHERauxiliary +* +* ===================================================================== + REAL FUNCTION SCSUM1( N, CX, 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 2011 +* +* .. Scalar Arguments .. + INTEGER INCX, N +* .. +* .. Array Arguments .. + COMPLEX CX( * ) +* .. * * ===================================================================== * |