H5DataSpace.hpp

/*
 *  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 H5GT_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 H5GT_USE_EIGEN
#include <Eigen/Eigen>
#endif
 
#include "H5PropertyList.hpp"
#include "bits/H5_definitions.hpp"
 
namespace h5gt {
 
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);
 
  // create a dataspace of N-dimensions
  template <size_t N>
  explicit DataSpace(const std::array<size_t, N>& 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;
 
  size_t getElementCountSelected() const;
 
  std::vector<size_t> getMaxDimensions() const;
 
  template <typename T>
  static DataSpace From(const T& value);
 
  template <std::size_t N, std::size_t Width>
  static DataSpace FromCharArrayStrings(const char(&)[N][Width]);
 
  static DataSpace FromId(const hid_t& id, const bool& increaseRefCount = false){
    Object obj = Object(id, ObjectType::DataSpace, increaseRefCount);
    return DataSpace(obj);
  };
 
protected:
  DataSpace(const Object& obj) : Object(obj){};
  DataSpace() = default;
 
  friend class Attribute;
  friend class File;
  friend class DataSet;
  friend class Selection;
};
 
}  // namespace h5gt
 
// We include bits right away since DataSpace is user-constructible
#include "bits/H5Dataspace_misc.hpp"
 
#endif // H5DATASPACE_HPP