Add random_state class (#1139)

* Add random_state class

* Replace class on struct

* Add RandomState class to random module

* Delete cython layer for uniform

* Add ifdef to random_state.h and rename dpnp_random_state

* Resolve faults after the last rebase & implement minor improvements

* Formatting and minor fixes

* Fix build issue due to gcc knows nothing about OneAPI headers (detach MKL relating things into source file)

* Fix issues for legacy behavior with dpnp.random.uniform() and dpnp.random.seed() calls

* Add more tests for RandomState and RandomState.uniform

* Secure support of int32 for RandomState.uniform in tests.

* Exclude a test with dtype=numpy.intc from allowed integer types due to issue on Win

* Add normal(), rand(), randint(), randn(), random_sample(), standard_normal()

* Default dtype to be dependent on fp64 support

* Broken CFD in fallback on numpy

Co-authored-by: Alexander-Makaryev <[email protected]>
Co-authored-by: Anton <[email protected]>
Co-authored-by: Anton Volkov <[email protected]>

Author: 3 people

.github/workflows/conda-package.yml

@@ -234,7 +234,8 @@ jobs:
 
       # TODO: run the whole scope once the issues on CPU are resolved
       - name: Run tests
-        run: python -m pytest -q -ra --disable-warnings -vv test_arraycreation.py test_dparray.py test_fft.py test_linalg.py test_mathematical.py test_special.py
+        run: |
+          python -m pytest -q -ra --disable-warnings -vv test_arraycreation.py test_dparray.py test_fft.py test_linalg.py test_mathematical.py test_random_state.py test_special.py
         env:
           OCL_ICD_FILENAMES: 'libintelocl.so'
         working-directory: ${{ env.tests-path }}
@@ -408,7 +409,8 @@ jobs:
 
       # TODO: run the whole scope once the issues on CPU are resolved
       - name: Run tests
-        run: python -m pytest -q -ra --disable-warnings -vv test_arraycreation.py test_dparray.py test_fft.py test_linalg.py test_mathematical.py test_special.py
+        run: |
+          python -m pytest -q -ra --disable-warnings -vv test_arraycreation.py test_dparray.py test_fft.py test_linalg.py test_mathematical.py test_random_state.py test_special.py
         working-directory: ${{ env.tests-path }}
 
   upload_linux:

dpnp/__init__.py

@@ -45,9 +45,9 @@
 from dpnp.dpnp_array import dpnp_array as ndarray
 from dpnp.dpnp_flatiter import flatiter as flatiter
 
+from dpnp.dpnp_iface_types import *
 from dpnp.dpnp_iface import *
 from dpnp.dpnp_iface import __all__ as _iface__all__
-from dpnp.dpnp_iface_types import *
 from dpnp.version import __version__
 
 

dpnp/backend/CMakeLists.txt

@@ -218,6 +218,7 @@ set(DPNP_SRC
     src/memory_sycl.cpp
     src/queue_sycl.cpp
     src/verbose.cpp
+    src/dpnp_random_state.cpp
     )
 
 if(DPNP_STATIC_LIB_ENABLE)

dpnp/backend/include/dpnp_iface_fptr.hpp

@@ -314,7 +314,6 @@ enum class DPNPFuncName : size_t
     DPNP_FN_RNG_STANDARD_GAMMA,           /**< Used in numpy.random.standard_gamma() impl  */
     DPNP_FN_RNG_STANDARD_GAMMA_EXT,       /**< Used in numpy.random.standard_gamma() impl, requires extra parameters */
     DPNP_FN_RNG_STANDARD_NORMAL,          /**< Used in numpy.random.standard_normal() impl  */
-    DPNP_FN_RNG_STANDARD_NORMAL_EXT,      /**< Used in numpy.random.standard_normal() impl  */
     DPNP_FN_RNG_STANDARD_T,               /**< Used in numpy.random.standard_t() impl  */
     DPNP_FN_RNG_STANDARD_T_EXT,           /**< Used in numpy.random.standard_t() impl, requires extra parameters */
     DPNP_FN_RNG_TRIANGULAR,               /**< Used in numpy.random.triangular() impl  */

dpnp/backend/include/dpnp_iface_random.hpp

@@ -1,5 +1,5 @@
 //*****************************************************************************
-// Copyright (c) 2016-2020, Intel Corporation
+// Copyright (c) 2016-2022, Intel Corporation
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms, with or without
@@ -438,18 +438,20 @@ INP_DLLEXPORT void
  * @brief math library implementation of random number generator (normal continious distribution)
  *
  * @param [in]  q_ref               Reference to SYCL queue.
- * @param [out] result              Output array.
+ * @param [out] result_out          Output array.
  * @param [in]  mean                Mean value.
  * @param [in]  stddev              Standard deviation.
  * @param [in]  size                Number of elements in `result` arrays.
+ * @param [in]  random_state_in     Pointer on random state.
  * @param [in]  dep_event_vec_ref   Reference to vector of SYCL events.
  */
 template <typename _DataType>
 INP_DLLEXPORT DPCTLSyclEventRef dpnp_rng_normal_c(DPCTLSyclQueueRef q_ref,
-                                                  void* result,
-                                                  const _DataType mean,
-                                                  const _DataType stddev,
-                                                  const size_t size,
+                                                  void* result_out,
+                                                  const double mean,
+                                                  const double stddev,
+                                                  const int64_t size,
+                                                  void* random_state_in,
                                                   const DPCTLEventVectorRef dep_event_vec_ref);
 
 template <typename _DataType>
@@ -629,17 +631,11 @@ INP_DLLEXPORT void dpnp_rng_standard_gamma_c(void* result, const _DataType shape
  * @brief math library implementation of random number generator (standard normal distribution)
  *
  * @param [in]  q_ref               Reference to SYCL queue.
- * @param [out] result              Output array.
+ * @param [out] result_out          Output array.
  * @param [in]  size                Number of elements in `result` arrays.
  * @param [in]  dep_event_vec_ref   Reference to vector of SYCL events.
  */
 template <typename _DataType>
-INP_DLLEXPORT DPCTLSyclEventRef dpnp_rng_standard_normal_c(DPCTLSyclQueueRef q_ref,
-                                                           void* result,
-                                                           const size_t size,
-                                                           const DPCTLEventVectorRef dep_event_vec_ref);
-
-template <typename _DataType>
 INP_DLLEXPORT void dpnp_rng_standard_normal_c(void* result, const size_t size);
 
 /**
@@ -692,18 +688,20 @@ INP_DLLEXPORT void dpnp_rng_triangular_c(
  * @brief math library implementation of random number generator (uniform distribution)
  *
  * @param [in]  q_ref               Reference to SYCL queue.
- * @param [out] result              Output array.
+ * @param [out] result_out          Output array.
  * @param [in]  low                 Left bound of array values.
  * @param [in]  high                Right bound of array values.
  * @param [in]  size                Number of elements in `result` array.
+ * @param [in]  random_state_in     Pointer on random state.
  * @param [in]  dep_event_vec_ref   Reference to vector of SYCL events.
  */
 template <typename _DataType>
 INP_DLLEXPORT DPCTLSyclEventRef dpnp_rng_uniform_c(DPCTLSyclQueueRef q_ref,
-                                                   void* result,
-                                                   const long low,
-                                                   const long high,
-                                                   const size_t size,
+                                                   void* result_out,
+                                                   const double low,
+                                                   const double high,
+                                                   const int64_t size,
+                                                   void* random_state_in,
                                                    const DPCTLEventVectorRef dep_event_vec_ref);
 
 template <typename _DataType>