Added mcg59 engine

Author: antonwolfy

dpnp/backend/extensions/rng/device/dispatch/table_builder.hpp

@@ -79,7 +79,8 @@ class Dispatch3DTableBuilder
 
     void populate(funcPtrT table[][_no_of_types][_no_of_methods]) const
     {
-        const auto map_by_engine = {table_per_type_and_method<mkl_rng_dev::mrg32k3a<8>>()};
+        const auto map_by_engine = {table_per_type_and_method<mkl_rng_dev::mrg32k3a<8>>(),
+                                    table_per_type_and_method<mkl_rng_dev::mcg59<8>>()};
         assert(map_by_engine.size() == _no_of_engines);
 
         std::uint16_t engine_id = 0;

dpnp/backend/extensions/rng/device/engine/engine_base.hpp renamed to dpnp/backend/extensions/rng/device/engine/base_engine.hpp

@@ -34,6 +34,7 @@ class EngineType {
 public:
     enum Type : std::uint8_t {
         MRG32k3a = 0,
+        MCG59,
         Base, // must be the last always
     };
 

dpnp/backend/extensions/rng/device/engine/builder/base.hpp renamed to dpnp/backend/extensions/rng/device/engine/builder/base_builder.hpp

@@ -25,7 +25,11 @@
 
 #pragma once
 
-#include "engine_base.hpp"
+#include "base_engine.hpp"
+
+// TODO: remove the include once issue in MKL is resolved
+#include <oneapi/mkl/rng/device.hpp>
+namespace mkl_rng_dev = oneapi::mkl::rng::device;
 
 
 namespace dpnp::backend::ext::rng::device::engine::builder
@@ -71,7 +75,13 @@ class BaseBuilder {
     {
         switch (no_of_seeds) {
             case 1: {
-                return EngineT({seeds[0]}, {offsets[0]});
+                if constexpr (std::is_same_v<EngineT, mkl_rng_dev::mcg59<8>>) {
+                    // issue with mcg59<>() constructor which breaks compilation
+                    return EngineT(seeds[0], offsets[0]);
+                }
+                else {
+                    return EngineT({seeds[0]}, offsets[0]);
+                }
             }
             // TODO: implement full switch
             default:
@@ -84,7 +94,13 @@ class BaseBuilder {
     {
         switch (no_of_seeds) {
             case 1: {
-                return EngineT({seeds[0]}, offset);
+                if constexpr (std::is_same_v<EngineT, mkl_rng_dev::mcg59<8>>) {
+                    // issue with mcg59<>() constructor which breaks compilation
+                    return EngineT(seeds[0], offsets[0]);
+                }
+                else {
+                    return EngineT({seeds[0]}, {offset});
+                }
             }
             // TODO: implement full switch
             default:

dpnp/backend/extensions/rng/device/engine/builder/mcg31m1.hpp

@@ -27,8 +27,8 @@
 
 #include <oneapi/mkl/rng/device.hpp>
 
-#include "engine_base.hpp"
-#include "base.hpp"
+#include "base_engine.hpp"
+#include "base_builder.hpp"
 
 namespace dpnp::backend::ext::rng::device::engine::builder
 {

dpnp/backend/extensions/rng/device/engine/builder/mcg59.hpp

@@ -27,8 +27,8 @@
 
 #include <oneapi/mkl/rng/device.hpp>
 
-#include "engine_base.hpp"
-#include "base.hpp"
+#include "base_engine.hpp"
+#include "base_builder.hpp"
 
 namespace dpnp::backend::ext::rng::device::engine::builder
 {

dpnp/backend/extensions/rng/device/engine/builder/mrg32k3a.hpp

@@ -27,8 +27,8 @@
 
 #include <oneapi/mkl/rng/device.hpp>
 
-#include "engine_base.hpp"
-#include "base.hpp"
+#include "base_engine.hpp"
+#include "base_builder.hpp"
 
 namespace dpnp::backend::ext::rng::device::engine::builder
 {

dpnp/backend/extensions/rng/device/engine/builder/philox4x32x10.hpp

@@ -27,8 +27,8 @@
 
 #include <oneapi/mkl/rng/device.hpp>
 
-#include "engine_base.hpp"
-#include "base.hpp"
+#include "base_engine.hpp"
+#include "base_builder.hpp"
 
 namespace dpnp::backend::ext::rng::device::engine::builder
 {

dpnp/backend/extensions/rng/device/engine/mcg59_engine.hpp

@@ -0,0 +1,61 @@
+//*****************************************************************************
+// Copyright (c) 2024, Intel Corporation
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+// - Redistributions of source code must retain the above copyright notice,
+//   this list of conditions and the following disclaimer.
+// - Redistributions in binary form must reproduce the above copyright notice,
+//   this list of conditions and the following disclaimer in the documentation
+//   and/or other materials provided with the distribution.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+// THE POSSIBILITY OF SUCH DAMAGE.
+//*****************************************************************************
+
+#pragma once
+
+#include "base_engine.hpp"
+
+
+namespace dpnp::backend::ext::rng::device::engine
+{
+class MCG59 : public EngineBase {
+private:
+    sycl::queue q_;
+    std::vector<std::uint64_t> seed_vec;
+    std::vector<std::uint64_t> offset_vec;
+
+public:
+    MCG59(sycl::queue &q, std::uint32_t seed, std::uint64_t offset = 0) : q_(q) {
+        seed_vec.push_back(seed);
+        offset_vec.push_back(offset);
+    }
+
+    sycl::queue &get_queue() override {
+        return q_;
+    }
+
+    virtual EngineType get_type() const noexcept override {
+        return EngineType::MCG59;
+    }
+
+    virtual std::vector<std::uint64_t> get_seeds() const noexcept override {
+        return seed_vec;
+    }
+
+    virtual std::vector<std::uint64_t> get_offsets() const noexcept override {
+        return offset_vec;
+    }
+};
+} // dpnp::backend::ext::rng::device::engine

dpnp/backend/extensions/rng/device/engine/mrg32k3a_engine.hpp

@@ -25,7 +25,7 @@
 
 #pragma once
 
-#include "engine_base.hpp"
+#include "base_engine.hpp"
 
 
 namespace dpnp::backend::ext::rng::device::engine

dpnp/backend/extensions/rng/device/gaussian.cpp

@@ -36,7 +36,7 @@
 #include "common_impl.hpp"
 #include "gaussian.hpp"
 
-#include "engine/engine_base.hpp"
+#include "engine/base_engine.hpp"
 #include "engine/builder/builder.hpp"
 
 #include "dispatch/matrix.hpp"