Added flatten and unflatten utils

Author: zfergus

src/finitediff.cpp

@@ -224,4 +224,27 @@ bool compare_hessian(
     return compare_jacobian(x, y, test_eps, msg);
 }
 
+// Flatten the matrix rowwise
+Eigen::VectorXd flatten(const Eigen::MatrixXd& X)
+{
+    Eigen::VectorXd x(X.size());
+    for (int i = 0; i < X.rows(); i++) {
+        for (int j = 0; j < X.cols(); j++) {
+            x(i * X.cols() + j) = X(i, j);
+        }
+    }
+    return x;
+}
+
+// Unflatten rowwise
+Eigen::MatrixXd unflatten(const Eigen::VectorXd& x, int dim)
+{
+    assert(x.size() % dim == 0);
+    Eigen::MatrixXd X(x.size() / dim, dim);
+    for (int i = 0; i < x.size(); i++) {
+        X(i / dim, i % dim) = x(i);
+    }
+    return X;
+}
+
 } // namespace fd

src/finitediff.hpp

@@ -118,4 +118,10 @@ bool compare_hessian(
     const double test_eps = 1e-4,
     const std::string& msg = "compare_hessian ");
 
+/// @brief Flatten the matrix rowwise
+Eigen::VectorXd flatten(const Eigen::MatrixXd& X);
+
+/// @brief Unflatten rowwise
+Eigen::MatrixXd unflatten(const Eigen::VectorXd& x, int dim);
+
 } // namespace fd

tests/CMakeLists.txt

@@ -8,6 +8,7 @@ add_executable(finitediff_tests
   test_gradient.cpp
   test_jacobian.cpp
   test_hessian.cpp
+  test_flatten.cpp
 )
 
 ################################################################################

tests/test_flatten.cpp

@@ -0,0 +1,12 @@
+#include <catch2/catch.hpp>
+
+#include <finitediff.hpp>
+
+using namespace fd;
+
+TEST_CASE("Flatten and unflatten", "[utils]")
+{
+    Eigen::MatrixXd X = Eigen::MatrixXd::Random(1000, 3);
+    Eigen::MatrixXd R = unflatten(flatten(X), X.cols());
+    CHECK(X == R);
+}