std::map

Detailed Description

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

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

#include <h5/h5.hpp>
#include <iostream>
#include <map>
#include <string>
 
int main() {
  // create file in read/write mode
  h5::file file("map.h5", 'w');
 
 // write map
 h5::write(file, "mymap", std::map<std::string, int> { { "a", 1 }, { "b", 2 }, { "c", 3 } });
 
  // read into map
  std::map<std::string, int> map;
  h5::read(file, "mymap", map);
 
  // output map
  for (auto [x, y] : map) std::cout << "(" << x << ", " << y << ")" << std::endl;
}

Output:

(a, 1)
(b, 2)
(c, 3)

Contents of map.h5:

HDF5 "map.h5" {
GROUP "/" {
   GROUP "mymap" {
      ATTRIBUTE "Format" {
         DATATYPE  H5T_STRING {
            STRSIZE H5T_VARIABLE;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_UTF8;
            CTYPE H5T_C_S1;
         }
         DATASPACE  SCALAR
         DATA {
         (0): "Dict"
         }
      }
      DATASET "a" {
         DATATYPE  H5T_STD_I32LE
         DATASPACE  SCALAR
         DATA {
         (0): 1
         }
      }
      DATASET "b" {
         DATATYPE  H5T_STD_I32LE
         DATASPACE  SCALAR
         DATA {
         (0): 2
         }
      }
      DATASET "c" {
         DATATYPE  H5T_STD_I32LE
         DATASPACE  SCALAR
         DATA {
         (0): 3
         }
      }
   }
}
}

Classes
struct	h5::hdf5_format_impl< std::map< Key, T, Compare > >
	Specialization of h5::hdf5_format_impl for std::map. More...

Functions
template<typename Key, typename T, typename Compare>
void	h5::h5_read (group g, std::string const &name, std::map< Key, T, Compare > &m)
	Read a std::map from an HDF5 subgroup.
template<typename Key, typename T, typename Compare>
void	h5::h5_write (group g, std::string const &name, std::map< Key, T, Compare > const &m)
	Write a std::map to an HDF5 subgroup.

Function Documentation

h5_read()

template<typename Key, typename T, typename Compare>

void h5::h5_read	(	group	g,
		std::string const &	name,
		std::map< Key, T, Compare > &	m )

#include <h5/stl/map.hpp>

Read a std::map from an HDF5 subgroup.

Template Parameters

Key	Key type of the std::map.
T	Value type of the std::map.
Compare	Comparison type for the std::map.

Parameters

g	h5::group containing the subgroup.
name	Name of the subgroup from which the std::map is read.
m	std::map to read into.

Definition at line 90 of file map.hpp.

h5_write()

template<typename Key, typename T, typename Compare>

void h5::h5_write	(	group	g,
		std::string const &	name,
		std::map< Key, T, Compare > const &	m )

#include <h5/stl/map.hpp>

Write a std::map to an HDF5 subgroup.

Template Parameters

Key	Key type of the std::map.
T	Value type of the std::map.
Compare	Comparison type for the std::map.

Parameters

g	h5::group in which the subgroup is created.
name	Name of the subgroup to which the std::map is written.
m	std::map to be written.

Definition at line 58 of file map.hpp.