Extend helper assert and print message on success (#383)

Can either take vector-like type or invokable comparison operator
codeplaysoftware · Dec 18, 2024 · 36710e3 · 36710e3
1 parent 62260d2
commit 36710e3
Show file tree

Hide file tree

Showing 23 changed files with 133 additions and 91 deletions.
diff --git a/Code_Exercises/Advanced_Data_Flow/solution.cpp b/Code_Exercises/Advanced_Data_Flow/solution.cpp
@@ -67,9 +67,7 @@ void test_buffer() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(out[i] == i * 4.0f);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(out, [](size_t i) { return i * 4.0f; });
 }
 
 void test_usm() {
@@ -118,9 +116,7 @@ void test_usm() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(out[i] == i * 4.0f);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(out, [](size_t i) { return i * 4.0f; });
 }
 
 int main() {

diff --git a/Code_Exercises/Advanced_Data_Flow/source.cpp b/Code_Exercises/Advanced_Data_Flow/source.cpp
@@ -73,7 +73,5 @@ int main() {
     out[i] = tmp[i] / 2.0f;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(out[i] == i * 4.0f);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(out, [](size_t i) { return i * 4.0f; });
 }
diff --git a/Code_Exercises/Asynchronous_Execution/solution.cpp b/Code_Exercises/Asynchronous_Execution/solution.cpp
@@ -61,9 +61,7 @@ void test_buffer_event_wait() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == i * 2);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2; });
 }
 
 void test_buffer_queue_wait() {
@@ -98,9 +96,7 @@ void test_buffer_queue_wait() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == i * 2);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2; });
 }
 
 void test_buffer_buffer_destruction() {
@@ -137,9 +133,7 @@ void test_buffer_buffer_destruction() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == i * 2);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2; });
 }
 
 void test_usm_event_wait() {
@@ -189,9 +183,7 @@ void test_usm_event_wait() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == i * 2);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2; });
 }
 
 void test_usm_queue_wait() {
@@ -239,9 +231,7 @@ void test_usm_queue_wait() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == i * 2);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2; });
 }
 
 void test_buffer_host_accessor() {
@@ -277,9 +267,7 @@ void test_buffer_host_accessor() {
       {
         auto hostAccR = bufR.get_host_access(sycl::read_only);  // Copy-to-host
 
-        for (int i = 0; i < dataSize; ++i) {
-          SYCLACADEMY_ASSERT(hostAccR[i] == i * 2);
-        }
+        SYCLACADEMY_ASSERT_EQUAL(hostAccR, [](size_t i) { return i * 2; });
       }
 
     }  // Copy-back

diff --git a/Code_Exercises/Asynchronous_Execution/source.cpp b/Code_Exercises/Asynchronous_Execution/source.cpp
@@ -48,12 +48,12 @@
 
 void test_usm() {
   // Use your code from the "Data Parallelism" exercise to start
-  SYCLACADEMY_ASSERT(true);
+  SYCLACADEMY_ASSERT_EQUAL(/*output data*/ 0, /*expected data*/ 0);
 }
 
 void test_buffer() {
   // Use your code from the "Data Parallelism" exercise to start
-  SYCLACADEMY_ASSERT(true);
+  SYCLACADEMY_ASSERT_EQUAL(/*output data*/ 0, /*expected data*/ 0);
 }
 
 int main() {

diff --git a/Code_Exercises/Data_Parallelism/solution.cpp b/Code_Exercises/Data_Parallelism/solution.cpp
@@ -48,7 +48,5 @@ int main() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == static_cast<float>(i) * 2.0f);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2.0f; });
 }
diff --git a/Code_Exercises/Data_Parallelism/source.cpp b/Code_Exercises/Data_Parallelism/source.cpp
@@ -56,7 +56,5 @@ int main() {
     r[i] = a[i] + b[i];
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == static_cast<float>(i) * 2.0f);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2.0f; });
 }
diff --git a/Code_Exercises/Data_and_Dependencies/solution.cpp b/Code_Exercises/Data_and_Dependencies/solution.cpp
@@ -89,9 +89,7 @@ void test_buffer() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(out[i] == i * 2.0f);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(out, [](size_t i) { return i * 2.0f; });
 }
 
 void test_usm() {
@@ -156,9 +154,7 @@ void test_usm() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(out[i] == i * 2.0f);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(out, [](size_t i) { return i * 2.0f; });
 }
 
 int main() {

diff --git a/Code_Exercises/Data_and_Dependencies/source.cpp b/Code_Exercises/Data_and_Dependencies/source.cpp
@@ -87,7 +87,5 @@ int main() {
     out[i] = inB[i] + inC[i];
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(out[i] == i * 2.0f);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(out, [](size_t i) { return i * 2.0f; });
 }
diff --git a/Code_Exercises/Device_Discovery/solution.cpp b/Code_Exercises/Device_Discovery/solution.cpp
@@ -68,5 +68,5 @@ int main() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  SYCLACADEMY_ASSERT(r == 42);
+  SYCLACADEMY_ASSERT_EQUAL(r, 42);
 }
diff --git a/Code_Exercises/Device_Discovery/source.cpp b/Code_Exercises/Device_Discovery/source.cpp
@@ -83,5 +83,5 @@ int main() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  SYCLACADEMY_ASSERT(r == 42);
+  SYCLACADEMY_ASSERT_EQUAL(r, 42);
 }
