Merge pull request #2509 from andreyfe1/rng_verification

[oneMKL] Add verification for oneMKL RNG Samples

Author: jimmytwei

Libraries/oneMKL/monte_carlo_pi/README.md

@@ -79,29 +79,35 @@ Monte Carlo pi Calculation Simulation
 Buffer API
 -------------------------------------
 Number of points = 120000000
-Estimated value of Pi = 3.14139
+Estimated value of Pi = 3.14106
 Exact value of Pi = 3.14159
-Absolute error = 0.000207487
+Absolute error = 0.000530387
+
+TEST PASSED
 
 ./mc_pi_usm
 
 Monte Carlo pi Calculation Simulation
 Unified Shared Memory API
 -------------------------------------
 Number of points = 120000000
-Estimated value of Pi = 3.14139
+Estimated value of Pi = 3.14106
 Exact value of Pi = 3.14159
-Absolute error = 0.000207487
+Absolute error = 0.000530387
+
+TEST PASSED
 
 ./mc_pi_device_api
 
 Monte Carlo pi Calculation Simulation
 Device API
 -------------------------------------
 Number of points = 120000000
-Estimated value of Pi = 3.14139
+Estimated value of Pi = 3.14159
 Exact value of Pi = 3.14159
-Absolute error = 0.000207487
+Absolute error = 5.95359e-06
+
+TEST PASSED
 ```
 
 ### Troubleshooting

Libraries/oneMKL/monte_carlo_pi/mc_pi.cpp

@@ -7,7 +7,7 @@
 /*
 *
 *  Content:
-*       This file contains Monte Carlo Pi number evaluation benchmark for DPC++ 
+*       This file contains Monte Carlo Pi number evaluation benchmark for DPC++
 *       interface of random number generators.
 *
 *******************************************************************************/
@@ -126,10 +126,17 @@ int main(int argc, char ** argv) {
     }
 
     // Printing results
+    double abs_error = std::fabs(pi - estimated_pi);
     std::cout << "Estimated value of Pi = " << estimated_pi << std::endl;
     std::cout << "Exact value of Pi = " << pi << std::endl;
-    std::cout << "Absolute error = " << fabs(pi-estimated_pi) << std::endl;
+    std::cout << "Absolute error = " << abs_error << std::endl;
     std::cout << std::endl;
 
+    if(abs_error > 1.0e-3) {
+        std::cout << "TEST FAILED" << std::endl;
+        return 1;
+    }
+
+    std::cout << "TEST PASSED" << std::endl;
     return 0;
 }

Libraries/oneMKL/monte_carlo_pi/mc_pi_device_api.cpp

@@ -116,10 +116,17 @@ int main(int argc, char ** argv) {
     }
 
     // Printing results
+    double abs_error = std::fabs(pi - estimated_pi);
     std::cout << "Estimated value of Pi = " << estimated_pi << std::endl;
     std::cout << "Exact value of Pi = " << pi << std::endl;
-    std::cout << "Absolute error = " << fabs(pi-estimated_pi) << std::endl;
+    std::cout << "Absolute error = " << abs_error << std::endl;
     std::cout << std::endl;
 
+    if(abs_error > 1.0e-4) {
+        std::cout << "TEST FAILED" << std::endl;
+        return 1;
+    }
+
+    std::cout << "TEST PASSED" << std::endl;
     return 0;
 }

Libraries/oneMKL/monte_carlo_pi/mc_pi_usm.cpp

@@ -7,7 +7,7 @@
 /*
 *
 *  Content:
-*       This file contains Monte Carlo Pi number evaluation benchmark for DPC++ 
+*       This file contains Monte Carlo Pi number evaluation benchmark for DPC++
 *       USM-based interface of random number generators.
 *
 *******************************************************************************/
@@ -70,7 +70,7 @@ double estimate_pi(sycl::queue& q, size_t n_points) {
                     count += 1;
                 }
             }
-            count_ptr[item.get_group_linear_id()] = reduce_over_group(item.get_group(), count, std::plus<size_t>());
+            count_ptr[item.get_group_linear_id()] = sycl::reduce_over_group(item.get_group(), count, std::plus<size_t>());
         });
     });
 
@@ -129,10 +129,17 @@ int main(int argc, char ** argv) {
     }
 
     // Printing results
+    double abs_error = std::fabs(pi - estimated_pi);
     std::cout << "Estimated value of Pi = " << estimated_pi << std::endl;
     std::cout << "Exact value of Pi = " << pi << std::endl;
-    std::cout << "Absolute error = " << fabs(pi-estimated_pi) << std::endl;
+    std::cout << "Absolute error = " << abs_error << std::endl;
     std::cout << std::endl;
 
+    if(abs_error > 1.0e-3) {
+        std::cout << "TEST FAILED" << std::endl;
+        return 1;
+    }
+
+    std::cout << "TEST PASSED" << std::endl;
     return 0;
 }

Libraries/oneMKL/random_sampling_without_replacement/README.md

@@ -82,13 +82,15 @@ After building, if everything is working correctly, you will see the step-by-ste
 ./lottery
 
 Multiple Simple Random Sampling without replacement
-Unified Shared Memory API
+Buffer Api
 ---------------------------------------------------
 M = 6, N = 49, Number of experiments = 11969664
 Sample 11969661 of lottery of 11969664: 19, 5, 17, 27, 44, 34,
 Sample 11969662 of lottery of 11969664: 31, 39, 6, 19, 48, 15,
 Sample 11969663 of lottery of 11969664: 24, 11, 29, 44, 2, 20,
 
+TEST PASSED
+
 ./lottery_usm
 
 Multiple Simple Random Sampling without replacement
@@ -100,6 +102,8 @@ Sample 11969661 of lottery of 11969664: 19, 5, 17, 27, 44, 34,
 Sample 11969662 of lottery of 11969664: 31, 39, 6, 19, 48, 15,
 Sample 11969663 of lottery of 11969664: 24, 11, 29, 44, 2, 20,
 
+TEST PASSED
+
 ./lottery_device_api
 
 Multiple Simple Random Sampling without replacement
@@ -109,6 +113,8 @@ M = 6, N = 49, Number of experiments = 11969664
 Sample 11969661 of lottery of 11969664: 19, 5, 17, 27, 44, 34,
 Sample 11969662 of lottery of 11969664: 31, 39, 6, 19, 48, 15,
 Sample 11969663 of lottery of 11969664: 24, 11, 29, 44, 2, 20,
+
+TEST PASSED
 ```
 
 ### Troubleshooting

