summaryrefslogtreecommitdiff
path: root/SRC/zlarnv.f
diff options
context:
space:
mode:
authorjulie <julielangou@users.noreply.github.com>2011-10-06 06:53:11 +0000
committerjulie <julielangou@users.noreply.github.com>2011-10-06 06:53:11 +0000
commite1d39294aee16fa6db9ba079b14442358217db71 (patch)
tree30e5aa04c1f6596991fda5334f63dfb9b8027849 /SRC/zlarnv.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
downloadlapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz
lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2
lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip
Integrating Doxygen in comments
Diffstat (limited to 'SRC/zlarnv.f')
-rw-r--r--SRC/zlarnv.f130
1 files changed, 93 insertions, 37 deletions
diff --git a/SRC/zlarnv.f b/SRC/zlarnv.f
index 2e14f4a9..2a3c6ad4 100644
--- a/SRC/zlarnv.f
+++ b/SRC/zlarnv.f
@@ -1,54 +1,110 @@
- SUBROUTINE ZLARNV( IDIST, ISEED, N, X )
-*
-* -- 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
-*
-* .. Scalar Arguments ..
- INTEGER IDIST, N
-* ..
-* .. Array Arguments ..
- INTEGER ISEED( 4 )
- COMPLEX*16 X( * )
-* ..
-*
+*> \brief \b ZLARNV
+*
+* =========== DOCUMENTATION ===========
+*
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
+*
+* SUBROUTINE ZLARNV( IDIST, ISEED, N, X )
+*
+* .. Scalar Arguments ..
+* INTEGER IDIST, N
+* ..
+* .. Array Arguments ..
+* INTEGER ISEED( 4 )
+* COMPLEX*16 X( * )
+* ..
+*
* Purpose
* =======
*
-* ZLARNV returns a vector of n random complex numbers from a uniform or
-* normal distribution.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> ZLARNV returns a vector of n random complex numbers from a uniform or
+*> normal distribution.
+*>
+*>\endverbatim
*
* Arguments
* =========
*
-* IDIST (input) INTEGER
-* Specifies the distribution of the random numbers:
-* = 1: real and imaginary parts each uniform (0,1)
-* = 2: real and imaginary parts each uniform (-1,1)
-* = 3: real and imaginary parts each normal (0,1)
-* = 4: uniformly distributed on the disc abs(z) < 1
-* = 5: uniformly distributed on the circle abs(z) = 1
+*> \param[in] IDIST
+*> \verbatim
+*> IDIST is INTEGER
+*> Specifies the distribution of the random numbers:
+*> = 1: real and imaginary parts each uniform (0,1)
+*> = 2: real and imaginary parts each uniform (-1,1)
+*> = 3: real and imaginary parts each normal (0,1)
+*> = 4: uniformly distributed on the disc abs(z) < 1
+*> = 5: uniformly distributed on the circle abs(z) = 1
+*> \endverbatim
+*>
+*> \param[in,out] ISEED
+*> \verbatim
+*> ISEED is INTEGER array, dimension (4)
+*> On entry, the seed of the random number generator; the array
+*> elements must be between 0 and 4095, and ISEED(4) must be
+*> odd.
+*> On exit, the seed is updated.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*> N is INTEGER
+*> The number of random numbers to be generated.
+*> \endverbatim
+*>
+*> \param[out] X
+*> \verbatim
+*> X is COMPLEX*16 array, dimension (N)
+*> The generated random numbers.
+*> \endverbatim
+*>
+*
+* Authors
+* =======
*
-* ISEED (input/output) INTEGER array, dimension (4)
-* On entry, the seed of the random number generator; the array
-* elements must be between 0 and 4095, and ISEED(4) must be
-* odd.
-* On exit, the seed is updated.
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
*
-* N (input) INTEGER
-* The number of random numbers to be generated.
+*> \date November 2011
+*
+*> \ingroup complex16OTHERauxiliary
*
-* X (output) COMPLEX*16 array, dimension (N)
-* The generated random numbers.
*
* Further Details
* ===============
+*>\details \b Further \b Details
+*> \verbatim
+*>
+*> This routine calls the auxiliary routine DLARUV to generate random
+*> real numbers from a uniform (0,1) distribution, in batches of up to
+*> 128 using vectorisable code. The Box-Muller method is used to
+*> transform numbers from a uniform to a normal distribution.
+*>
+*> \endverbatim
+*>
+* =====================================================================
+ SUBROUTINE ZLARNV( IDIST, ISEED, N, X )
+*
+* -- 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
*
-* This routine calls the auxiliary routine DLARUV to generate random
-* real numbers from a uniform (0,1) distribution, in batches of up to
-* 128 using vectorisable code. The Box-Muller method is used to
-* transform numbers from a uniform to a normal distribution.
+* .. Scalar Arguments ..
+ INTEGER IDIST, N
+* ..
+* .. Array Arguments ..
+ INTEGER ISEED( 4 )
+ COMPLEX*16 X( * )
+* ..
*
* =====================================================================
*