Homec4science
Diffusion SpecMiCP / ReactMiCP (chloride) Browse

specmicp/src/specmicp_common/io/hdf5_eigen.hpp
d4e389fc2ce0chloride

Last Change
Raw File

hdf5_eigen.hpp
View Options

/* =============================================================================
Copyright (c) 2014 - 2016
F. Georget <fabieng@princeton.edu> Princeton University
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
============================================================================= */
#ifndef SPECMICP_IO_HDF5_EIGEN_HPP
#define SPECMICP_IO_HDF5_EIGEN_HPP
//! \file io/hdf5_eigen.hpp
//! \brief Save Eigen matrix to hdf5 format
#include "specmicp_common/types.hpp"
namespace H5 {
class DataSet;
class Group;
} //end namespace H5
namespace specmicp {
namespace io {
class HDF5File;
//! \brief Save an Eigen matrix as 'name' into 'section' in the HDF5 file 'file'
template <typename Derived>
std::unique_ptr<H5::DataSet> save_eigen_matrix(
HDF5File& file,
const std::string& name,
const std::string& section,
const Eigen::DenseBase<Derived>& matrix
);
//! \brief Save an Eigen matrix as 'name' into 'section' in the HDF5 file 'file'
template <typename Derived>
std::unique_ptr<H5::DataSet> save_eigen_matrix(
H5::Group& group,
const std::string& name,
const Eigen::DenseBase<Derived>& matrix
);
//! \brief Read an Eigen matrix 'name' into 'section' in the HDF5 file 'file'
template <typename Derived>
int read_eigen_matrix(
const HDF5File& file,
const std::string& name,
const std::string& section,
Eigen::DenseBase<Derived>& matrix
);
//! \brief Read an Eigen matrix from the given group
template <typename Derived>
int read_eigen_matrix(
const H5::Group& group,
const std::string& name,
Eigen::DenseBase<Derived>& matrix
);
//! \brief Read an Eigen matrix from the given dataset
template <typename Derived>
int read_eigen_matrix(
const H5::DataSet& dataset,
Eigen::DenseBase<Derived>& matrix
);
} //end namespace io
} //end namespace specmicp
#include "hdf5_eigen.inl"
#endif // SPECMICP_IO_HDF5_EIGEN_HPP
c4science · Help