TREX/trexio
1
0
Fork 0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-12-26 06:15:05 +01:00
Code Issues Projects Releases Wiki Activity

Deploying to gh-pages from @ TREX-CoE/trexio@31bf17c66a 🚀

Browse Source
This commit is contained in:
q-posev 2021-06-04 15:37:51 +00:00
parent 3f3927ec64
commit 43e0225c06
5 changed files with 140 additions and 140 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-06-04 Fri 12:15 -->
<!-- 2021-06-04 Fri 15:37 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREXIO source code documentation</title>
@ -341,7 +341,7 @@ and bug reports should be submitted at
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-04 Fri 12:15</p>
<p class="date">Created: 2021-06-04 Fri 15:37</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

4
index.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-06-04 Fri 12:15 -->
<!-- 2021-06-04 Fri 15:37 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREXIO source code documentation</title>
@ -341,7 +341,7 @@ and bug reports should be submitted at
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-04 Fri 12:15</p>
<p class="date">Created: 2021-06-04 Fri 15:37</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

126
templator_front.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-06-04 Fri 12:15 -->
<!-- 2021-06-04 Fri 15:37 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Front end API</title>
@ -333,47 +333,47 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org84645b7">1. Coding conventions</a>
<li><a href="#orgfce03c1">1. Coding conventions</a>
<ul>
<li><a href="#orga682226">1.1. Memory allocation</a></li>
<li><a href="#orga9ca38d">1.1. Memory allocation</a></li>
</ul>
</li>
<li><a href="#org25b4c1d">2. Front end</a>
<li><a href="#org8309bb4">2. Front end</a>
<ul>
<li><a href="#org0cf9a25">2.1. Error handling</a></li>
<li><a href="#org441bc37">2.2. Back ends</a></li>
<li><a href="#org92825c2">2.3. Read/write behavior</a></li>
<li><a href="#org6bc2172">2.4. TREXIO file type</a></li>
<li><a href="#org28aaa0a">2.5. Polymorphism of the file handle</a></li>
<li><a href="#orgb12e187">2.6. File opening</a></li>
<li><a href="#org0fce83e">2.7. File closing</a></li>
<li><a href="#org4bc7201">2.8. C helper functions</a></li>
<li><a href="#orgd1da222">2.1. Error handling</a></li>
<li><a href="#org5114ef2">2.2. Back ends</a></li>
<li><a href="#org13c02b1">2.3. Read/write behavior</a></li>
<li><a href="#orgfde5583">2.4. TREXIO file type</a></li>
<li><a href="#org93d7820">2.5. Polymorphism of the file handle</a></li>
<li><a href="#orgf80ecbe">2.6. File opening</a></li>
<li><a href="#orgf9bfb42">2.7. File closing</a></li>
<li><a href="#orge8f750b">2.8. C helper functions</a></li>
</ul>
</li>
<li><a href="#orgce5d3dc">3. Templates for front end</a>
<li><a href="#org16e1dd0">3. Templates for front end</a>
<ul>
<li><a href="#orgb2af4b7">3.1. Templates for front end has/read/write a dimension</a>
<li><a href="#org856edc1">3.1. Templates for front end has/read/write a dimension</a>
<ul>
<li><a href="#org95e34d4">3.1.1. C templates for front end</a></li>
<li><a href="#org1d3c2a2">3.1.2. Fortran templates for front end</a></li>
<li><a href="#orgd956c88">3.1.1. C templates for front end</a></li>
<li><a href="#org26db594">3.1.2. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#orgda84b33">3.2. Templates for front end has/read/write a dataset</a>
<li><a href="#org4f0aa2b">3.2. Templates for front end has/read/write a dataset</a>
<ul>
<li><a href="#org54ac865">3.2.1. C templates for front end</a></li>
<li><a href="#org4698ede">3.2.2. Fortran templates for front end</a></li>
<li><a href="#orgf8c2ca0">3.2.1. C templates for front end</a></li>
<li><a href="#org82bf02b">3.2.2. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#org1753b9e">3.3. Sparse data structures</a></li>
<li><a href="#orgcca0ac1">3.3. Sparse data structures</a></li>
</ul>
</li>
<li><a href="#org060103a">4. Fortran helper/wrapper functions</a></li>
<li><a href="#orge1b8c6d">4. Fortran helper/wrapper functions</a></li>
</ul>
</div>
</div>
<div id="outline-container-org84645b7" class="outline-2">
<h2 id="org84645b7"><span class="section-number-2">1</span> Coding conventions</h2>
<div id="outline-container-orgfce03c1" class="outline-2">
<h2 id="orgfce03c1"><span class="section-number-2">1</span> Coding conventions</h2>
<div class="outline-text-2" id="text-1">
<ul class="org-ul">
<li>integer types will be defined using types given in <code>stdint.h</code></li>
@ -388,8 +388,8 @@ for the JavaScript code in this tag.
</ul>
</div>
<div id="outline-container-orga682226" class="outline-3">
<h3 id="orga682226"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div id="outline-container-orga9ca38d" class="outline-3">
<h3 id="orga9ca38d"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div class="outline-text-3" id="text-1-1">
<p>
Memory allocation of structures can be facilitated by using the
@ -424,8 +424,8 @@ The maximum string size for the filenames is 4096 characters.
</div>
</div>
<div id="outline-container-org25b4c1d" class="outline-2">
<h2 id="org25b4c1d"><span class="section-number-2">2</span> Front end</h2>
<div id="outline-container-org8309bb4" class="outline-2">
<h2 id="org8309bb4"><span class="section-number-2">2</span> Front end</h2>
<div class="outline-text-2" id="text-2">
<p>
All calls to TREXIO are thread-safe.
@ -433,10 +433,10 @@ TREXIO front end is modular, which simplifies implementation of new back ends.
</p>
</div>
<div id="outline-container-org0cf9a25" class="outline-3">
<h3 id="org0cf9a25"><span class="section-number-3">2.1</span> Error handling</h3>
<div id="outline-container-orgd1da222" class="outline-3">
<h3 id="orgd1da222"><span class="section-number-3">2.1</span> Error handling</h3>
<div class="outline-text-3" id="text-2-1">
<table id="orgd310c63" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orgf518526" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -727,8 +727,8 @@ The text strings are extracted from the previous table.
</div>
</div>
<div id="outline-container-org441bc37" class="outline-3">
<h3 id="org441bc37"><span class="section-number-3">2.2</span> Back ends</h3>
<div id="outline-container-org5114ef2" class="outline-3">
<h3 id="org5114ef2"><span class="section-number-3">2.2</span> Back ends</h3>
<div class="outline-text-3" id="text-2-2">
<p>
TREXIO has several back ends:
@ -758,8 +758,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
</div>
</div>
</div>
<div id="outline-container-org92825c2" class="outline-3">
<h3 id="org92825c2"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div id="outline-container-org13c02b1" class="outline-3">
<h3 id="org13c02b1"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div class="outline-text-3" id="text-2-3">
<p>
Every time a reading function is called, the data is read from the
@ -787,8 +787,8 @@ concurrent programs, the behavior is not specified.
</p>
</div>
</div>
<div id="outline-container-org6bc2172" class="outline-3">
<h3 id="org6bc2172"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div id="outline-container-orgfde5583" class="outline-3">
<h3 id="orgfde5583"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div class="outline-text-3" id="text-2-4">
<p>
<code>trexio_s</code> is the the main type for TREXIO files, visible to the users
@ -820,8 +820,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
</div>
</div>
</div>
<div id="outline-container-org28aaa0a" class="outline-3">
<h3 id="org28aaa0a"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div id="outline-container-org93d7820" class="outline-3">
<h3 id="org93d7820"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div class="outline-text-3" id="text-2-5">
<p>
Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the
@ -840,8 +840,8 @@ corresponding types for all back ends can be safely casted to
</div>
</div>
<div id="outline-container-orgb12e187" class="outline-3">
<h3 id="orgb12e187"><span class="section-number-3">2.6</span> File opening</h3>
<div id="outline-container-orgf80ecbe" class="outline-3">
<h3 id="orgf80ecbe"><span class="section-number-3">2.6</span> File opening</h3>
<div class="outline-text-3" id="text-2-6">
<p>
<code>trexio_open</code> creates a new TREXIO file or opens existing one.
@ -1004,8 +1004,8 @@ should tend to avoid renaming the <code>.txt</code> data files.
</div>
</div>
<div id="outline-container-org0fce83e" class="outline-3">
<h3 id="org0fce83e"><span class="section-number-3">2.7</span> File closing</h3>
<div id="outline-container-orgf9bfb42" class="outline-3">
<h3 id="orgf9bfb42"><span class="section-number-3">2.7</span> File closing</h3>
<div class="outline-text-3" id="text-2-7">
<p>
<code>trexio_close</code> closes an existing <code>trexio_t</code> file.
@ -1103,8 +1103,8 @@ output:
</div>
</div>
<div id="outline-container-org4bc7201" class="outline-3">
<h3 id="org4bc7201"><span class="section-number-3">2.8</span> C helper functions</h3>
<div id="outline-container-orge8f750b" class="outline-3">
<h3 id="orge8f750b"><span class="section-number-3">2.8</span> C helper functions</h3>
<div class="outline-text-3" id="text-2-8">
<p>
#+begin<sub>src</sub> c :tangle prefix<sub>front.c</sub>
@ -1142,8 +1142,8 @@ for (int i=0; i&lt;str<sub>max</sub><sub>num</sub>; i++){
</div>
</div>
<div id="outline-container-orgce5d3dc" class="outline-2">
<h2 id="orgce5d3dc"><span class="section-number-2">3</span> Templates for front end</h2>
<div id="outline-container-org16e1dd0" class="outline-2">
<h2 id="org16e1dd0"><span class="section-number-2">3</span> Templates for front end</h2>
<div class="outline-text-2" id="text-3">
<p>
Consider the following block of <code>trex.json</code>:
@ -1332,8 +1332,8 @@ or double precision for integer and floating point numbers.
</p>
</div>
<div id="outline-container-orgb2af4b7" class="outline-3">
<h3 id="orgb2af4b7"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3>
<div id="outline-container-org856edc1" class="outline-3">
<h3 id="org856edc1"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3>
<div class="outline-text-3" id="text-3-1">
<p>
This section concerns API calls related to dimensioning variables.
@ -1402,8 +1402,8 @@ This section concerns API calls related to dimensioning variables.
</table>
</div>
<div id="outline-container-org95e34d4" class="outline-4">
<h4 id="org95e34d4"><span class="section-number-4">3.1.1</span> C templates for front end</h4>
<div id="outline-container-orgd956c88" class="outline-4">
<h4 id="orgd956c88"><span class="section-number-4">3.1.1</span> C templates for front end</h4>
<div class="outline-text-4" id="text-3-1-1">
<p>
The <code>C</code> templates that correspond to each of the abovementioned
@ -1598,8 +1598,8 @@ precision (see Table above).
</div>
</div>
<div id="outline-container-org1d3c2a2" class="outline-4">
<h4 id="org1d3c2a2"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4>
<div id="outline-container-org26db594" class="outline-4">
<h4 id="org26db594"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4>
<div class="outline-text-4" id="text-3-1-2">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
@ -1685,8 +1685,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-orgda84b33" class="outline-3">
<h3 id="orgda84b33"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3>
<div id="outline-container-org4f0aa2b" class="outline-3">
<h3 id="org4f0aa2b"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3>
<div class="outline-text-3" id="text-3-2">
<p>
This section concerns API calls related to datasets.
@ -1755,8 +1755,8 @@ This section concerns API calls related to datasets.
</table>
</div>
<div id="outline-container-org54ac865" class="outline-4">
<h4 id="org54ac865"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
<div id="outline-container-orgf8c2ca0" class="outline-4">
<h4 id="orgf8c2ca0"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
<div class="outline-text-4" id="text-3-2-1">
<p>
The C templates that correspond to each of the abovementioned functions can be found below.
@ -2022,8 +2022,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
</div>
</div>
<div id="outline-container-org4698ede" class="outline-4">
<h4 id="org4698ede"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
<div id="outline-container-org82bf02b" class="outline-4">
<h4 id="org82bf02b"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
<div class="outline-text-4" id="text-3-2-2">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
@ -2109,8 +2109,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-org1753b9e" class="outline-3">
<h3 id="org1753b9e"><span class="section-number-3">3.3</span> Sparse data structures</h3>
<div id="outline-container-orgcca0ac1" class="outline-3">
<h3 id="orgcca0ac1"><span class="section-number-3">3.3</span> Sparse data structures</h3>
<div class="outline-text-3" id="text-3-3">
<p>
Sparse data structures are used typically for large tensors such as
@ -2252,8 +2252,8 @@ For the values,
</div>
</div>
<div id="outline-container-org060103a" class="outline-2">
<h2 id="org060103a"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div id="outline-container-orge1b8c6d" class="outline-2">
<h2 id="orge1b8c6d"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div class="outline-text-2" id="text-4">
<p>
The function below adapts the original C-based <code>trexio_open</code> for Fortran.
@ -2282,7 +2282,7 @@ Note, that Fortran interface calls the main <code>TREXIO</code> API, which is wr
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-04 Fri 12:15</p>
<p class="date">Created: 2021-06-04 Fri 15:37</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

46
templator_hdf5.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-06-04 Fri 12:15 -->
<!-- 2021-06-04 Fri 15:37 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>HDF5 back end</title>
@ -311,25 +311,25 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org78c864e">1. HDF5 back end</a>
<li><a href="#org70f5608">1. HDF5 back end</a>
<ul>
<li><a href="#org3893fc8">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org1771dad">1.2. Template for HDF5 structures</a></li>
<li><a href="#org6f1c985">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#orgd1089e4">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org12d3dea">1.5. Template for HDF5 has/read/write a dataset</a></li>
<li><a href="#org158d771">1.1. Template for HDF5 definitions</a></li>
<li><a href="#orga3c6365">1.2. Template for HDF5 structures</a></li>
<li><a href="#org8a31a62">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org45b9d42">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#orgd8345a7">1.5. Template for HDF5 has/read/write a dataset</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-org78c864e" class="outline-2">
<h2 id="org78c864e"><span class="section-number-2">1</span> HDF5 back end</h2>
<div id="outline-container-org70f5608" class="outline-2">
<h2 id="org70f5608"><span class="section-number-2">1</span> HDF5 back end</h2>
<div class="outline-text-2" id="text-1">
</div>
<div id="outline-container-org3893fc8" class="outline-3">
<h3 id="org3893fc8"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div id="outline-container-org158d771" class="outline-3">
<h3 id="org158d771"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div class="outline-text-3" id="text-1-1">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #483d8b;">#define</span> $GROUP$_GROUP_NAME <span style="color: #8b2252;">"$group$"</span>
@ -340,8 +340,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org1771dad" class="outline-3">
<h3 id="org1771dad"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div id="outline-container-orga3c6365" class="outline-3">
<h3 id="orga3c6365"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div class="outline-text-3" id="text-1-2">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">trexio_hdf5_s</span> {
@ -356,8 +356,8 @@ for the JavaScript code in this tag.
</div>
<div id="outline-container-org6f1c985" class="outline-3">
<h3 id="org6f1c985"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
<div id="outline-container-org8a31a62" class="outline-3">
<h3 id="org8a31a62"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
<div class="outline-text-3" id="text-1-3">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -437,8 +437,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-orgd1089e4" class="outline-3">
<h3 id="orgd1089e4"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3>
<div id="outline-container-org45b9d42" class="outline-3">
<h3 id="org45b9d42"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3>
<div class="outline-text-3" id="text-1-4">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -560,8 +560,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org12d3dea" class="outline-3">
<h3 id="org12d3dea"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3>
<div id="outline-container-orgd8345a7" class="outline-3">
<h3 id="orgd8345a7"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3>
<div class="outline-text-3" id="text-1-5">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -611,7 +611,7 @@ for the JavaScript code in this tag.
/* <span style="color: #b22222;">High-level H5LT API. No need to deal with dataspaces and datatypes </span>*/
status = H5LTread_dataset(f-&gt;$group$_group,
$GROUP_DSET$_NAME,
H5T_NATIVE_$GROUP_DSET_H5_DTYPE$,
H5T_$GROUP_DSET_H5_DTYPE$,
$group_dset$);
<span style="color: #a020f0;">if</span> (status &lt; 0) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
@ -642,7 +642,7 @@ for the JavaScript code in this tag.
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">herr_t</span> <span style="color: #a0522d;">status</span> = H5LTmake_dataset(f-&gt;$group$_group,
$GROUP_DSET$_NAME,
(<span style="color: #228b22;">int</span>) rank, (<span style="color: #a020f0;">const</span> <span style="color: #228b22;">hsize_t</span>*) dims,
H5T_NATIVE_$GROUP_DSET_H5_DTYPE$,
H5T_$GROUP_DSET_H5_DTYPE$,
$group_dset$);
<span style="color: #a020f0;">if</span> (status &lt; 0) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
@ -652,7 +652,7 @@ for the JavaScript code in this tag.
<span style="color: #a020f0;">if</span> (dset_id &lt;= 0) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ID;
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">herr_t</span> <span style="color: #a0522d;">status</span> = H5Dwrite(dset_id,
H5T_NATIVE_$GROUP_DSET_H5_DTYPE$,
H5T_$GROUP_DSET_H5_DTYPE$,
H5S_ALL, H5S_ALL, H5P_DEFAULT,
$group_dset$);
@ -695,7 +695,7 @@ for the JavaScript code in this tag.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-04 Fri 12:15</p>
<p class="date">Created: 2021-06-04 Fri 15:37</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

100
templator_text.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-06-04 Fri 12:15 -->
<!-- 2021-06-04 Fri 15:37 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TEXT back end</title>
@ -311,24 +311,24 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgac72b89">1. TEXT back end</a>
<li><a href="#orgb65b891">1. TEXT back end</a>
<ul>
<li><a href="#org0d2be68">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org29c0aca">1.2. Template for general structure in text back end</a></li>
<li><a href="#org713130f">1.3. Initialize function (constant part)</a></li>
<li><a href="#orgdc4ed3a">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org9ff6131">1.5. Template for text read struct</a></li>
<li><a href="#orgbb48b37">1.6. Template for text flush struct</a></li>
<li><a href="#orgb833e6c">1.7. Template for text free memory</a></li>
<li><a href="#org0810ddd">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org72afbab">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#orgfaf77f8">1.10. RDM struct (hard-coded)</a>
<li><a href="#orgfc05fdb">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#orge6ce463">1.2. Template for general structure in text back end</a></li>
<li><a href="#org92b8837">1.3. Initialize function (constant part)</a></li>
<li><a href="#org4e7b8b7">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org274720a">1.5. Template for text read struct</a></li>
<li><a href="#org343c3a1">1.6. Template for text flush struct</a></li>
<li><a href="#org76dbb59">1.7. Template for text free memory</a></li>
<li><a href="#org86ddc43">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org94b2811">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#org26208e9">1.10. RDM struct (hard-coded)</a>
<ul>
<li><a href="#org02537a0">1.10.1. Read the complete struct</a></li>
<li><a href="#org6f94686">1.10.2. Flush the complete struct</a></li>
<li><a href="#orgfde3988">1.10.3. Free memory</a></li>
<li><a href="#org6e1ce25">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org7dbb9bb">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li>
<li><a href="#org8198231">1.10.1. Read the complete struct</a></li>
<li><a href="#org9d0b012">1.10.2. Flush the complete struct</a></li>
<li><a href="#org60a6f7a">1.10.3. Free memory</a></li>
<li><a href="#orgf408c80">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org43f519d">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li>
</ul>
</li>
</ul>
@ -337,8 +337,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-orgac72b89" class="outline-2">
<h2 id="orgac72b89"><span class="section-number-2">1</span> TEXT back end</h2>
<div id="outline-container-orgb65b891" class="outline-2">
<h2 id="orgb65b891"><span class="section-number-2">1</span> TEXT back end</h2>
<div class="outline-text-2" id="text-1">
<p>
The "file" produced by the text back end is a directory with one
@ -359,8 +359,8 @@ The file is written when closed, or when the flush function is called.
</p>
</div>
<div id="outline-container-org0d2be68" class="outline-3">
<h3 id="org0d2be68"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
<div id="outline-container-orgfc05fdb" class="outline-3">
<h3 id="orgfc05fdb"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
<div class="outline-text-3" id="text-1-1">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> $group$_s {
@ -376,8 +376,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org29c0aca" class="outline-3">
<h3 id="org29c0aca"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
<div id="outline-container-orge6ce463" class="outline-3">
<h3 id="orge6ce463"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
<div class="outline-text-3" id="text-1-2">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">rdm_s</span> {
@ -403,8 +403,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org713130f" class="outline-3">
<h3 id="org713130f"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div id="outline-container-org92b8837" class="outline-3">
<h3 id="org92b8837"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div class="outline-text-3" id="text-1-3">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -505,8 +505,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-orgdc4ed3a" class="outline-3">
<h3 id="orgdc4ed3a"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div id="outline-container-org4e7b8b7" class="outline-3">
<h3 id="org4e7b8b7"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div class="outline-text-3" id="text-1-4">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -531,8 +531,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org9ff6131" class="outline-3">
<h3 id="org9ff6131"><span class="section-number-3">1.5</span> Template for text read struct</h3>
<div id="outline-container-org274720a" class="outline-3">
<h3 id="org274720a"><span class="section-number-3">1.5</span> Template for text read struct</h3>
<div class="outline-text-3" id="text-1-5">
<div class="org-src-container">
<pre class="src src-c">$group$_t*
@ -698,8 +698,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-orgbb48b37" class="outline-3">
<h3 id="orgbb48b37"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
<div id="outline-container-org343c3a1" class="outline-3">
<h3 id="org343c3a1"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
<div class="outline-text-3" id="text-1-6">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -758,8 +758,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-orgb833e6c" class="outline-3">
<h3 id="orgb833e6c"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div id="outline-container-org76dbb59" class="outline-3">
<h3 id="org76dbb59"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div class="outline-text-3" id="text-1-7">
<p>
Memory is allocated when reading. The following function frees memory.
@ -795,8 +795,8 @@ Memory is allocated when reading. The following function frees memory.
</div>
</div>
<div id="outline-container-org0810ddd" class="outline-3">
<h3 id="org0810ddd"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3>
<div id="outline-container-org86ddc43" class="outline-3">
<h3 id="org86ddc43"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3>
<div class="outline-text-3" id="text-1-8">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -858,8 +858,8 @@ Memory is allocated when reading. The following function frees memory.
</div>
</div>
<div id="outline-container-org72afbab" class="outline-3">
<h3 id="org72afbab"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3>
<div id="outline-container-org94b2811" class="outline-3">
<h3 id="org94b2811"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3>
<div class="outline-text-3" id="text-1-9">
<p>
The <code>group_dset</code> array is assumed allocated with the appropriate size.
@ -956,12 +956,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-orgfaf77f8" class="outline-3">
<h3 id="orgfaf77f8"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3>
<div id="outline-container-org26208e9" class="outline-3">
<h3 id="org26208e9"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3>
<div class="outline-text-3" id="text-1-10">
</div>
<div id="outline-container-org02537a0" class="outline-4">
<h4 id="org02537a0"><span class="section-number-4">1.10.1</span> Read the complete struct</h4>
<div id="outline-container-org8198231" class="outline-4">
<h4 id="org8198231"><span class="section-number-4">1.10.1</span> Read the complete struct</h4>
<div class="outline-text-4" id="text-1-10-1">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">rdm_t</span>* <span style="color: #0000ff;">trexio_text_read_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>);
@ -1056,8 +1056,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-org6f94686" class="outline-4">
<h4 id="org6f94686"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4>
<div id="outline-container-org9d0b012" class="outline-4">
<h4 id="org9d0b012"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4>
<div class="outline-text-4" id="text-1-10-2">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_text_flush_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>);
@ -1099,8 +1099,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-orgfde3988" class="outline-4">
<h4 id="orgfde3988"><span class="section-number-4">1.10.3</span> Free memory</h4>
<div id="outline-container-org60a6f7a" class="outline-4">
<h4 id="org60a6f7a"><span class="section-number-4">1.10.3</span> Free memory</h4>
<div class="outline-text-4" id="text-1-10-3">
<p>
Memory is allocated when reading. The followig function frees memory.
@ -1136,8 +1136,8 @@ Memory is allocated when reading. The followig function frees memory.
</div>
</div>
<div id="outline-container-org6e1ce25" class="outline-4">
<h4 id="org6e1ce25"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4>
<div id="outline-container-orgf408c80" class="outline-4">
<h4 id="orgf408c80"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4>
<div class="outline-text-4" id="text-1-10-4">
<p>
The <code>one_e</code> array is assumed allocated with the appropriate size.
@ -1203,8 +1203,8 @@ The <code>one_e</code> array is assumed allocated with the appropriate size.
</div>
</div>
<div id="outline-container-org7dbb9bb" class="outline-4">
<h4 id="org7dbb9bb"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4>
<div id="outline-container-org43f519d" class="outline-4">
<h4 id="org43f519d"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4>
<div class="outline-text-4" id="text-1-10-5">
<p>
<code>two_e</code> is a sparse data structure, which can be too large to fit
@ -1312,7 +1312,7 @@ file for each sparse float structure.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-04 Fri 12:15</p>
<p class="date">Created: 2021-06-04 Fri 15:37</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>