Developer Reference for Intel® oneAPI Math Kernel Library for C
vRngWeibull
Generates Weibull distributed random numbers.
Syntax
status = vsRngWeibull ( method , stream , n , r , alpha , a , beta );
status = vdRngWeibull ( method , stream , n , r , alpha , a , beta );
Include Files
mkl.h
Input Parameters
Name |
Type |
Description |
|---|---|---|
method |
const MKL_INT |
Generation method. The specific values are as follows: VSL_RNG_METHOD_WEIBULL_ICDF VSL_RNG_METHOD_WEIBULL_ICDF_ACCURATE Inverse cumulative distribution function method |
stream |
VSLStreamStatePtr |
Pointer to the stream state structure |
n |
const MKL_INT |
Number of random values to be generated |
alpha |
const float for vsRngWeibull const double for vdRngWeibull |
Shape α . |
a |
const float for vsRngWeibull const double for vdRngWeibull |
Displacement a |
beta |
const float for vsRngWeibull const double for vdRngWeibull |
Scalefactor \(\beta\) . |
Output Parameters
Name |
Type |
Description |
|---|---|---|
r |
float* for vsRngWeibull double* for vdRngWeibull |
Vector of n Weibull distributed random numbers |
Description
vsRngWeibull vdRngWeibull The vRngWeibull function generates Weibull distributed random numbers with displacement a , scalefactor \(\beta\) , and shape \(\alpha\) , where \(\alpha, \beta, a \in R ; \alpha > 0, \beta > 0\) .
The probability density function is given by:
The cumulative distribution function is as follows:
Product and Performance Information Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex . Notice revision #20201201
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.
- VSL_RNG_ERROR_NONDETERM_NRETRIES_EXCEEDED
-
Number of retries to generate a random number by using non-deterministic random number generator exceeds threshold.
- VSL_RNG_ERROR_ARS5_NOT_SUPPORTED
-
ARS-5 random number generator is not supported on the CPU running the application.