hiprandsetgeneratorordering Interface Reference

hiprandsetgeneratorordering Interface Reference#

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

Sets the ordering of a random number generator. More...

Public Member Functions

integer(kind(hiprand_status_success)) function hiprandsetgeneratorordering_ (generator, order)
 

Detailed Description

Sets the ordering of a random number generator.

Sets the ordering of the results of a random number generator.

  • This operation resets the generator's internal state.
  • This operation does not change the generator's seed.
Parameters
generator- Random number generator
order- New ordering of results

The ordering choices for pseudorandom sequences are HIPRAND_ORDERING_PSEUDO_DEFAULT and HIPRAND_ORDERING_PSEUDO_LEGACY. The default ordering is HIPRAND_ORDERING_PSEUDO_DEFAULT, which is equal to HIPRAND_ORDERING_PSEUDO_LEGACY for now.

For quasirandom sequences there is only one ordering, HIPRAND_ORDERING_QUASI_DEFAULT.

Returns
  • HIPRAND_STATUS_NOT_INITIALIZED if the generator was not initialized
  • HIPRAND_STATUS_OUT_OF_RANGE if the ordering is not valid
  • HIPRAND_STATUS_SUCCESS if the ordering was successfully set
  • HIPRAND_STATUS_TYPE_ERROR if generator's type is not valid

Member Function/Subroutine Documentation

◆ hiprandsetgeneratorordering_()

integer(kind(hiprand_status_success)) function hipfort_hiprand::hiprandsetgeneratorordering::hiprandsetgeneratorordering_ ( type(c_ptr), value  generator,
integer(kind(hiprand_ordering_pseudo_best)), value  order 
)
The documentation for this interface was generated from the following file: