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/clarnv.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/clarnv.f')
-rw-r--r-- | SRC/clarnv.f | 130 |
1 files changed, 93 insertions, 37 deletions
diff --git a/SRC/clarnv.f b/SRC/clarnv.f index eb89ca05..7b571790 100644 --- a/SRC/clarnv.f +++ b/SRC/clarnv.f @@ -1,54 +1,110 @@ - SUBROUTINE CLARNV( 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 X( * ) -* .. -* +*> \brief \b CLARNV +* +* =========== DOCUMENTATION =========== +* +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ +* +* Definition +* ========== +* +* SUBROUTINE CLARNV( IDIST, ISEED, N, X ) +* +* .. Scalar Arguments .. +* INTEGER IDIST, N +* .. +* .. Array Arguments .. +* INTEGER ISEED( 4 ) +* COMPLEX X( * ) +* .. +* * Purpose * ======= * -* CLARNV returns a vector of n random complex numbers from a uniform or -* normal distribution. +*>\details \b Purpose: +*>\verbatim +*> +*> CLARNV 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 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 complexOTHERauxiliary * -* X (output) COMPLEX array, dimension (N) -* The generated random numbers. * * Further Details * =============== +*>\details \b Further \b Details +*> \verbatim +*> +*> This routine calls the auxiliary routine SLARUV 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 CLARNV( 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 SLARUV 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 X( * ) +* .. * * ===================================================================== * |