diff --git a/Code_Exercises/In_Order_Queue/solution_vector_add.cpp b/Code_Exercises/In_Order_Queue/solution_vector_add.cpp
@@ -89,9 +89,7 @@ void test_buffer() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(out[i] == i * 2.0f);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(out, [](size_t i) { return i * 2.0f; });
 }
 
 void test_usm() {
@@ -160,9 +158,7 @@ void test_usm() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(out[i] == i * 2.0f);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(out, [](size_t i) { return i * 2.0f; });
 }
 
 int main() {

diff --git a/Code_Exercises/In_Order_Queue/source_vector_add.cpp b/Code_Exercises/In_Order_Queue/source_vector_add.cpp
@@ -59,5 +59,5 @@
 
 int main() {
   // Use the "Data and Dependencies" exercise solution to start
-  SYCLACADEMY_ASSERT(true);
+  SYCLACADEMY_ASSERT_EQUAL(/*output data*/ 0, /*expected data*/ 0);
 }
diff --git a/Code_Exercises/Managing_Data/solution.cpp b/Code_Exercises/Managing_Data/solution.cpp
@@ -40,7 +40,7 @@ void test_usm() {
   sycl::free(dev_B, defaultQueue);
   sycl::free(dev_R, defaultQueue);
 
-  SYCLACADEMY_ASSERT(r == 42);
+  SYCLACADEMY_ASSERT_EQUAL(r, 42);
 }
 
 void test_buffer() {
@@ -65,7 +65,7 @@ void test_buffer() {
         .wait();
   }
 
-  SYCLACADEMY_ASSERT(r == 42);
+  SYCLACADEMY_ASSERT_EQUAL(r, 42);
 }
 
 int main() {

diff --git a/Code_Exercises/Managing_Data/source.cpp b/Code_Exercises/Managing_Data/source.cpp
@@ -53,7 +53,7 @@ void test_usm() {
   // Task: Compute a+b on the SYCL device using USM
   r = a + b;
 
-  SYCLACADEMY_ASSERT(r == 42);
+  SYCLACADEMY_ASSERT_EQUAL(r, 42);
 }
 
 void test_buffer() {
@@ -63,7 +63,7 @@ void test_buffer() {
   // accessor memory model
   r = a + b;
 
-  SYCLACADEMY_ASSERT(r == 42);
+  SYCLACADEMY_ASSERT_EQUAL(r, 42);
 }
 
 int main() {

diff --git a/Code_Exercises/Matrix_Transpose/solution.cpp b/Code_Exercises/Matrix_Transpose/solution.cpp
@@ -139,7 +139,5 @@ int main() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (auto i = 0; i < N * N; ++i) {
-    SYCLACADEMY_ASSERT(A_T[i] == A_T_comparison[i]);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(A_T, A_T_comparison);
 }
diff --git a/Code_Exercises/Matrix_Transpose/source.cpp b/Code_Exercises/Matrix_Transpose/source.cpp
@@ -82,7 +82,5 @@ int main() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (auto i = 0; i < N * N; ++i) {
-    SYCLACADEMY_ASSERT(A_T[i] == A_T_comparison[i]);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(A_T, A_T_comparison);
 }
diff --git a/Code_Exercises/Multiple_Devices/solution.cpp b/Code_Exercises/Multiple_Devices/solution.cpp
@@ -88,7 +88,5 @@ int main() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == static_cast<float>(i) * 2.0f);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2.0f; });
 }
diff --git a/Code_Exercises/Multiple_Devices/source.cpp b/Code_Exercises/Multiple_Devices/source.cpp
@@ -71,7 +71,5 @@ int main() {
     r[dataSizeFirst + i] = a[dataSizeFirst + i] + b[dataSizeFirst + i];
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == static_cast<float>(i) * 2.0f);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2.0f; });
 }
diff --git a/Code_Exercises/ND_Range_Kernel/solution.cpp b/Code_Exercises/ND_Range_Kernel/solution.cpp
@@ -49,9 +49,7 @@ void test_item() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == i * 2);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2; });
 }
 
 void test_nd_item() {
@@ -91,9 +89,7 @@ void test_nd_item() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == i * 2);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2; });
 }
 
 int main() {

diff --git a/Code_Exercises/ND_Range_Kernel/source.cpp b/Code_Exercises/ND_Range_Kernel/source.cpp
@@ -71,7 +71,5 @@ int main() {
     r[i] = a[i] + b[i];
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == i * 2);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2; });
 }
diff --git a/Code_Exercises/Using_USM/solution.cpp b/Code_Exercises/Using_USM/solution.cpp
@@ -62,7 +62,5 @@ int main() {
     std::cout << "Exception caught: " << e.what() << std::endl;
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == i * 2);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2.0f; });
 }
diff --git a/Code_Exercises/Using_USM/source.cpp b/Code_Exercises/Using_USM/source.cpp
@@ -26,7 +26,5 @@ int main() {
     r[i] = a[i] + b[i];
   }
 
-  for (int i = 0; i < dataSize; ++i) {
-    SYCLACADEMY_ASSERT(r[i] == i * 2);
-  }
+  SYCLACADEMY_ASSERT_EQUAL(r, [](size_t i) { return i * 2.0f; });
 }