Detailed Description

Specialized functions to read/write a std::array from/to HDF5.

The following code writes a std::array to an HDF5 file, reads the same array and outputs it to stdout:

#include <h5/h5.hpp>
#include <iostream>
#include <array>
 
int main() {
  // create file in read/write mode
  h5::file file("array.h5", 'w');
 
 // write array
 h5::write(file, "myarray", std::array { 1, 2, 3, 4 , 5 });
 
  // read into array
  std::array<int, 5> arr;
  h5::read(file, "myarray", arr);
 
  // output array
  for (auto x : arr) std::cout << x << std::endl;
}

Output:

Contents of array.h5:

HDF5 "array.h5" {
GROUP "/" {
   DATASET "myarray" {
      DATATYPE  H5T_STD_I32LE
      DATASPACE  SIMPLE { ( 5 ) / ( 5 ) }
      DATA {
      (0): 1, 2, 3, 4, 5
      }
   }
}
}

Functions
template<typename T , size_t N>
void	h5::h5_read (group g, std::string name, std::array< T, N > &a)
	Read a std::array from an HDF5 dataset/subgroup.

template<typename T , size_t N>
void	h5::h5_write (group g, std::string const &name, std::array< T, N > const &a)
	Write a std::array to an HDF5 dataset/subgroup.

Function Documentation

◆ h5_read()

template<typename T , size_t N>

void h5::h5_read	(	group	g,
		std::string	name,
		std::array< T, N > &	a )

#include <h5/stl/array.hpp>

Read a std::array from an HDF5 dataset/subgroup.

Template Parameters

T	Value type of the std::array.
N	Size of the std::array.

Parameters

g	h5::group containing the dataset/subgroup.
name	Name of the dataset/subgroup from which the std::array is read.
a	std::array to read into.

Definition at line 84 of file array.hpp.

◆ h5_write()