MatrixSerialization.h

Go to the documentation of this file.

/* ----------------------------------------------------------------------------
 
 * GTSAM Copyright 2010, Georgia Tech Research Corporation,
 * Atlanta, Georgia 30332-0415
 * All Rights Reserved
 * Authors: Frank Dellaert, et al. (see THANKS for the full author list)
 
 * See LICENSE for the license information
 
 * -------------------------------------------------------------------------- */
 
// \callgraph
 
// Defined only if boost serialization is enabled
#if GTSAM_ENABLE_BOOST_SERIALIZATION
#pragma once
 
#include <gtsam/base/Matrix.h>
 
#include <Eigen/Sparse>
#include <boost/serialization/array.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/split_free.hpp>
 
namespace boost {
namespace serialization {
 
// split version - sends sizes ahead
template <class Archive, typename Scalar_, int Rows_, int Cols_, int Ops_,
          int MaxRows_, int MaxCols_>
void save(
    Archive& ar,
    const Eigen::Matrix<Scalar_, Rows_, Cols_, Ops_, MaxRows_, MaxCols_>& m,
    const unsigned int /*version*/) {
  const size_t rows = m.rows(), cols = m.cols();
  ar << BOOST_SERIALIZATION_NVP(rows);
  ar << BOOST_SERIALIZATION_NVP(cols);
  ar << make_nvp("data", make_array(m.data(), m.size()));
}
 
template <class Archive, typename Scalar_, int Rows_, int Cols_, int Ops_,
          int MaxRows_, int MaxCols_>
void load(Archive& ar,
          Eigen::Matrix<Scalar_, Rows_, Cols_, Ops_, MaxRows_, MaxCols_>& m,
          const unsigned int /*version*/) {
  size_t rows, cols;
  ar >> BOOST_SERIALIZATION_NVP(rows);
  ar >> BOOST_SERIALIZATION_NVP(cols);
  m.resize(rows, cols);
  ar >> make_nvp("data", make_array(m.data(), m.size()));
}
 
// templated version of BOOST_SERIALIZATION_SPLIT_FREE(Eigen::Matrix);
template <class Archive, typename Scalar_, int Rows_, int Cols_, int Ops_,
          int MaxRows_, int MaxCols_>
void serialize(
    Archive& ar,
    Eigen::Matrix<Scalar_, Rows_, Cols_, Ops_, MaxRows_, MaxCols_>& m,
    const unsigned int version) {
  split_free(ar, m, version);
}
 
// specialized to Matrix for MATLAB wrapper
template <class Archive>
void serialize(Archive& ar, gtsam::Matrix& m, const unsigned int version) {
  split_free(ar, m, version);
}
 
/******************************************************************************/
template <class Archive, typename _Scalar, int _Options, typename _Index>
void save(Archive& ar, const Eigen::SparseVector<_Scalar, _Options, _Index>& m,
          const unsigned int /*version*/) {
  _Index size = m.size();
 
  std::vector<std::pair<Eigen::Index, _Scalar>> data;
  for (typename Eigen::SparseVector<_Scalar, _Options, _Index>::InnerIterator
           it(m);
       it; ++it)
    data.push_back({it.index(), it.value()});
 
  ar << BOOST_SERIALIZATION_NVP(size);
  ar << BOOST_SERIALIZATION_NVP(data);
}
 
template <class Archive, typename _Scalar, int _Options, typename _Index>
void load(Archive& ar, Eigen::SparseVector<_Scalar, _Options, _Index>& m,
          const unsigned int /*version*/) {
  _Index size;
  ar >> BOOST_SERIALIZATION_NVP(size);
  m.resize(size);
 
  std::vector<std::pair<Eigen::Index, _Scalar>> data;
  ar >> BOOST_SERIALIZATION_NVP(data);
 
  for (auto&& d : data) {
    m.coeffRef(d.first) = d.second;
  }
}
 
template <class Archive, typename _Scalar, int _Options, typename _Index>
void serialize(Archive& ar, Eigen::SparseVector<_Scalar, _Options, _Index>& m,
               const unsigned int version) {
  split_free(ar, m, version);
}
/******************************************************************************/
 
}  // namespace serialization
}  // namespace boost
#endif