hiprandgenerate Interface Reference

hiprandgenerate Interface Reference#

HIPFORT API Reference: hipfort_hiprand::hiprandgenerate Interface Reference
Public Member Functions | List of all members
hipfort_hiprand::hiprandgenerate Interface Reference

Generates uniformly distributed 32-bit unsigned integers. More...

Public Member Functions

integer(kind(hiprand_status_success)) function hiprandgenerate_ (generator, output_data, n)
 
integer(kind(hiprand_status_success)) function hiprandgenerate_rank_0 (generator, output_data, n)
 
integer(kind(hiprand_status_success)) function hiprandgenerate_rank_1 (generator, output_data, n)
 

Detailed Description

Generates uniformly distributed 32-bit unsigned integers.

Generates n uniformly distributed 32-bit unsigned integers and saves them to output_data.

Generated numbers are between 0 and 2^32, including 0 and excluding 2^32.

Parameters
generator- Generator to use
output_data- Pointer to memory to store generated numbers
n- Number of 32-bit unsigned integers to generate

Note: generator must be not be of type HIPRAND_RNG_QUASI_SOBOL64 or HIPRAND_RNG_QUASI_SCRAMBLED_SOBOL64.

Returns
  • HIPRAND_STATUS_NOT_INITIALIZED if the generator was not initialized
  • HIPRAND_STATUS_LAUNCH_FAILURE if generator failed to launch kernel
  • HIPRAND_STATUS_SUCCESS if random numbers were successfully generated

Member Function/Subroutine Documentation

◆ hiprandgenerate_()

integer(kind(hiprand_status_success)) function hipfort_hiprand::hiprandgenerate::hiprandgenerate_ ( type(c_ptr), value  generator,
type(c_ptr), value  output_data,
integer(c_size_t), value  n 
)

◆ hiprandgenerate_rank_0()

integer(kind(hiprand_status_success)) function hipfort_hiprand::hiprandgenerate::hiprandgenerate_rank_0 ( type(c_ptr)  generator,
integer(c_int), target  output_data,
integer(c_size_t)  n 
)

◆ hiprandgenerate_rank_1()

integer(kind(hiprand_status_success)) function hipfort_hiprand::hiprandgenerate::hiprandgenerate_rank_1 ( type(c_ptr)  generator,
integer(c_int), dimension(:), target  output_data,
integer(c_size_t)  n 
)
The documentation for this interface was generated from the following file: