Update to include comment when convert MM -> Binsparse

Author: BenBrock

examples/convert_binsparse.cpp

@@ -5,16 +5,18 @@
 
 template <typename T, typename I>
 void convert_to_binsparse(std::string input_file, std::string output_file, std::string format, std::string comment) {
+  nlohmann::json user_keys;
+  user_keys["comment"] = comment;
   if (format == "CSR") {
     std::cout << "Reading in " << input_file << "...\n";
     auto x = binsparse::__detail::mmread<T, I, binsparse::__detail::csr_matrix_owning<T, I>>(input_file);
     binsparse::csr_matrix<T, I> matrix{x.values().data(), x.colind().data(), x.rowptr().data(), std::get<0>(x.shape()), std::get<1>(x.shape()), I(x.size())};
-    binsparse::write_csr_matrix(output_file, matrix);
+    binsparse::write_csr_matrix(output_file, matrix, user_keys);
     std::cout << "Writing to binsparse file " << output_file << " using " << format << " format...\n";
   } else {
     auto x = binsparse::__detail::mmread<T, I, binsparse::__detail::coo_matrix_owning<T, I>>(input_file);
     binsparse::coo_matrix<T, I> matrix{x.values().data(), x.rowind().data(), x.colind().data(), std::get<0>(x.shape()), std::get<1>(x.shape()), I(x.size())};
-    binsparse::write_coo_matrix(output_file, matrix);
+    binsparse::write_coo_matrix(output_file, matrix, user_keys);
     std::cout << "Writing to binsparse file " << output_file << " using " << format << " format...\n";
   }
 }

examples/inspect_binsparse.cpp

@@ -2,6 +2,9 @@
 #include <iostream>
 #include <concepts>
 #include <complex>
+#include <ranges>
+
+class Foo {};
 
 int main(int argc, char** argv) {
 
@@ -13,6 +16,7 @@ int main(int argc, char** argv) {
   std::string input_file(argv[1]);
 
   auto j = binsparse::inspect(input_file);
+
   auto metadata = j["binsparse"];
 
   std::cout << "Inspecting Binsparse v" << metadata["version"] << " file...\n";
@@ -30,14 +34,26 @@ int main(int argc, char** argv) {
     auto i0 = metadata["data_types"]["pointers_to_1"];
     auto i1 = metadata["data_types"]["indices_1"];
     auto t = metadata["data_types"]["values"];
-    std::cout << "Stored using index types: " << i0 << " " << i1 << std::endl;
-    std::cout << "Value type: " << t << std::endl;
+    std::cout << "Stored using index types: " << i0 << " " << i1 << " and "
+              << "value type: " << t << std::endl;
   } else {
     assert(false);
   }
 
-  std::cout << "Raw JSON:\n";
-  std::cout << j.dump(2) << std::endl;
+  
+  nlohmann::json user;
+  std::cout << "User-provided keys:\n";
+  std::size_t n_keys = 0;
+  for (auto&& v : j.items()) {
+    if (v.key() != "binsparse") {
+      user[v.key()] = v.value();
+      n_keys++;
+    }
+  }
+
+  if (n_keys > 0) {
+    std::cout << user.dump(2) << std::endl;
+  }
 
   return 0;
 }

include/binsparse/binsparse.hpp

@@ -19,7 +19,8 @@ namespace binsparse {
 
 template <typename T, typename I>
 void write_csr_matrix(std::string fname,
-                      csr_matrix<T, I> m) {
+                      csr_matrix<T, I> m,
+                      nlohmann::json user_keys = {}) {
 
   H5::H5File f(fname.c_str(), H5F_ACC_TRUNC);
 
@@ -41,6 +42,10 @@ void write_csr_matrix(std::string fname,
   j["binsparse"]["data_types"]["indices_1"] = type_info<I>::label();
   j["binsparse"]["data_types"]["values"] = type_info<T>::label();
 
+  for (auto&& v : user_keys.items()) {
+    j[v.key()] = v.value();
+  }
+
   hdf5_tools::write_dataset(f, "metadata", j.dump(2));
 
   f.close();
@@ -82,7 +87,8 @@ csr_matrix<T, I> read_csr_matrix(std::string fname) {
 
 template <typename T, typename I>
 void write_coo_matrix(std::string fname,
-                      coo_matrix<T, I> m) {
+                      coo_matrix<T, I> m,
+                      nlohmann::json user_keys = {}) {
 
   H5::H5File f(fname.c_str(), H5F_ACC_TRUNC);
 
@@ -103,6 +109,10 @@ void write_coo_matrix(std::string fname,
   j["binsparse"]["data_types"]["indices_0"] = type_info<I>::label();
   j["binsparse"]["data_types"]["indices_1"] = type_info<I>::label();
   j["binsparse"]["data_types"]["values"] = type_info<T>::label();
+  
+  for (auto&& v : user_keys.items()) {
+    j[v.key()] = v.value();
+  }
 
   hdf5_tools::write_dataset(f, "metadata", j.dump(2));