Created the API and stubs for the HAD (hadamard-product) routines

3 files changed, 102 insertions, 0 deletions

diff --git a/src/routines/levelx/xhad.cpp b/src/routines/levelx/xhad.cpp
new file mode 100644
index 00000000..46ae8031
--- /dev/null
+++ b/src/routines/levelx/xhad.cpp
@@ -0,0 +1,60 @@
+
+// =================================================================================================
+// This file is part of the CLBlast project. The project is licensed under Apache Version 2.0. This
+// project loosely follows the Google C++ styleguide and uses a tab-size of two spaces and a max-
+// width of 100 characters per line.
+//
+// Author(s):
+//   Cedric Nugteren <www.cedricnugteren.nl>
+//
+// This file implements the Xhad class (see the header for information about the class).
+//
+// =================================================================================================
+
+#include "routines/levelx/xhad.hpp"
+
+#include <string>
+#include <vector>
+
+namespace clblast {
+// =================================================================================================
+
+// Constructor: forwards to base class constructor
+template <typename T>
+Xhad<T>::Xhad(Queue &queue, EventPointer event, const std::string &name):
+    Routine(queue, event, name, {"Xaxpy"}, PrecisionValue<T>(), {}, {
+#include "../../kernels/level1/level1.opencl"
+#include "../../kernels/level1/xaxpy.opencl"
+    }) {
+}
+
+// =================================================================================================
+
+// The main routine
+template <typename T>
+void Xhad<T>::DoHad(const size_t n, const T alpha,
+                    const Buffer<T> &x_buffer, const size_t x_offset, const size_t x_inc,
+                    const Buffer<T> &y_buffer, const size_t y_offset, const size_t y_inc, const T beta,
+                    const Buffer<T> &z_buffer, const size_t z_offset, const size_t z_inc) {
+
+  // Makes sure all dimensions are larger than zero
+  if (n == 0) { throw BLASError(StatusCode::kInvalidDimension); }
+
+  // Tests the vectors for validity
+  TestVectorX(n, x_buffer, x_offset, x_inc);
+  TestVectorY(n, y_buffer, y_offset, y_inc);
+  TestVectorY(n, z_buffer, z_offset, z_inc); // TODO: Make a TestVectorZ function with error codes
+
+}
+
+// =================================================================================================
+
+// Compiles the templated class
+template class Xhad<half>;
+template class Xhad<float>;
+template class Xhad<double>;
+template class Xhad<float2>;
+template class Xhad<double2>;
+
+// =================================================================================================
+} // namespace clblast
diff --git a/src/routines/levelx/xhad.hpp b/src/routines/levelx/xhad.hpp
new file mode 100644
index 00000000..eb3e1c3e
--- /dev/null
+++ b/src/routines/levelx/xhad.hpp
@@ -0,0 +1,41 @@
+
+// =================================================================================================
+// This file is part of the CLBlast project. The project is licensed under Apache Version 2.0. This
+// project loosely follows the Google C++ styleguide and uses a tab-size of two spaces and a max-
+// width of 100 characters per line.
+//
+// Author(s):
+//   Cedric Nugteren <www.cedricnugteren.nl>
+//
+// This file implements the Xhad routine. The precision is implemented using a template argument.
+//
+// =================================================================================================
+
+#ifndef CLBLAST_ROUTINES_XHAD_H_
+#define CLBLAST_ROUTINES_XHAD_H_
+
+#include "routine.hpp"
+
+namespace clblast {
+// =================================================================================================
+
+// See comment at top of file for a description of the class
+template <typename T>
+class Xhad: public Routine {
+public:
+
+  // Constructor
+  Xhad(Queue &queue, EventPointer event, const std::string &name = "HAD");
+
+  // Templated-precision implementation of the routine
+  void DoHad(const size_t n, const T alpha,
+             const Buffer<T> &x_buffer, const size_t x_offset, const size_t x_inc,
+             const Buffer<T> &y_buffer, const size_t y_offset, const size_t y_inc, const T beta,
+             const Buffer<T> &z_buffer, const size_t z_offset, const size_t z_inc);
+};
+
+// =================================================================================================
+} // namespace clblast
+
+// CLBLAST_ROUTINES_XHAD_H_
+#endif
diff --git a/src/routines/routines.hpp b/src/routines/routines.hpp
index 0aeff707..2ab16a75 100644
--- a/src/routines/routines.hpp
+++ b/src/routines/routines.hpp
@@ -67,6 +67,7 @@
 #include "routines/level3/xtrsm.hpp"
 
 // Level-x includes (non-BLAS)
+#include "routines/levelx/xhad.hpp"
 #include "routines/levelx/xomatcopy.hpp"
 #include "routines/levelx/xim2col.hpp"
 #include "routines/levelx/xaxpybatched.hpp"