hiprandsetgeneratoroffset Interface Reference

hiprandsetgeneratoroffset Interface Reference#

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

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

Public Member Functions

integer(kind(hiprand_status_success)) function hiprandsetgeneratoroffset_ (generator, offset)
 

Detailed Description

Sets the offset of a random number generator.

Sets the absolute offset of the random number generator.

  • This operation resets the generator's internal state.
  • This operation does not change the generator's seed.

Absolute offset cannot be set if generator's type is HIPRAND_RNG_PSEUDO_MTGP32 or HIPRAND_RNG_PSEUDO_MT19937.

Parameters
generator- Random number generator
offset- New absolute offset
Returns
  • HIPRAND_STATUS_NOT_INITIALIZED if the generator was not initialized
  • HIPRAND_STATUS_SUCCESS if offset was successfully set
  • HIPRAND_STATUS_TYPE_ERROR if generator's type is HIPRAND_RNG_PSEUDO_MTGP32 or HIPRAND_RNG_PSEUDO_MT19937

Member Function/Subroutine Documentation

◆ hiprandsetgeneratoroffset_()

integer(kind(hiprand_status_success)) function hipfort_hiprand::hiprandsetgeneratoroffset::hiprandsetgeneratoroffset_ ( type(c_ptr), value  generator,
integer(c_long_long), value  offset 
)
The documentation for this interface was generated from the following file: