array_interface.hpp File Reference

#include "./group.hpp"
#include "./object.hpp"
#include <algorithm>
#include <numeric>
#include <string>
#include <utility>

Detailed Description

Provides a generic interface to read/write n-dimensional arrays from/to HDF5.

Definition in file array_interface.hpp.

Go to the source code of this file.

Classes
struct	h5::array_interface::array_view
	Struct representing a view on an n-dimensional array/dataspace. More...
struct	h5::array_interface::dataset_info
	Simple struct to store basic information about an HDF5 dataset. More...
struct	h5::array_interface::hyperslab
	Struct representing an HDF5 hyperslab. More...

Functions
dataset_info	h5::array_interface::get_dataset_info (dataset ds)
	Retrieve the shape and the h5::datatype from a dataset.
dataset_info	h5::array_interface::get_dataset_info (group g, std::string const &name)
	Retrieve the shape and the h5::datatype from a dataset with a given name in the given group.
std::pair< v_t, v_t >	h5::array_interface::get_parent_shape_and_h5_strides (long const *np_strides, int rank, long view_size)
	Given a view on an n-dimensional array (dataspace) by specifying its numpy/nda-style strides and its size (number of elements in the view), calculate the shape of a possible parent array and the corresponding HDF5 strides of the view.
void	h5::array_interface::read (group g, std::string const &name, array_view v, hyperslab sl={})
	Read a given hyperslab from an HDF5 dataset into an array view.
void	h5::array_interface::read_attribute (object obj, std::string const &name, array_view v)
	Read from an HDF5 attribute into an array view.
void	h5::array_interface::write (group g, std::string const &name, array_view const &v, bool compress)
	Write an array view to an HDF5 dataset.
void	h5::array_interface::write_attribute (object obj, std::string const &name, array_view v)
	Write an array view to an HDF5 attribute.
void	h5::array_interface::write_slice (group g, std::string const &name, array_view const &v, hyperslab sl)
	Write an array view to a selected hyperslab of an existing HDF5 dataset.