[oneMKL][RNG] bug fixes (#298)

aelizaro · web-flow · commit 0ac7f9ca15fe · 2021-03-09T07:34:53.000-05:00
diff --git a/source/elements/oneMKL/source/domains/equations/rng-leapfrog.png b/source/elements/oneMKL/source/domains/equations/rng-leapfrog.png
diff --git a/source/elements/oneMKL/source/domains/equations/rng-skip-ahead.png b/source/elements/oneMKL/source/domains/equations/rng-skip-ahead.png
diff --git a/source/elements/oneMKL/source/domains/rng/bibliography.rst b/source/elements/oneMKL/source/domains/rng/bibliography.rst
@@ -11,7 +11,7 @@ Bibliography
 .. container::
 
 
-   For more information about the VS RNG functionality, refer to the
+   For more information about the RNG functionality, refer to the
    following publications:
 
 
@@ -21,7 +21,7 @@ Bibliography
       .. container::
 
 
-         **VS RNG**
+         **RNG**
 
          [Bratley88]
             Bratley P. and Fox B.L. *Implementing Sobol's Quasirandom
diff --git a/source/elements/oneMKL/source/domains/rng/distributions-template-parameter-mkl-rng-method-values.rst b/source/elements/oneMKL/source/domains/rng/distributions-template-parameter-mkl-rng-method-values.rst
@@ -16,7 +16,7 @@ Distributions Template Parameter Method
         * -  Method
           -  Distributions
           -  Math Description
-        * -  ``uniform_method::standard``\         \ ``uniform_method::standard_accurate``\
+        * -  ``uniform_method::standard``\         \ ``uniform_method::accurate``\
           -  \ ``uniform(s,d)``\       \ ``uniform(i)``\
           -     Standard method. ``uniform_method::standard_accurate`` supported for ``uniform(s, d)`` only.
         * -  ``gaussian_method::box_muller``
diff --git a/source/elements/oneMKL/source/domains/rng/distributions.rst b/source/elements/oneMKL/source/domains/rng/distributions.rst
@@ -128,7 +128,7 @@ Distributions
          * -     Distribution
            -     Method
          * -           \ :ref:`onemkl_rng_uniform_continuous`\
-           -     `oneapi::mkl::rng::unform_method::standard_accurate`
+           -     `oneapi::mkl::rng::unform_method::accurate`
          * -           \ :ref:`onemkl_rng_exponential`\
            -     `oneapi::mkl::rng::exponential_method::icdf_accurate`
          * -           \ :ref:`onemkl_rng_weibull`\
diff --git a/source/elements/oneMKL/source/domains/rng/mkl-rng-generate.rst b/source/elements/oneMKL/source/domains/rng/mkl-rng-generate.rst
@@ -25,7 +25,8 @@ generate (Buffer version)
 .. code-block:: cpp
 
     namespace oneapi::mkl::rng {
-    template<typename DistrType, typename EngineType> void generate (const DistrType& distr, EngineType& engine, std::int64_t n, cl::sycl::buffer<typename DistrType::result_type, 1>& r);
+    template<typename DistrType, typename EngineType>
+    void generate (const DistrType& distr, EngineType& engine, std::int64_t n, sycl::buffer<typename DistrType::result_type, 1>& r);
     }
 
 .. container:: section
@@ -75,7 +76,8 @@ generate (USM version)
 .. code-block:: cpp
 
     namespace oneapi::mkl::rng {
-    template<typename DistrType, typename EngineType> cl::sycl::event generate (const DistrType& distr, EngineType& engine, std::int64_t n, typename DistrType::result_type* r, const cl::sycl::vector_class<cl::sycl::event> & dependencies);
+    template<typename DistrType, typename EngineType>
+    sycl::event generate (const DistrType& distr, EngineType& engine, std::int64_t n, typename DistrType::result_type* r, const sycl::vector_class<sycl::event> & dependencies);
     }
 
 .. container:: section
@@ -126,4 +128,3 @@ generate (USM version)
 
 
 **Parent topic:** :ref:`onemkl_rng_generate_routine`
-
diff --git a/source/elements/oneMKL/source/domains/rng/mkl-rng-leapfrog.rst b/source/elements/oneMKL/source/domains/rng/mkl-rng-leapfrog.rst
@@ -32,8 +32,8 @@ leapfrog
 .. code-block:: cpp
 
     namespace oneapi::mkl::rng {
-    template<typename EngineType> \
-                   void oneapi::mkl::rng::leapfrog(EngineType& engine, std::uint64_t idx, std::uint64_t stride);
+    template<typename EngineType>
+    void oneapi::mkl::rng::leapfrog(EngineType& engine, std::uint64_t idx, std::uint64_t stride);
     }
 
 .. container:: section
@@ -63,8 +63,8 @@ leapfrog
     // Creating 3 identical engines
     mkl::rng::mcg31m1 engine_1(queue, seed);
 
-    mkl::rng::mcg31m1 engine_2(queue, engine_1);
-    mkl::rng::mcg31m1 engine_3(queue, engine_1);
+    mkl::rng::mcg31m1 engine_2(engine_1);
+    mkl::rng::mcg31m1 engine_3(engine_1);
 
 
     // Leapfrogging the states of engines
@@ -76,4 +76,4 @@ leapfrog
 
 **Parent topic:** :ref:`onemkl_rng_service_routines`
 
-.. |image0| image:: ../equations/GUID-D90F2CB0-58B4-42F5-A1F9-FD1EA859DD44-low.png
+.. |image0| image:: ../equations/rng-leapfrog.png
diff --git a/source/elements/oneMKL/source/domains/rng/mkl-rng-philox4x32x10.rst b/source/elements/oneMKL/source/domains/rng/mkl-rng-philox4x32x10.rst
@@ -29,11 +29,11 @@ The Philox4x32x10 engine is a keyed family of generator of counter-based BRNG. T
 
         :math:`L_1^{i+1} =mullo(R_1^i, 0xD2511F53)`
 
-        :math:`R_1^{i+1} =mulhi(R_0^i, 0xCD9E8D57) \oplus k_0 \oplus L_0`
+        :math:`R_1^{i+1} =mulhi(R_0^i, 0xCD9E8D57) \oplus k_0^i \oplus L_0^i`
 
         :math:`L_0^{i+1} =mullo(R_0^i, 0xCD9E8D57)`
 
-        :math:`R_0^{i+1} =mulhi(R_1^i, 0xD2511F53) \oplus k_1 \oplus L_1`
+        :math:`R_0^{i+1} =mulhi(R_1^i, 0xD2511F53) \oplus k_1^i \oplus L_1^i`
 
         :math:`k_0^{i+1} =k_0^i + 0xBB67AE85`
 
diff --git a/source/elements/oneMKL/source/domains/rng/mkl-rng-skip_ahead.rst b/source/elements/oneMKL/source/domains/rng/mkl-rng-skip_ahead.rst
@@ -32,8 +32,8 @@ skip_ahead
 .. code-block:: cpp
 
     namespace oneapi::mkl::rng {
-    template<typename EngineType> \
-                   void oneapi::mkl::rng::skip_ahead(EngineType& engine, std::uint64_t num_to_skip);
+    template<typename EngineType>
+    void oneapi::mkl::rng::skip_ahead(EngineType& engine, std::uint64_t num_to_skip);
     }
 
 .. container:: section
@@ -59,8 +59,8 @@ skip_ahead
 
     // Creating 3 identical engines
     oneapi::mkl::rng::mcg31m1 engine_1(queue, seed);
-    oneapi::mkl::rng::mcg31m1 engine_2(queue, engine_1);
-    oneapi::mkl::rng::mcg31m1 engine_3(queue, engine_2);
+    oneapi::mkl::rng::mcg31m1 engine_2(engine_1);
+    oneapi::mkl::rng::mcg31m1 engine_3(engine_2);
 
     // Skipping ahead by 7 elements the 2nd engine
     oneapi::mkl::rng::skip_ahead(engine_2, 7);
@@ -79,8 +79,8 @@ skip_ahead (Interface with a partitioned number of skipped elements)
 .. code-block:: cpp
 
     namespace oneapi::mkl::rng {
-    template<typename EngineType> \
-                   void oneapi::mkl::rng::skip_ahead(EngineType& engine, std::initializer_list<std::uint64_t> num_to_skip);
+    template<typename EngineType>
+    void oneapi::mkl::rng::skip_ahead(EngineType& engine, std::initializer_list<std::uint64_t> num_to_skip);
     }
 
 .. container:: section
@@ -112,10 +112,10 @@ skip_ahead (Interface with a partitioned number of skipped elements)
     std::initializer_list<std::uint64_t> num_to_skip = {0, 1};
 
     // Creating the 2nd engine based on 1st. Skipping by 2^64
-    oneapi::mkl::rng::mrg32k3a engine_2(queue, engine_1);
+    oneapi::mkl::rng::mrg32k3a engine_2(engine_1);
     oneapi::mkl::rng::skip_ahead(engine_2, num_to_skip);
 
 
 **Parent topic:** :ref:`onemkl_rng_service_routines`
 
-.. |image0| image:: ../equations/GUID-061AF9F8-B166-4154-9BF1-4E2C99F1CE1F-low.png
+.. |image0| image:: ../equations/rng-skip-ahead.png
diff --git a/source/elements/oneMKL/source/domains/rng/mkl-rng-uniform-continuous.rst b/source/elements/oneMKL/source/domains/rng/mkl-rng-uniform-continuous.rst
@@ -69,7 +69,7 @@ class uniform
 
                 * ``oneapi::mkl::rng::uniform_method::by_default``
                 * ``oneapi::mkl::rng::uniform_method::standard``
-                * ``oneapi::mkl::rng::uniform_method::standard_accurate``
+                * ``oneapi::mkl::rng::uniform_method::accurate``
 
             See description of the methods in :ref:`Distributions methods template parameter<onemkl_rng_distributions_template_parameter_mkl_rng_method_values>`
 
diff --git a/source/elements/oneMKL/source/domains/rng/onemkl-rng-usage-model.rst b/source/elements/oneMKL/source/domains/rng/onemkl-rng-usage-model.rst
@@ -45,7 +45,7 @@ Buffer-based example
     #include <vector>
 
     #include "CL/sycl.hpp"
-    #include "mkl_rng_sycl.hpp"
+    #include "oneapi/mkl/rng.hpp"
 
     int main() {
         sycl::queue queue;
@@ -82,7 +82,7 @@ USM-based example
     #include <vector>
 
     #include "CL/sycl.hpp"
-    #include "mkl_rng_sycl.hpp"
+    #include "oneapi/mkl/rng.hpp"
 
     int main() {
         sycl::queue queue;
@@ -93,7 +93,7 @@ USM-based example
         sycl::usm_allocator<double, sycl::usm::alloc::shared> allocator(queue.get_context(), queue.get_device());
 
         // create vector with USM allocator
-        std::vector<double, sycl::usm_allocator<double, sycl::usm::alloc::shared>> r(n, allocator);
+        std::vector<double, decltype(allocator)> r(n, allocator);
 
         oneapi::mkl::rng::philox4x32x10 engine(queue, seed); // basic random number generator object
         oneapi::mkl::rng::gaussian<double, oneapi::mkl::rng::gaussian_method::box_muller2> distr(5.0, 2.0); // distribution object
diff --git a/source/elements/oneMKL/source/domains/stats/onemkl_stats_make_dataset.rst b/source/elements/oneMKL/source/domains/stats/onemkl_stats_make_dataset.rst
@@ -137,7 +137,7 @@ make_dataset (USM version)
     .. rubric:: Throws
 
     oneapi::mkl::invalid_argument
-        Exception is thrown when :math:`n_dims \leq 0`, or :math:`n_observations \leq 0`, or observations == nullptr
+        Exception is thrown when :math:`n\_dims \leq 0`, or :math:`n\_observations \leq 0`, or observations == nullptr
 
 .. container:: section
 
@@ -147,4 +147,3 @@ make_dataset (USM version)
 
 
 **Parent topic:** :ref:`onemkl_stats_service_routines`
-
diff --git a/source/elements/oneMKL/source/domains/stats/onemkl_stats_usage_model.rst b/source/elements/oneMKL/source/domains/stats/onemkl_stats_usage_model.rst
@@ -29,7 +29,7 @@ Buffer-based example
     #include <vector>
 
     #include "CL/sycl.hpp"
-    #include "mkl_stats_sycl.hpp"
+    #include "oneapi/mkl/stats.hpp"
 
     int main() {
         sycl::queue queue;
@@ -40,7 +40,7 @@ Buffer-based example
         // fill x storage with random numbers
         for(int i = 0; i < n_dims, i++) {
           for(int j = 0; j < n_observations; j++) {
-                x[j + i * n_observations] = float(std::rand()) / float(RAND_MAX)
+                x[j + i * n_observations] = float(std::rand()) / float(RAND_MAX);
             }
         }
         //create buffer for dataset
@@ -74,7 +74,7 @@ USM-based example
     #include <vector>
 
     #include "CL/sycl.hpp"
-    #include "mkl_stats_sycl.hpp"
+    #include "oneapi/mkl/stats.hpp"
 
     int main() {
         sycl::queue queue;
@@ -88,7 +88,7 @@ USM-based example
         // fill x storage with random numbers
         for(int i = 0; i < n_dims, i++) {
           for(int j = 0; j < n_observations; j++) {
-                x[j + i * n_observations] = float(std::rand()) / float(RAND_MAX)
+                x[j + i * n_observations] = float(std::rand()) / float(RAND_MAX);
             }
         }
         std::vector<float, decltype(allocator)> mean_buf(n_dims, allocator);
@@ -109,4 +109,3 @@ USM-based example
 You can also use USM with raw pointers by using the sycl::malloc_shared/malloc_device functions.
 
 **Parent topic:** :ref:`onemkl_stats`
-
