H5DataSpace.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)
 *
 */
#ifndef H5DATASPACE_HPP
#define H5DATASPACE_HPP
 
#include <vector>
#include <array>
#include <cstdint>
#include <type_traits>
#include <initializer_list>
 
#ifdef H5_USE_BOOST
// starting Boost 1.64, serialization header must come before ublas
#include <boost/serialization/vector.hpp>
#include <boost/multi_array.hpp>
#include <boost/numeric/ublas/matrix.hpp>
#endif
 
#ifdef H5_USE_EIGEN
#include <Eigen/Eigen>
#endif
 
#include "H5Object.hpp"
#include "bits/H5_definitions.hpp"
 
namespace HighFive {
 
class DataSpace : public Object {
  public:
 
    const static ObjectType type = ObjectType::DataSpace;
 
    static const size_t UNLIMITED = SIZE_MAX;
 
    enum DataspaceType {
        datascape_scalar,
        datascape_null
        // simple dataspace are handle directly from their dimensions
    };
 
    explicit DataSpace(const std::vector<size_t>& dims);
 
    DataSpace(const std::initializer_list<size_t>& items);
 
    template<typename... Args>
    explicit DataSpace(size_t dim1, Args... dims);
 
    template <typename IT, typename = typename std::enable_if<!std::is_integral<IT>::value,IT>::type>
    DataSpace(const IT begin,
              const IT end);
 
    explicit DataSpace(const std::vector<size_t>& dims,
                       const std::vector<size_t>& maxdims);
 
    explicit DataSpace(DataspaceType dtype);
 
    DataSpace clone() const;
 
    size_t getNumberDimensions() const;
 
    std::vector<size_t> getDimensions() const;
 
    size_t getElementCount() const;
 
    std::vector<size_t> getMaxDimensions() const;
 
    template <typename ScalarValue>
    static DataSpace From(const ScalarValue& scalar_value);
 
    template <typename Value>
    static DataSpace From(const std::vector<Value>& container);
 
    template <typename Value, std::size_t N>
    static DataSpace From(const std::array<Value, N>&);
 
    template <typename ValueT, std::size_t N>
    static DataSpace From(const ValueT(&container)[N]);
 
    template <std::size_t N, std::size_t Width>
    static DataSpace FromCharArrayStrings(const char(&)[N][Width]);
 
#ifdef H5_USE_BOOST
    template <typename Value, std::size_t Dims>
    static DataSpace From(const boost::multi_array<Value, Dims>& container);
 
    template <typename Value>
    static DataSpace From(const boost::numeric::ublas::matrix<Value>& mat);
#endif
 
#ifdef H5_USE_EIGEN
    template <typename Value, int M, int N>
    static DataSpace From(const Eigen::Matrix<Value, M, N>& mat);
 
    template <typename Value, int M, int N>
    static DataSpace From(const std::vector<Eigen::Matrix<Value, M, N>>& vec);
#ifdef H5_USE_BOOST
    template <typename Value, int M, int N, size_t Dims>
    static DataSpace From(const boost::multi_array<Eigen::Matrix<Value, M, N>, Dims>& vec);
#endif
#endif
 
  protected:
    DataSpace() = default;
 
    friend class Attribute;
    friend class File;
    friend class DataSet;
};
 
}  // namespace HighFive
 
// We include bits right away since DataSpace is user-constructible
#include "bits/H5Dataspace_misc.hpp"
 
#endif // H5DATASPACE_HPP