Generates gamma distributed random values.
Syntax
Fortran:
status = vsrnggamma( method, stream, n, r, alpha, a, beta )
status = vdrnggamma( method, stream, n, r, alpha, a, beta )
C:
status = vsRngGamma( method, stream, n, r, alpha, a, beta );
status = vdRngGamma( method, stream, n, r, alpha, a, beta );
Include Files
The FORTRAN 77 interfaces are specified in the mkl_vsl.f77 include file, the Fortran 90 interfaces are specified in the mkl_vsl.f90 include file, and the C interfaces are specified in the mkl_vsl_functions.h include file.
Input Parameters
Name |
Type |
Description |
|---|---|---|
method |
FORTRAN 77: INTEGER Fortran 90: INTEGER, INTENT(IN) C: const int |
Generation method. The specific values are as follows: Acceptance/rejection method using random numbers with Gaussian distribution. See brief description of the method GNORM in Table"Values of <method> in method parameter" |
stream |
FORTRAN 77: INTEGER*4 stream(2) Fortran 90: TYPE (VSL_STREAM_STATE), INTENT(IN) C: VSLStreamStatePtr |
Fortran: Descriptor of the stream state structure C: Pointer to the stream state structure |
n |
FORTRAN 77: INTEGER Fortran 90: INTEGER, INTENT(IN) C: const int |
Number of random values to be generated |
alpha |
FORTRAN 77: REAL for vsrnggamma DOUBLE PRECISION for vdrnggamma Fortran 90: REAL, INTENT(IN) for vsrnggamma DOUBLE PRECISION, INTENT(IN) for vdrnggamma C: const float for vsRngGamma const double for vdRngGamma |
Shape α. |
a |
FORTRAN 77: REAL for vsrnggamma DOUBLE PRECISION for vdrnggamma Fortran 90: REAL, INTENT(IN) for vsrnggamma DOUBLE PRECISION, INTENT(IN) for vdrnggamma C: const float for vsRngGamma const double for vdRngGamma |
Displacement a. |
beta |
FORTRAN 77: REAL for vsrnggamma DOUBLE PRECISION for vdrnggamma Fortran 90: REAL, INTENT(IN) for vsrnggamma DOUBLE PRECISION, INTENT(IN) for vdrnggamma C: const float for vsRngGamma const double for vdRngGamma |
Scalefactor β. |
Output Parameters
Name |
Type |
Description |
|---|---|---|
r |
FORTRAN 77: REAL for vsrnggamma DOUBLE PRECISION for vdrnggamma Fortran 90: REAL, INTENT(OUT) for vsrnggamma DOUBLE PRECISION, INTENT(OUT) for vdrnggamma C: float* for vsRngGamma double* for vdRngGamma |
Vector of n random numbers with gamma distribution |
Description
The Gamma function generates random numbers with gamma distribution that has shape parameter α, displacement a, and scale parameter β, where α, β, and a∈R ; α > 0, β > 0.
The probability density function is given by:
where Γ(α) is the complete gamma function.
The cumulative distribution function is as follows:
Return Values
- VSL_ERROR_OK, VSL_STATUS_OK
Indicates no error, execution is successful.
- VSL_ERROR_NULL_PTR
stream is a NULL pointer.
- VSL_RNG_ERROR_BAD_STREAM
stream is not a valid random stream.
- VSL_RNG_ERROR_BAD_UPDATE
Callback function for an abstract BRNG returns an invalid number of updated entries in a buffer, that is, < 0 or > nmax.
- VSL_RNG_ERROR_NO_NUMBERS
Callback function for an abstract BRNG returns 0 as the number of updated entries in a buffer.
- VSL_RNG_ERROR_QRNG_PERIOD_ELAPSED
Period of the generator has been exceeded.