H5Easy_Eigen.hpp

Go to the documentation of this file.

/*
 *  Copyright (c), 2017, Adrien Devresse <adrien.devresse@epfl.ch>
 *
 *  Distributed under the Boost Software License, Version 1.0.
 *    (See accompanying file LICENSE_1_0.txt or copy at
 *          http://www.boost.org/LICENSE_1_0.txt)
 *
 */
#pragma once
 
#include "../H5Easy.hpp"
#include "H5Easy_misc.hpp"
#include "H5Easy_scalar.hpp"
 
#ifdef H5_USE_EIGEN
 
namespace H5Easy {
 
namespace detail {
 
template <typename T>
struct io_impl<T, typename std::enable_if<std::is_base_of<Eigen::DenseBase<T>, T>::value>::type> {
    // abbreviate row-major <-> col-major conversions
    template <typename S>
    struct types {
        using row_major = Eigen::Ref<
            const Eigen::Array<typename std::decay<T>::type::Scalar,
                               std::decay<T>::type::RowsAtCompileTime,
                               std::decay<T>::type::ColsAtCompileTime,
                               std::decay<T>::type::ColsAtCompileTime == 1 ? Eigen::ColMajor
                                                                           : Eigen::RowMajor,
                               std::decay<T>::type::MaxRowsAtCompileTime,
                               std::decay<T>::type::MaxColsAtCompileTime>,
            0,
            Eigen::InnerStride<1>>;
 
        using col_major =
            Eigen::Map<Eigen::Array<typename std::decay<T>::type::Scalar,
                                    std::decay<T>::type::RowsAtCompileTime,
                                    std::decay<T>::type::ColsAtCompileTime,
                                    std::decay<T>::type::ColsAtCompileTime == 1 ? Eigen::ColMajor
                                                                                : Eigen::RowMajor,
                                    std::decay<T>::type::MaxRowsAtCompileTime,
                                    std::decay<T>::type::MaxColsAtCompileTime>>;
    };
 
    // return the shape of Eigen::DenseBase<T> object as size 1 or 2 "std::vector<size_t>"
    inline static std::vector<size_t> shape(const T& data) {
        if (std::decay<T>::type::RowsAtCompileTime == 1) {
            return {static_cast<size_t>(data.cols())};
        }
        if (std::decay<T>::type::ColsAtCompileTime == 1) {
            return {static_cast<size_t>(data.rows())};
        }
        return {static_cast<size_t>(data.rows()), static_cast<size_t>(data.cols())};
    }
 
    using EigenIndex = Eigen::DenseIndex;
 
    // get the shape of a "DataSet" as size 2 "std::vector<Eigen::Index>"
    template <class D>
    inline static std::vector<EigenIndex> shape(const File& file,
                                                const std::string& path,
                                                const D& dataset,
                                                int RowsAtCompileTime) {
        std::vector<size_t> dims = dataset.getDimensions();
 
        if (dims.size() == 1 && RowsAtCompileTime == 1) {
            return std::vector<EigenIndex>{1u, static_cast<EigenIndex>(dims[0])};
        }
        if (dims.size() == 1) {
            return std::vector<EigenIndex>{static_cast<EigenIndex>(dims[0]), 1u};
        }
        if (dims.size() == 2) {
            return std::vector<EigenIndex>{static_cast<EigenIndex>(dims[0]),
                                           static_cast<EigenIndex>(dims[1])};
        }
 
        throw detail::error(file, path, "H5Easy::load: Inconsistent rank");
    }
 
    inline static DataSet dump(File& file,
                               const std::string& path,
                               const T& data,
                               const DumpOptions& options) {
        using row_major_type = typename types<T>::row_major;
        using value_type = typename std::decay<T>::type::Scalar;
        row_major_type row_major(data);
        DataSet dataset = initDataset<value_type>(file, path, shape(data), options);
        dataset.write_raw(row_major.data());
        if (options.flush()) {
            file.flush();
        }
        return dataset;
    }
 
    inline static T load(const File& file, const std::string& path) {
        DataSet dataset = file.getDataSet(path);
        std::vector<typename T::Index> dims = shape(file, path, dataset, T::RowsAtCompileTime);
        T data(dims[0], dims[1]);
        dataset.read_raw(data.data());
        if (data.IsVectorAtCompileTime || data.IsRowMajor) {
            return data;
        }
        using col_major = typename types<T>::col_major;
        return col_major(data.data(), dims[0], dims[1]);
    }
 
    inline static Attribute dumpAttribute(File& file,
                                          const std::string& path,
                                          const std::string& key,
                                          const T& data,
                                          const DumpOptions& options) {
        using row_major_type = typename types<T>::row_major;
        using value_type = typename std::decay<T>::type::Scalar;
        row_major_type row_major(data);
        Attribute attribute = initAttribute<value_type>(file, path, key, shape(data), options);
        attribute.write_raw(row_major.data());
        if (options.flush()) {
            file.flush();
        }
        return attribute;
    }
 
    inline static T loadAttribute(const File& file,
                                  const std::string& path,
                                  const std::string& key) {
        DataSet dataset = file.getDataSet(path);
        Attribute attribute = dataset.getAttribute(key);
        DataSpace dataspace = attribute.getSpace();
        std::vector<typename T::Index> dims = shape(file, path, dataspace, T::RowsAtCompileTime);
        T data(dims[0], dims[1]);
        attribute.read_raw(data.data());
        if (data.IsVectorAtCompileTime || data.IsRowMajor) {
            return data;
        }
        using col_major = typename types<T>::col_major;
        return col_major(data.data(), dims[0], dims[1]);
    }
};
 
}  // namespace detail
}  // namespace H5Easy
 
#endif  // H5_USE_EIGEN