3
0
mirror of https://github.com/triqs/dft_tools synced 2024-12-26 22:33:48 +01:00
dft_tools/doc/reference/arrays/h5_rw.rst
tayral edd1ff4529 Restructuring documentation.
A first general restructuration of the doc according to the pattern [tour|tutorial|reference].
In the reference part, objects are documented per topic.
In each topic, [definition|c++|python|hdf5] (not yet implemented)
2014-10-18 12:21:08 +01:00

22 lines
697 B
ReStructuredText

.. highlight:: c
Simple read/write operations of an array (or a view)
============================================================================
Given an array (or an array_view), the functions `h5::write` and `h5::read` write and read it to/from the file
or any subgroup thereof. For example:
.. triqs_example:: ./h5_rw_0.cpp
.. triqs_example:: examples_code/h5_rw.cpp
Note that:
* The data in the hdf5 file are stored in C order.
* The data is reordered in Fortran (or custom) order if necessary when reading/writing.
* It also works with matrix and vector (but the storage is the same in HDF5).
* It also works with the corresponding views. TO BE ILLUSTRATED.