Libraries/oneMKL/random_sampling_without_replacement/lottery.cpp

@@ -13,6 +13,7 @@
 *******************************************************************************/
 
 #include <iostream>
+#include <algorithm>
 
 #include <sycl/sycl.hpp>
 #include "oneapi/mkl.hpp"
@@ -59,10 +60,7 @@ void lottery(sycl::queue& q, size_t m, size_t n, size_t num_exp, size_t* result_
                     // Generate random natural number j from {i,...,N-1}
                     auto j = i + (size_t)(rng_buf[id * m + i] * (float)(n - i));
                     // Swap local_buf[i] and local_buf[j]
-                    auto tmp = local_buf[i];
-                    local_buf[i] = local_buf[j];
-
-                    local_buf[j] = tmp;
+                    std::swap(local_buf[i], local_buf[j]);
                 }
                 for (size_t i = 0; i < m; ++i) {
                     // Copy shuffled buffer
@@ -139,5 +137,20 @@ int main(int argc, char ** argv) {
     // Print output
     print_results(result_ptr, m, num_exp);
 
+    // Check correctness whether experiment contains unique numbers or not
+    for(size_t i = 0; i < num_exp; ++i){
+        auto first_iter = result_ptr + m * i;
+        std::sort(first_iter, first_iter + m);
+        if(std::adjacent_find(first_iter, first_iter + m) != first_iter + m &&
+            // if all elements are in the [0, n] range
+            std::count_if(first_iter, first_iter + m, [n](auto val){return val > n && val >= 0;}) == 0)
+        {
+            std::cout << "TEST FAILED" << std::endl;
+            std::cout << "Error: the experiment "<< i <<" contains duplicates" << std::endl;
+            return 1;
+        }
+    }
+
+    std::cout << "TEST PASSED" << std::endl;
     return 0;
 }

Libraries/oneMKL/random_sampling_without_replacement/lottery_device_api.cpp

@@ -13,6 +13,7 @@
 *******************************************************************************/
 
 #include <iostream>
+#include <algorithm>
 
 #include <sycl/sycl.hpp>
 #include "oneapi/mkl/rng/device.hpp"
@@ -52,10 +53,7 @@ void lottery_device_api(sycl::queue& q, size_t m, size_t n, size_t num_exp, std:
                     // Generate random natural number j from {i,...,N-1}
                     auto j = i + (size_t)(res * (float)(n - i));
                     // Swap local_buf[i] and local_buf[j]
-                    auto tmp = local_buf[i];
-                    local_buf[i] = local_buf[j];
-
-                    local_buf[j] = tmp;
+                    std::swap(local_buf[i], local_buf[j]);
                 }
                 for (size_t i = 0; i < m; ++i) {
                     // Copy shuffled buffer
@@ -128,5 +126,20 @@ int main(int argc, char ** argv) {
     // Print output
     print_results(result_vec, m);
 
+    // Check correctness whether experiment contains unique numbers or not
+    for(size_t i = 0; i < num_exp; ++i){
+        auto first_iter = result_vec.begin() + m * i;
+        std::sort(first_iter, first_iter + m);
+        if(std::adjacent_find(first_iter, first_iter + m) != first_iter + m &&
+            // if all elements are in the [0, n] range
+            std::count_if(first_iter, first_iter + m, [n](auto val){return val > n && val >= 0;}) == 0)
+        {
+            std::cout << "TEST FAILED" << std::endl;
+            std::cout << "Error: the experiment "<< i <<" contains duplicates" << std::endl;
+            return 1;
+        }
+    }
+
+    std::cout << "TEST PASSED" << std::endl;
     return 0;
 }

Libraries/oneMKL/random_sampling_without_replacement/lottery_usm.cpp

@@ -13,6 +13,7 @@
 *******************************************************************************/
 
 #include <iostream>
+#include <algorithm>
 
 #include <sycl/sycl.hpp>
 #include "oneapi/mkl.hpp"
@@ -59,10 +60,7 @@ void lottery(sycl::queue& q, size_t m, size_t n, size_t num_exp, size_t* result_
                     // Generate random natural number j from {i,...,N-1}
                     auto j = i + (size_t)(rng_buf[id * m + i] * (float)(n - i));
                     // Swap local_buf[i] and local_buf[j]
-                    auto tmp = local_buf[i];
-                    local_buf[i] = local_buf[j];
-
-                    local_buf[j] = tmp;
+                    std::swap(local_buf[i], local_buf[j]);
                 }
                 for (size_t i = 0; i < m; ++i) {
                     // Copy shuffled buffer
@@ -140,5 +138,20 @@ int main(int argc, char ** argv) {
     std::cout << "Results with Host API:" << std::endl;
     print_results(result_ptr, m, num_exp);
 
+    // Check correctness whether experiment contains unique numbers or not
+    for(size_t i = 0; i < num_exp; ++i){
+        auto first_iter = result_ptr + m * i;
+        std::sort(first_iter, first_iter + m);
+        if(std::adjacent_find(first_iter, first_iter + m) != first_iter + m &&
+            // if all elements are in the [0, n] range
+            std::count_if(first_iter, first_iter + m, [n](auto val){return val > n && val >= 0;}) == 0)
+        {
+            std::cout << "TEST FAILED" << std::endl;
+            std::cout << "Error: the experiment "<< i <<" contains duplicates" << std::endl;
+            return 1;
+        }
+    }
+
+    std::cout << "TEST PASSED" << std::endl;
     return 0;
 }

Libraries/oneMKL/student_t_test/README.md

@@ -70,6 +70,8 @@ Number of random samples = 1000000 with mean = 0, std_dev = 1
 T-test result with expected mean: 1
 T-test result with two input arrays: 1
 
+TEST PASSED
+
 ./t_test_usm
 
 Student's T-test Simulation
@@ -78,6 +80,8 @@ Unified Shared Memory Api
 Number of random samples = 1000000 with mean = 0, std_dev = 1
 T-test result with expected mean: 1
 T-test result with two input arrays: 1
+
+TEST PASSED
 ```
 
 ### Troubleshooting

Libraries/oneMKL/student_t_test/t_test.cpp

@@ -19,18 +19,17 @@
 
 #include "oneapi/mkl.hpp"
 
-using fp_type = float;
 // Initialization value for random number generator
-static const auto seed = 7777;
+static const int seed = 7777;
 // Quantity of samples to check using Students' T-test
-static const auto n_samples = 1000000;
+static const int n_samples = 1000000;
 // Expected mean value of random samples
-static const auto expected_mean = 0.0f;
+static const float expected_mean = 0.0f;
 // Expected standard deviation of random samples
-static const auto expected_std_dev = 1.0f;
+static const float expected_std_dev = 1.0f;
 // T-test threshold which corresponds to 5% significance level and infinite
 // degrees of freedom
-static const auto threshold = 1.95996f;
+static const float threshold = 1.95996f;
 
 // T-test function with expected mean
 // Returns: -1 if something went wrong, 1 - in case of NULL hypothesis should be
@@ -123,10 +122,11 @@ std::int32_t t_test(sycl::queue &q, sycl::buffer<RealType, 1> &r1,
 }
 
 int main(int argc, char **argv) {
-  std::cout << "\nStudent's T-test Simulation\n";
-  std::cout << "Buffer Api\n";
-  std::cout << "-------------------------------------\n";
+  std::cout << "\nStudent's T-test Simulation" << std::endl;
+  std::cout << "Buffer Api" << std::endl;
+  std::cout << "-------------------------------------" << std::endl;
 
+  using fp_type = float;
   size_t n_points = n_samples;
   fp_type mean = expected_mean;
   fp_type std_dev = expected_std_dev;
@@ -153,7 +153,7 @@ int main(int argc, char **argv) {
   }
 
   std::cout << "Number of random samples = " << n_points
-            << " with mean = " << mean << ", std_dev = " << std_dev << "\n";
+            << " with mean = " << mean << ", std_dev = " << std_dev << std::endl;
 
   // This exception handler with catch async exceptions
   auto exception_handler = [](sycl::exception_list exceptions) {
@@ -189,13 +189,19 @@ int main(int argc, char **argv) {
     res1 = t_test(q, rng_buf0, n_points, rng_buf1, n_points);
   } catch (...) {
     // Some other exception detected
-    std::cout << "Failure\n";
+    std::cout << "Failure" << std::endl;
     std::terminate();
   }
 
   // Printing results
-  std::cout << "T-test result with expected mean: " << res0 << "\n";
-  std::cout << "T-test result with two input arrays: " << res1 << "\n\n";
+  std::cout << "T-test result with expected mean: " << res0 << std::endl;
+  std::cout << "T-test result with two input arrays: " << res1 << std::endl << std::endl;
 
+  if(res0 != 1 || res1 != 1) {
+    std::cout << "TEST FAILED" << std::endl;
+    return 1;
+  }
+
+  std::cout << "TEST PASSED" << std::endl;
   return 0;
 }