Added preliminary support for the xNRM2 routines

4 files changed, 132 insertions, 15 deletions

diff --git a/test/routines/level1/xdot.h b/test/routines/level1/xdot.h
index bfcfdaff..04669f52 100644
--- a/test/routines/level1/xdot.h
+++ b/test/routines/level1/xdot.h
@@ -54,7 +54,7 @@ class TestXdot {
   static void SetSizes(Arguments<T> &args) {
     args.x_size = GetSizeX(args);
     args.y_size = GetSizeY(args);
-    args.dot_size = GetSizeDot(args);
+    args.scalar_size = GetSizeDot(args);
   }
 
   // Describes what the default values of the leading dimensions of the matrices are
@@ -72,7 +72,7 @@ class TestXdot {
     auto queue_plain = queue();
     auto event = cl_event{};
     auto status = Dot<T>(args.n,
-                         buffers.dot(), args.dot_offset,
+                         buffers.scalar(), args.dot_offset,
                          buffers.x_vec(), args.x_offset, args.x_inc,
                          buffers.y_vec(), args.y_offset, args.y_inc,
                          &queue_plain, &event);
@@ -85,7 +85,7 @@ class TestXdot {
     auto queue_plain = queue();
     auto event = cl_event{};
     auto status = clblasXdot<T>(args.n,
-                                buffers.dot(), args.dot_offset,
+                                buffers.scalar(), args.dot_offset,
                                 buffers.x_vec(), args.x_offset, args.x_inc,
                                 buffers.y_vec(), args.y_offset, args.y_inc,
                                 1, &queue_plain, 0, nullptr, &event);
@@ -95,8 +95,8 @@ class TestXdot {
 
   // Describes how to download the results of the computation (more importantly: which buffer)
   static std::vector<T> DownloadResult(const Arguments<T> &args, Buffers<T> &buffers, Queue &queue) {
-    std::vector<T> result(args.dot_size, static_cast<T>(0));
-    buffers.dot.Read(queue, args.dot_size, result);
+    std::vector<T> result(args.scalar_size, static_cast<T>(0));
+    buffers.scalar.Read(queue, args.scalar_size, result);
     return result;
   }
 
diff --git a/test/routines/level1/xdotc.h b/test/routines/level1/xdotc.h
index e403ba4c..e5b42ef4 100644
--- a/test/routines/level1/xdotc.h
+++ b/test/routines/level1/xdotc.h
@@ -54,7 +54,7 @@ class TestXdotc {
   static void SetSizes(Arguments<T> &args) {
     args.x_size = GetSizeX(args);
     args.y_size = GetSizeY(args);
-    args.dot_size = GetSizeDot(args);
+    args.scalar_size = GetSizeDot(args);
   }
 
   // Describes what the default values of the leading dimensions of the matrices are
@@ -72,7 +72,7 @@ class TestXdotc {
     auto queue_plain = queue();
     auto event = cl_event{};
     auto status = Dotc<T>(args.n,
-                          buffers.dot(), args.dot_offset,
+                          buffers.scalar(), args.dot_offset,
                           buffers.x_vec(), args.x_offset, args.x_inc,
                           buffers.y_vec(), args.y_offset, args.y_inc,
                           &queue_plain, &event);
@@ -85,7 +85,7 @@ class TestXdotc {
     auto queue_plain = queue();
     auto event = cl_event{};
     auto status = clblasXdotc<T>(args.n,
-                                 buffers.dot(), args.dot_offset,
+                                 buffers.scalar(), args.dot_offset,
                                  buffers.x_vec(), args.x_offset, args.x_inc,
                                  buffers.y_vec(), args.y_offset, args.y_inc,
                                  1, &queue_plain, 0, nullptr, &event);
@@ -95,8 +95,8 @@ class TestXdotc {
 
   // Describes how to download the results of the computation (more importantly: which buffer)
   static std::vector<T> DownloadResult(const Arguments<T> &args, Buffers<T> &buffers, Queue &queue) {
-    std::vector<T> result(args.dot_size, static_cast<T>(0));
-    buffers.dot.Read(queue, args.dot_size, result);
+    std::vector<T> result(args.scalar_size, static_cast<T>(0));
+    buffers.scalar.Read(queue, args.scalar_size, result);
     return result;
   }
 
diff --git a/test/routines/level1/xdotu.h b/test/routines/level1/xdotu.h
index 8b2c65a8..6430148c 100644
--- a/test/routines/level1/xdotu.h
+++ b/test/routines/level1/xdotu.h
@@ -54,7 +54,7 @@ class TestXdotu {
   static void SetSizes(Arguments<T> &args) {
     args.x_size = GetSizeX(args);
     args.y_size = GetSizeY(args);
-    args.dot_size = GetSizeDot(args);
+    args.scalar_size = GetSizeDot(args);
   }
 
   // Describes what the default values of the leading dimensions of the matrices are
@@ -72,7 +72,7 @@ class TestXdotu {
     auto queue_plain = queue();
     auto event = cl_event{};
     auto status = Dotu<T>(args.n,
-                          buffers.dot(), args.dot_offset,
+                          buffers.scalar(), args.dot_offset,
                           buffers.x_vec(), args.x_offset, args.x_inc,
                           buffers.y_vec(), args.y_offset, args.y_inc,
                           &queue_plain, &event);
@@ -85,7 +85,7 @@ class TestXdotu {
     auto queue_plain = queue();
     auto event = cl_event{};
     auto status = clblasXdotu<T>(args.n,
-                                 buffers.dot(), args.dot_offset,
+                                 buffers.scalar(), args.dot_offset,
                                  buffers.x_vec(), args.x_offset, args.x_inc,
                                  buffers.y_vec(), args.y_offset, args.y_inc,
                                  1, &queue_plain, 0, nullptr, &event);
@@ -95,8 +95,8 @@ class TestXdotu {
 
   // Describes how to download the results of the computation (more importantly: which buffer)
   static std::vector<T> DownloadResult(const Arguments<T> &args, Buffers<T> &buffers, Queue &queue) {
-    std::vector<T> result(args.dot_size, static_cast<T>(0));
-    buffers.dot.Read(queue, args.dot_size, result);
+    std::vector<T> result(args.scalar_size, static_cast<T>(0));
+    buffers.scalar.Read(queue, args.scalar_size, result);
     return result;
   }
 
diff --git a/test/routines/level1/xnrm2.h b/test/routines/level1/xnrm2.h
new file mode 100644
index 00000000..e3f77ee4
--- /dev/null
+++ b/test/routines/level1/xnrm2.h
@@ -0,0 +1,117 @@
+
+// =================================================================================================
+// 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 a class with static methods to describe the Xnrm2 routine. Examples of
+// such 'descriptions' are how to calculate the size a of buffer or how to run the routine. These
+// static methods are used by the correctness tester and the performance tester.
+//
+// =================================================================================================
+
+#ifndef CLBLAST_TEST_ROUTINES_XNRM2_H_
+#define CLBLAST_TEST_ROUTINES_XNRM2_H_
+
+#include <vector>
+#include <string>
+
+#include "wrapper_clblas.h"
+
+namespace clblast {
+// =================================================================================================
+
+// See comment at top of file for a description of the class
+template <typename T>
+class TestXnrm2 {
+ public:
+
+  // The BLAS level: 1, 2, or 3
+  static size_t BLASLevel() { return 1; }
+
+  // The list of arguments relevant for this routine
+  static std::vector<std::string> GetOptions() {
+    return {kArgN,
+            kArgXInc,
+            kArgXOffset, kArgNrm2Offset};
+  }
+
+  // Describes how to obtain the sizes of the buffers
+  static size_t GetSizeX(const Arguments<T> &args) {
+    return args.n * args.x_inc + args.x_offset;
+  }
+  static size_t GetSizeNrm2(const Arguments<T> &args) {
+    return 1 + args.nrm2_offset;
+  }
+
+  // Describes how to set the sizes of all the buffers
+  static void SetSizes(Arguments<T> &args) {
+    args.x_size = GetSizeX(args);
+    args.scalar_size = GetSizeNrm2(args);
+  }
+
+  // Describes what the default values of the leading dimensions of the matrices are
+  static size_t DefaultLDA(const Arguments<T> &) { return 1; } // N/A for this routine
+  static size_t DefaultLDB(const Arguments<T> &) { return 1; } // N/A for this routine
+  static size_t DefaultLDC(const Arguments<T> &) { return 1; } // N/A for this routine
+
+  // Describes which transpose options are relevant for this routine
+  using Transposes = std::vector<Transpose>;
+  static Transposes GetATransposes(const Transposes &) { return {}; } // N/A for this routine
+  static Transposes GetBTransposes(const Transposes &) { return {}; } // N/A for this routine
+
+  // Describes how to run the CLBlast routine
+  static StatusCode RunRoutine(const Arguments<T> &args, const Buffers<T> &buffers, Queue &queue) {
+    auto queue_plain = queue();
+    auto event = cl_event{};
+    auto status = Nrm2<T>(args.n,
+                          buffers.scalar(), args.nrm2_offset,
+                          buffers.x_vec(), args.x_offset, args.x_inc,
+                          &queue_plain, &event);
+    clWaitForEvents(1, &event);
+    return status;
+  }
+
+  // Describes how to run the clBLAS routine (for correctness/performance comparison)
+  static StatusCode RunReference(const Arguments<T> &args, const Buffers<T> &buffers, Queue &queue) {
+    auto queue_plain = queue();
+    auto event = cl_event{};
+    auto status = clblasXnrm2<T>(args.n,
+                                 buffers.scalar(), args.nrm2_offset,
+                                 buffers.x_vec(), args.x_offset, args.x_inc,
+                                 1, &queue_plain, 0, nullptr, &event);
+    clWaitForEvents(1, &event);
+    return static_cast<StatusCode>(status);
+  }
+
+  // Describes how to download the results of the computation (more importantly: which buffer)
+  static std::vector<T> DownloadResult(const Arguments<T> &args, Buffers<T> &buffers, Queue &queue) {
+    std::vector<T> result(args.scalar_size, static_cast<T>(0));
+    buffers.scalar.Read(queue, args.scalar_size, result);
+    return result;
+  }
+
+  // Describes how to compute the indices of the result buffer
+  static size_t ResultID1(const Arguments<T> &) { return 1; } // N/A for this routine
+  static size_t ResultID2(const Arguments<T> &) { return 1; } // N/A for this routine
+  static size_t GetResultIndex(const Arguments<T> &args, const size_t, const size_t) {
+    return args.nrm2_offset;
+  }
+
+  // Describes how to compute performance metrics
+  static size_t GetFlops(const Arguments<T> &args) {
+    return 2 * args.n;
+  }
+  static size_t GetBytes(const Arguments<T> &args) {
+    return ((args.n) + 1) * sizeof(T);
+  }
+};
+
+// =================================================================================================
+} // namespace clblast
+
+// CLBLAST_TEST_ROUTINES_XNRM2_H_
+#endif