hiprandgeneratepoisson Interface Reference

hiprandgeneratepoisson Interface Reference#

HIPFORT API Reference: hipfort_hiprand::hiprandgeneratepoisson Interface Reference
hipfort_hiprand::hiprandgeneratepoisson Interface Reference

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

Public Member Functions

integer(kind(hiprand_status_success)) function hiprandgeneratepoisson_ (generator, output_data, n, lambda)

Detailed Description

Generates Poisson-distributed 32-bit unsigned integers.

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

generator- Generator to use
output_data- Pointer to memory to store generated numbers
n- Number of 32-bit unsigned integers to generate
lambda- lambda for the Poisson distribution
  • HIPRAND_STATUS_NOT_INITIALIZED if the generator was not initialized
  • HIPRAND_STATUS_LAUNCH_FAILURE if generator failed to launch kernel
  • HIPRAND_STATUS_OUT_OF_RANGE if lambda is non-positive
  • HIPRAND_STATUS_LENGTH_NOT_MULTIPLE if n is not a multiple of the dimension of used quasi-random generator
  • HIPRAND_STATUS_SUCCESS if random numbers were successfully generated

Member Function/Subroutine Documentation

◆ hiprandgeneratepoisson_()

integer(kind(hiprand_status_success)) function hipfort_hiprand::hiprandgeneratepoisson::hiprandgeneratepoisson_ ( type(c_ptr), value  generator,
type(c_ptr), value  output_data,
integer(c_size_t), value  n,
real(c_double), value  lambda 

The documentation for this interface was generated from the following file: