Generates Cauchy distributed random values.
Syntax
FORTRAN:
status = vsrngcauchy( method, stream, n, r, a, beta )
status = vdrngcauchy( method, stream, n, r, a, beta )
C:
status = vsRngCauchy( method, stream, n, r, a, beta );
status = vdRngCauchy( method, stream, n, r, a, beta );
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: Inverse cumulative distribution function method |
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 |
a |
FORTRAN 77: REAL for vsrngcauchy DOUBLE PRECISION for vdrngcauchy Fortran 90: REAL(KIND=4), INTENT(IN) for vsrngcauchy REAL(KIND=8), INTENT(IN) for vdrngcauchy C: const float for vsRngCauchy const double for vdRngCauchy |
Displacement a. |
beta |
FORTRAN 77: REAL for vsrngcauchy DOUBLE PRECISION for vdrngcauchy Fortran 90: REAL(KIND=4), INTENT(IN) for vsrngcauchy REAL(KIND=8), INTENT(IN) for vdrngcauchy C: const float for vsRngCauchy const double for vdRngCauchy |
Scalefactor β. |
Output Parameters
Name |
Type |
Description |
|---|---|---|
r |
FORTRAN 77: REAL for vsrngcauchy DOUBLE PRECISION for vdrngcauchy Fortran 90: REAL(KIND=4), INTENT(OUT) for vsrngcauchy REAL(KIND=8), INTENT(OUT) for vdrngcauchy C: float* for vsRngCauchy double* for vdRngCauchy |
Vector of n Cauchy distributed random numbers |
Description
The function generates Cauchy distributed random numbers with displacement a and scalefactor β, where a, β∈R ; β > 0.
The probability density function is given by:
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.