[MKL] Fixes for VM, RNG, Stats (#433)

* [MKL] Fix directories for VM, RNG, Stats

* [MKL][RNG] Minor fixes

* [RNG] address comments

Author: aelizaro

source/elements/oneMKL/source/domains/domains.rst

@@ -12,7 +12,7 @@ This section describes the Data Parallel C++ (DPC++) interface.
 .. include:: dense_linear_algebra.inc.rst
 .. include:: sparse_linear_algebra.inc.rst
 .. include:: discrete_fourier_transforms.inc.rst
-.. include:: rng/random_number_generators.inc.rst
-.. include:: stats/stats.inc.rst
-.. include:: vm/vector_math.inc.rst
+.. include:: random_number_generators.inc.rst
+.. include:: stats.inc.rst
+.. include:: vector_math.inc.rst
 

source/elements/oneMKL/source/domains/random_number_generators.inc.rst

@@ -0,0 +1,17 @@
+.. SPDX-FileCopyrightText: 2019-2020 Intel Corporation
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+.. _onemkl_rng:
+
+Random Number Generators
+-------------------------
+
+The oneAPI Math Kernel Library Random Number Generators provides a :ref:`set of routines <onemkl_rng_overview>` implementing commonly
+used :ref:`pseudorandom, quasi-random, and non-deterministic generators <onemkl_rng_engines_basic_random_number_generators>`
+with :ref:`continuous and discrete distributions <onemkl_rng_distributions>`.
+
+.. toctree::
+   :hidden:
+
+   rng/onemkl-rng-overview.rst

source/elements/oneMKL/source/domains/rng/engines-basic-random-number-generators.rst

@@ -40,7 +40,7 @@ Engines (Basic Random Number Generators)
          * -                      \ :ref:`onemkl_rng_mt19937`\
            -     Mersenne Twister pseudorandom number generator       ``MT19937``\ :ref:`[Matsumoto98] <onemkl_rng_bibliography>`      with period length 2\ :sup:`19937`-1 of the produced sequence
          * -                      \ :ref:`onemkl_rng_mt2203`\
-           -     Set of 6024 Mersenne Twister pseudorandom number       generators      ``MT2203``\ `[Matsumoto98] <onemkl_rng_bibliography>`,      :ref:`[Matsumoto00] <onemkl_rng_bibliography>`.      Each of them generates a sequence of period length equal to      2\ :sup:`2203`-1. Parameters of the generators provide mutual      independence of the corresponding sequences.
+           -     Set of 6024 Mersenne Twister pseudorandom number       generators      ``MT2203``\ :ref:`[Matsumoto98] <onemkl_rng_bibliography>`,      :ref:`[Matsumoto00] <onemkl_rng_bibliography>`.      Each of them generates a sequence of period length equal to      2\ :sup:`2203`-1. Parameters of the generators provide mutual      independence of the corresponding sequences.
          * -                      \ :ref:`onemkl_rng_sfmt19937`\
            -     SIMD-oriented Fast Mersenne Twister pseudorandom       number generator      ``SFMT19937``\ :ref:`[Saito08] <onemkl_rng_bibliography>`      with a period length equal to 2\ :sup:`19937`-1 of the produced      sequence.
          * -                      \ :ref:`onemkl_rng_sobol`\

source/elements/oneMKL/source/domains/rng/mkl-rng-gaussian.rst

@@ -156,7 +156,7 @@ class gaussian
             .. rubric:: Throws
 
             oneapi::mkl::invalid_argument
-                Exception is thrown when :math:`stddev \leq` static_cast<RealType>(0.0)
+                Exception is thrown when `stddev` :math:`\leq` `static_cast<RealType>(0.0)`
 
 .. container:: section
 

source/elements/oneMKL/source/domains/rng/mkl-rng-leapfrog.rst

@@ -33,7 +33,7 @@ leapfrog
 
     namespace oneapi::mkl::rng {
     template<typename EngineType>
-    void oneapi::mkl::rng::leapfrog(EngineType& engine, std::uint64_t idx, std::uint64_t stride);
+    void leapfrog(EngineType& engine, std::uint64_t idx, std::uint64_t stride);
     }
 
 .. container:: section
@@ -61,16 +61,16 @@ leapfrog
 .. code-block:: cpp
 
     // Creating 3 identical engines
-    mkl::rng::mcg31m1 engine_1(queue, seed);
+    oneapi::mkl::rng::mcg31m1 engine_1(queue, seed);
 
-    mkl::rng::mcg31m1 engine_2(engine_1);
-    mkl::rng::mcg31m1 engine_3(engine_1);
+    oneapi::mkl::rng::mcg31m1 engine_2(engine_1);
+    oneapi::mkl::rng::mcg31m1 engine_3(engine_1);
 
 
     // Leapfrogging the states of engines
-    mkl::rng::leapfrog(engine_1, 0 , 3);
-    mkl::rng::leapfrog(engine_2, 1 , 3);
-    mkl::rng::leapfrog(engine_3, 2 , 3);
+    oneapi::mkl::rng::leapfrog(engine_1, 0 , 3);
+    oneapi::mkl::rng::leapfrog(engine_2, 1 , 3);
+    oneapi::mkl::rng::leapfrog(engine_3, 2 , 3);
     // Generating random numbers
 
 

source/elements/oneMKL/source/domains/rng/mkl-rng-skip_ahead.rst

@@ -33,7 +33,7 @@ skip_ahead
 
     namespace oneapi::mkl::rng {
     template<typename EngineType>
-    void oneapi::mkl::rng::skip_ahead(EngineType& engine, std::uint64_t num_to_skip);
+    void skip_ahead(EngineType& engine, std::uint64_t num_to_skip);
     }
 
 .. container:: section

…s/oneMKL/source/domains/rng/overview.rst …urce/domains/rng/onemkl-rng-overview.rstsource/elements/oneMKL/source/domains/rng/overview.rst renamed to source/elements/oneMKL/source/domains/rng/onemkl-rng-overview.rst source/elements/oneMKL/source/domains/rng/overview.rst renamed to source/elements/oneMKL/source/domains/rng/onemkl-rng-overview.rst

@@ -4,8 +4,8 @@
 
 .. _onemkl_rng_overview:
 
-Random Number Generators (RNG) Overview
-=======================================
+Random Number Generators (RNG)
+==============================
 
 .. rubric:: Definitions
 
@@ -62,3 +62,15 @@ The RNG domain also contains two types of free functions:
 Engine classes work with both generation and service routines. Distribution classes are used in
 generation routines only. Refer to the :ref:`onemkl_rng_usage_model`
 section for the description of typical RNG scenario.
+
+.. toctree::
+   :hidden:
+
+   onemkl-rng-usage-model.rst
+   generate-routine.rst
+   engines-basic-random-number-generators.rst
+   service-routines.rst
+   distributions.rst
+   bibliography.rst
+
+**Parent topic:** :ref:`onemkl_rng`

source/elements/oneMKL/source/domains/rng/onemkl-rng-usage-model.rst

@@ -12,22 +12,13 @@ oneMKL RNG Usage Model
 
 A typical algorithm for random number generators is as follows:
 
+1. Create and initialize the object for basic random number generator.
 
-1. Create and initialize the object for basic random number
-    generator.
-
-
--  Use the skip_ahead or leapfrog function if it is required (used
-    in parallel with random number generation for Host and CPU
-    devices).
-
+    -  Use the `skip_ahead` or `leapfrog` function if it is required (used in parallel with random number generation for Host and CPU devices).
 
 2. Create and initialize the object for distribution generator.
 
-
-3. Call the generate routine to get random numbers with appropriate
-    statistical distribution.
-
+3. Call the generate routine to get random numbers with appropriate statistical distribution.
 
 The following example demonstrates generation of random numbers that
 is output of basic generator (engine) PHILOX4X32X10. The seed is

source/elements/oneMKL/source/domains/rng/random_number_generators.inc.rst

@@ -0,0 +1,15 @@
+.. SPDX-FileCopyrightText: 2019-2020 Intel Corporation
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+.. _onemkl_stats:
+
+Summary Statistics
+-------------------
+
+The oneMKL provides a set of :ref:`Summary Statistics routines <onemkl_stats_overview>` that compute basic statistical estimates for single and double precision multi-dimensional datasets.
+
+.. toctree::
+	:hidden:
+
+	stats/onemkl_stats_overview.rst