rocrand_create_generator Interface Reference

rocrand_create_generator Interface Reference#

HIPFORT API Reference: hipfort_rocrand::rocrand_create_generator Interface Reference
Public Member Functions | List of all members
hipfort_rocrand::rocrand_create_generator Interface Reference

Creates a new random number generator. More...

Public Member Functions

integer(kind(rocrand_status_success)) function rocrand_create_generator_ (generator, rng_type)
 

Detailed Description

Creates a new random number generator.

Creates a new pseudo random number generator of type rng_type and returns it in generator.

Values for rng_type are:

  • ROCRAND_RNG_PSEUDO_XORWOW
  • ROCRAND_RNG_PSEUDO_MRG32K3A
  • ROCRAND_RNG_PSEUDO_MTGP32
  • ROCRAND_RNG_PSEUDO_PHILOX4_32_10
  • ROCRAND_RNG_QUASI_SOBOL32
Parameters
generator- Pointer to generator
rng_type- Type of generator to create
Returns
  • ROCRAND_STATUS_ALLOCATION_FAILED, if memory could not be allocated
  • ROCRAND_STATUS_VERSION_MISMATCH if the header file version does not match the dynamically linked library version
  • ROCRAND_STATUS_TYPE_ERROR if the value for rng_type is invalid
  • ROCRAND_STATUS_SUCCESS if generator was created successfully

Member Function/Subroutine Documentation

◆ rocrand_create_generator_()

integer(kind(rocrand_status_success)) function hipfort_rocrand::rocrand_create_generator::rocrand_create_generator_ ( type(c_ptr)  generator,
integer(kind(rocrand_rng_pseudo_default)), value  rng_type 
)
The documentation for this interface was generated from the following file: