phynexis-deps/armadillo-code
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add example of how to enable use of hdf5

Browse Source
This commit is contained in:
conrad
2022-12-07 11:54:11 +10:00
parent 2ee15a75c1
commit 8a24a0a0e8
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs.html
+12 -6
View File
@@ -7105,6 +7105,18 @@ to explicitly control the dataset name, specify it via the <b>hdf5_name()</b> ar
</li>
<br>
<li>
<b>Caveat:</b>
for saving&thinsp;/&thinsp;loading HDF5 files, support for HDF5 must be enabled within Armadillo's <a href="#config_hpp">configuration</a>;
the <i>hdf5.h</i> header file must be available on your system and you will need to link with the HDF5 library (eg. <code><i>-lhdf5</i></code>).
HDF5 support can be enabled by defining <a href="#config_hpp">ARMA_USE_HDF5</a> before including the armadillo header:
<br>
<code>
#define ARMA_USE_HDF5
<br>#include &lt;armadillo&gt;
</code>
</li>
<br>
<li>
By providing either <b>hdf5_name(</b>filename<b>,</b> dataset<b>)</b> or <b>hdf5_name(</b>filename<b>,</b> dataset<b>,</b> settings<b>)</b>, the <i>file_type</i> type is assumed to be <i>hdf5_binary</i>
<br>
<br>
@@ -7130,12 +7142,6 @@ the above settings can be combined using the <code>+</code> operator; for exampl
</li>
<br>
<li>
<b>Caveat:</b>
for saving&thinsp;/&thinsp;loading HDF5 files, support for HDF5 must be enabled within Armadillo's <a href="#config_hpp">configuration</a>;
the <i>hdf5.h</i> header file must be available on your system and you will need to link with the HDF5 library (eg. <code><i>-lhdf5</i></code>)
</li>
<br>
<li>
By providing either <b>csv_name(</b>filename<b>,</b> header<b>)</b> or <b>csv_name(</b>filename<b>,</b> header<b>,</b> settings<b>)</b>,
the file is assumed to have data in comma separated value (CSV) text format
<br>