3
0
mirror of https://github.com/triqs/dft_tools synced 2024-11-02 12:13:46 +01:00
dft_tools/doc/reference/c++/arrays/h5_rw.rst
Olivier Parcollet 3fe400d34c doc : split c++ code from rst
- examples split from the rst file using a python script (split_code).
- Final result for the doc is unchanged.
- examples are compiled and tested with the other tests.
- examples' code have been clang-formatted, with triqs style.
- doc compiles much faster, and with the same options as the rest of the
  test.
- examples are added as tests, so they are run by make test, as simple C
  tests.
- done for the tutorials and the reference.
- autocompile removed (changed into triqs_example directive).
- add triqs_example :
   - make a literal include of the source code.
   - runs the compiled example
   - add, as before, the result to the source code in the doc.
- added the script split_code, used to make the changes automatically,
  maybe for later reuse. (in _tools)
2014-05-31 23:00:16 +02:00

22 lines
699 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.