/build/reproducible-path/rocrand-6.4.1/library/include/rocrand/rocrand.h Source File

/build/reproducible-path/rocrand-6.4.1/library/include/rocrand/rocrand.h Source File#

API library: /build/reproducible-path/rocrand-6.4.1/library/include/rocrand/rocrand.h Source File
rocrand.h
1// Copyright (c) 2017-2024 Advanced Micro Devices, Inc. All rights reserved.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19// THE SOFTWARE.
20
21#ifndef ROCRAND_H_
22#define ROCRAND_H_
23
29#include "rocrand/rocrand_discrete_types.h"
30
31#include <hip/hip_fp16.h>
32#include <hip/hip_runtime.h>
33#include <hip/hip_vector_types.h>
34
35#include "rocrand/rocrandapi.h"
36
37#include "rocrand/rocrand_version.h"
38
41typedef struct rocrand_generator_base_type * rocrand_generator;
43
46typedef __half half;
48
50#define ROCRAND_DEFAULT_MAX_BLOCK_SIZE 256
51
52#if defined(__cplusplus)
53extern "C" {
54#endif /* __cplusplus */
55
73
102
116
121{
122 ROCRAND_DIRECTION_VECTORS_32_JOEKUO6 = 101,
123 ROCRAND_SCRAMBLED_DIRECTION_VECTORS_32_JOEKUO6 = 102,
124 ROCRAND_DIRECTION_VECTORS_64_JOEKUO6 = 103,
125 ROCRAND_SCRAMBLED_DIRECTION_VECTORS_64_JOEKUO6 = 104,
127
128// Host API function
129
163rocrand_status ROCRANDAPI
164rocrand_create_generator(rocrand_generator * generator, rocrand_rng_type rng_type);
165
186rocrand_status ROCRANDAPI rocrand_create_generator_host(rocrand_generator* generator,
187 rocrand_rng_type rng_type);
188
194rocrand_status ROCRANDAPI rocrand_create_generator_host_blocking(rocrand_generator* generator,
195 rocrand_rng_type rng_type);
196
208rocrand_status ROCRANDAPI
209rocrand_destroy_generator(rocrand_generator generator);
210
231rocrand_status ROCRANDAPI
232rocrand_generate(rocrand_generator generator,
233 unsigned int * output_data, size_t n);
234
256rocrand_status ROCRANDAPI rocrand_generate_long_long(rocrand_generator generator,
257 unsigned long long int* output_data,
258 size_t n);
259
280rocrand_status ROCRANDAPI
281rocrand_generate_char(rocrand_generator generator,
282 unsigned char * output_data, size_t n);
283
304rocrand_status ROCRANDAPI
305rocrand_generate_short(rocrand_generator generator,
306 unsigned short * output_data, size_t n);
307
328rocrand_status ROCRANDAPI
329rocrand_generate_uniform(rocrand_generator generator,
330 float * output_data, size_t n);
331
352rocrand_status ROCRANDAPI
353rocrand_generate_uniform_double(rocrand_generator generator,
354 double * output_data, size_t n);
355
376rocrand_status ROCRANDAPI
377rocrand_generate_uniform_half(rocrand_generator generator,
378 half * output_data, size_t n);
379
399rocrand_status ROCRANDAPI
400rocrand_generate_normal(rocrand_generator generator,
401 float * output_data, size_t n,
402 float mean, float stddev);
403
423rocrand_status ROCRANDAPI
424rocrand_generate_normal_double(rocrand_generator generator,
425 double * output_data, size_t n,
426 double mean, double stddev);
427
447rocrand_status ROCRANDAPI
448rocrand_generate_normal_half(rocrand_generator generator,
449 half * output_data, size_t n,
450 half mean, half stddev);
451
471rocrand_status ROCRANDAPI
472rocrand_generate_log_normal(rocrand_generator generator,
473 float * output_data, size_t n,
474 float mean, float stddev);
475
495rocrand_status ROCRANDAPI
496rocrand_generate_log_normal_double(rocrand_generator generator,
497 double * output_data, size_t n,
498 double mean, double stddev);
499
519rocrand_status ROCRANDAPI
520rocrand_generate_log_normal_half(rocrand_generator generator,
521 half * output_data, size_t n,
522 half mean, half stddev);
523
543rocrand_status ROCRANDAPI
544rocrand_generate_poisson(rocrand_generator generator,
545 unsigned int * output_data, size_t n,
546 double lambda);
547
565rocrand_status ROCRANDAPI
566rocrand_initialize_generator(rocrand_generator generator);
567
581rocrand_status ROCRANDAPI
582rocrand_set_stream(rocrand_generator generator, hipStream_t stream);
583
609rocrand_status ROCRANDAPI
610rocrand_set_seed(rocrand_generator generator, unsigned long long seed);
611
634rocrand_status ROCRANDAPI rocrand_set_seed_uint4(rocrand_generator generator, uint4 seed);
635
656rocrand_status ROCRANDAPI
657rocrand_set_offset(rocrand_generator generator, unsigned long long offset);
658
687rocrand_status ROCRANDAPI rocrand_set_ordering(rocrand_generator generator, rocrand_ordering order);
688
707rocrand_status ROCRANDAPI
709 unsigned int dimensions);
710
723rocrand_status ROCRANDAPI
724rocrand_get_version(int * version);
725
740rocrand_status ROCRANDAPI
742 rocrand_discrete_distribution * discrete_distribution);
743
762rocrand_status ROCRANDAPI
763rocrand_create_discrete_distribution(const double * probabilities,
764 unsigned int size,
765 unsigned int offset,
766 rocrand_discrete_distribution * discrete_distribution);
767
780rocrand_status ROCRANDAPI
782
794rocrand_status ROCRANDAPI rocrand_get_direction_vectors32(const unsigned int** vectors,
796
808rocrand_status ROCRANDAPI rocrand_get_direction_vectors64(const unsigned long long** vectors,
810
819rocrand_status ROCRANDAPI rocrand_get_scramble_constants32(const unsigned int** constants);
820
829rocrand_status ROCRANDAPI rocrand_get_scramble_constants64(const unsigned long long** constants);
830
831#if defined(__cplusplus)
832}
833#endif /* __cplusplus */
834
// end of group rocrandhost
836
837#endif // ROCRAND_H_
rocrand_status ROCRANDAPI rocrand_create_poisson_distribution(double lambda, rocrand_discrete_distribution *discrete_distribution)
Construct the histogram for a Poisson distribution.
rocrand_status ROCRANDAPI rocrand_generate_short(rocrand_generator generator, unsigned short *output_data, size_t n)
Generates uniformly distributed 16-bit unsigned integers.
rocrand_status ROCRANDAPI rocrand_generate_normal(rocrand_generator generator, float *output_data, size_t n, float mean, float stddev)
Generates normally distributed float values.
rocrand_status ROCRANDAPI rocrand_set_offset(rocrand_generator generator, unsigned long long offset)
Sets the offset of a random number generator.
rocrand_status ROCRANDAPI rocrand_create_generator_host_blocking(rocrand_generator *generator, rocrand_rng_type rng_type)
Creates a new host random number generator, similar to rocrand_create_generator_host....
rocrand_status ROCRANDAPI rocrand_initialize_generator(rocrand_generator generator)
Initializes the generator's state on GPU or host.
rocrand_status ROCRANDAPI rocrand_get_direction_vectors32(const unsigned int **vectors, rocrand_direction_vector_set set)
Get the vector for 32-bit (scrambled-)sobol generation.
rocrand_status ROCRANDAPI rocrand_create_generator_host(rocrand_generator *generator, rocrand_rng_type rng_type)
Creates a new host random number generator.
rocrand_status ROCRANDAPI rocrand_generate_normal_double(rocrand_generator generator, double *output_data, size_t n, double mean, double stddev)
Generates normally distributed double values.
rocrand_ordering
rocRAND generator ordering
Definition rocrand.h:107
rocrand_status ROCRANDAPI rocrand_generate_char(rocrand_generator generator, unsigned char *output_data, size_t n)
Generates uniformly distributed 8-bit unsigned integers.
rocrand_status ROCRANDAPI rocrand_generate_log_normal(rocrand_generator generator, float *output_data, size_t n, float mean, float stddev)
Generates log-normally distributed float values.
rocrand_status
rocRAND function call status type
Definition rocrand.h:59
rocrand_status ROCRANDAPI rocrand_create_generator(rocrand_generator *generator, rocrand_rng_type rng_type)
Creates a new random number generator.
rocrand_rng_type
rocRAND generator type
Definition rocrand.h:78
rocrand_status ROCRANDAPI rocrand_generate_long_long(rocrand_generator generator, unsigned long long int *output_data, size_t n)
Generates uniformly distributed 64-bit unsigned integers.
rocrand_status ROCRANDAPI rocrand_generate_uniform_half(rocrand_generator generator, half *output_data, size_t n)
Generates uniformly distributed half-precision floating-point values.
rocrand_status ROCRANDAPI rocrand_set_stream(rocrand_generator generator, hipStream_t stream)
Sets the current stream for kernel launches.
rocrand_status ROCRANDAPI rocrand_generate_normal_half(rocrand_generator generator, half *output_data, size_t n, half mean, half stddev)
Generates normally distributed half values.
rocrand_status ROCRANDAPI rocrand_get_scramble_constants32(const unsigned int **constants)
Get the scramble constants for 32-bit scrambled sobol generation.
rocrand_status ROCRANDAPI rocrand_generate_uniform_double(rocrand_generator generator, double *output_data, size_t n)
Generates uniformly distributed double-precision floating-point values.
rocrand_status ROCRANDAPI rocrand_get_direction_vectors64(const unsigned long long **vectors, rocrand_direction_vector_set set)
Get the vector for 64-bit (scrambled-)sobol generation.
rocrand_status ROCRANDAPI rocrand_generate_uniform(rocrand_generator generator, float *output_data, size_t n)
Generates uniformly distributed float values.
rocrand_status ROCRANDAPI rocrand_create_discrete_distribution(const double *probabilities, unsigned int size, unsigned int offset, rocrand_discrete_distribution *discrete_distribution)
Construct the histogram for a custom discrete distribution.
rocrand_status ROCRANDAPI rocrand_set_ordering(rocrand_generator generator, rocrand_ordering order)
Sets the ordering of a random number generator.
rocrand_status ROCRANDAPI rocrand_generate_poisson(rocrand_generator generator, unsigned int *output_data, size_t n, double lambda)
Generates Poisson-distributed 32-bit unsigned integers.
rocrand_status ROCRANDAPI rocrand_set_quasi_random_generator_dimensions(rocrand_generator generator, unsigned int dimensions)
Set the number of dimensions of a quasi-random number generator.
rocrand_status ROCRANDAPI rocrand_get_version(int *version)
Returns the version number of the library.
rocrand_status ROCRANDAPI rocrand_set_seed_uint4(rocrand_generator generator, uint4 seed)
Sets the seeds of a pseudo-random number generator.
rocrand_status ROCRANDAPI rocrand_generate(rocrand_generator generator, unsigned int *output_data, size_t n)
Generates uniformly distributed 32-bit unsigned integers.
rocrand_direction_vector_set
rocRAND vector set
Definition rocrand.h:121
rocrand_status ROCRANDAPI rocrand_destroy_discrete_distribution(rocrand_discrete_distribution discrete_distribution)
Destroy the histogram array for a discrete distribution.
rocrand_status ROCRANDAPI rocrand_generate_log_normal_double(rocrand_generator generator, double *output_data, size_t n, double mean, double stddev)
Generates log-normally distributed double values.
rocrand_status ROCRANDAPI rocrand_set_seed(rocrand_generator generator, unsigned long long seed)
Sets the seed of a pseudo-random number generator.
rocrand_status ROCRANDAPI rocrand_get_scramble_constants64(const unsigned long long **constants)
Get the scramble constants for 64-bit scrambled sobol generation.
rocrand_status ROCRANDAPI rocrand_generate_log_normal_half(rocrand_generator generator, half *output_data, size_t n, half mean, half stddev)
Generates log-normally distributed half values.
rocrand_status ROCRANDAPI rocrand_destroy_generator(rocrand_generator generator)
Destroys random number generator.
@ ROCRAND_ORDERING_PSEUDO_DEFAULT
Default ordering for pseudorandom results.
Definition rocrand.h:109
@ ROCRAND_ORDERING_QUASI_DEFAULT
n-dimensional ordering for quasirandom results
Definition rocrand.h:114
@ ROCRAND_ORDERING_PSEUDO_SEEDED
Fast lower quality pseudorandom results.
Definition rocrand.h:110
@ ROCRAND_ORDERING_PSEUDO_DYNAMIC
Adjust to the device executing the generator. The global memory usage may be higher than with the oth...
Definition rocrand.h:112
@ ROCRAND_ORDERING_PSEUDO_BEST
Best ordering for pseudorandom results.
Definition rocrand.h:108
@ ROCRAND_ORDERING_PSEUDO_LEGACY
Legacy ordering for pseudorandom results.
Definition rocrand.h:111
@ ROCRAND_STATUS_NOT_CREATED
Generator was not created using rocrand_create_generator.
Definition rocrand.h:62
@ ROCRAND_STATUS_LAUNCH_FAILURE
Kernel launch failure.
Definition rocrand.h:70
@ ROCRAND_STATUS_VERSION_MISMATCH
Header file and linked library version do not match.
Definition rocrand.h:61
@ ROCRAND_STATUS_LENGTH_NOT_MULTIPLE
Definition rocrand.h:66
@ ROCRAND_STATUS_DOUBLE_PRECISION_REQUIRED
GPU does not have double precision.
Definition rocrand.h:69
@ ROCRAND_STATUS_SUCCESS
No errors.
Definition rocrand.h:60
@ ROCRAND_STATUS_INTERNAL_ERROR
Internal library error.
Definition rocrand.h:71
@ ROCRAND_STATUS_OUT_OF_RANGE
Argument out of range.
Definition rocrand.h:65
@ ROCRAND_STATUS_ALLOCATION_FAILED
Memory allocation failed during execution.
Definition rocrand.h:63
@ ROCRAND_STATUS_TYPE_ERROR
Generator type is wrong.
Definition rocrand.h:64
@ ROCRAND_RNG_PSEUDO_DEFAULT
Default pseudorandom generator.
Definition rocrand.h:79
@ ROCRAND_RNG_QUASI_SOBOL64
Sobol64 quasirandom generator.
Definition rocrand.h:98
@ ROCRAND_RNG_PSEUDO_LFSR113
LFSR113 pseudorandom generator.
Definition rocrand.h:85
@ ROCRAND_RNG_PSEUDO_THREEFRY2_64_20
ThreeFry 64 bit state size 2 pseudorandom generator.
Definition rocrand.h:89
@ ROCRAND_RNG_QUASI_DEFAULT
Default quasirandom generator.
Definition rocrand.h:95
@ ROCRAND_RNG_PSEUDO_XORWOW
XORWOW pseudorandom generator.
Definition rocrand.h:80
@ ROCRAND_RNG_PSEUDO_THREEFRY4_32_20
ThreeFry 32 bit state size 4 pseudorandom generator.
Definition rocrand.h:91
@ ROCRAND_RNG_PSEUDO_MRG31K3P
MRG31k3p pseudorandom generator.
Definition rocrand.h:84
@ ROCRAND_RNG_PSEUDO_MT19937
Mersenne Twister MT19937 pseudorandom generator.
Definition rocrand.h:86
@ ROCRAND_RNG_PSEUDO_PHILOX4_32_10
PHILOX-4x32-10 pseudorandom generator.
Definition rocrand.h:83
@ ROCRAND_RNG_PSEUDO_THREEFRY2_32_20
ThreeFry 32 bit state size 2 pseudorandom generator.
Definition rocrand.h:87
@ ROCRAND_RNG_PSEUDO_THREEFRY4_64_20
ThreeFry 64 bit state size 4 pseudorandom generator.
Definition rocrand.h:93
@ ROCRAND_RNG_PSEUDO_MTGP32
Mersenne Twister MTGP32 pseudorandom generator.
Definition rocrand.h:82
@ ROCRAND_RNG_QUASI_SOBOL32
Sobol32 quasirandom generator.
Definition rocrand.h:96
@ ROCRAND_RNG_QUASI_SCRAMBLED_SOBOL32
Scrambled Sobol32 quasirandom generator.
Definition rocrand.h:97
@ ROCRAND_RNG_QUASI_SCRAMBLED_SOBOL64
Scrambled Sobol64 quasirandom generator.
Definition rocrand.h:99
@ ROCRAND_RNG_PSEUDO_MRG32K3A
MRG32k3a pseudorandom generator.
Definition rocrand.h:81
Represents a discrete probability distribution.
Definition rocrand_discrete_types.h:26