Add AmiVector / AmiVectorArray formatters (#2878)

Add formatting functions for AmiVector / AmiVectorArray for debugging purposes.

Author: dweindl

include/amici/vector.h

@@ -1,6 +1,7 @@
 #ifndef AMICI_VECTOR_H
 #define AMICI_VECTOR_H
 
+#include <ostream>
 #include <type_traits>
 #include <vector>
 
@@ -281,6 +282,23 @@ class AmiVector {
     void synchroniseNVector(SUNContext sunctx);
 };
 
+/**
+ * @brief Output formatter for AmiVector.
+ * @param os output stream
+ * @param v AmiVector to output
+ * @return os
+ */
+inline std::ostream& operator<<(std::ostream& os, AmiVector const& v) {
+    os << "[";
+    for (int i = 0; i < v.getLength(); ++i) {
+        if (i > 0)
+            os << ", ";
+        os << v.at(i);
+    }
+    os << "]";
+    return os;
+}
+
 /**
  * @brief AmiVectorArray class.
  *
@@ -436,6 +454,23 @@ class AmiVectorArray {
     std::vector<N_Vector> nvec_array_;
 };
 
+/**
+ * @brief Output formatter for AmiVectorArray.
+ * @param os output stream
+ * @param arr AmiVectorArray to output
+ * @return os
+ */
+inline std::ostream& operator<<(std::ostream& os, AmiVectorArray const& arr) {
+    os << "[";
+    for (int i = 0; i < arr.getLength(); ++i) {
+        if (i > 0)
+            os << ", ";
+        os << arr[i];
+    }
+    os << "]";
+    return os;
+}
+
 /**
  * @brief Computes z = a*x + b*y
  * @param a coefficient for x

tests/cpp/unittests/testMisc.cpp

@@ -526,6 +526,10 @@ TEST_F(AmiVectorTest, Vector)
     N_Vector nvec = av.getNVector();
     for (int i = 0; i < av.getLength(); ++i)
         ASSERT_EQ(av.at(i), NV_Ith_S(nvec, i));
+
+    std::stringstream ss;
+    ss << av;
+    ASSERT_EQ(ss.str(), "[1, 2, 4, 3]");
 }
 
 TEST_F(AmiVectorTest, VectorArray)
@@ -547,6 +551,10 @@ TEST_F(AmiVectorTest, VectorArray)
         for (int j = 0; j < av.getLength(); ++j)
             ASSERT_EQ(flattened.at(i * av.getLength() + j), av.at(j));
     }
+
+    std::stringstream ss;
+    ss << ava;
+    ASSERT_EQ(ss.str(), "[[1, 2, 4, 3], [4, 1, 2, 3], [4, 4, 2, 1]]");
 }
 
 class SunMatrixWrapperTest : public ::testing::Test {