TREX/trexio
1
0
Fork 0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-11-04 13:14:00 +01:00
Code Issues Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
q-posev 2021-06-16 12:05:17 +00:00
parent 75b770da7f
commit 533129d3cf
5 changed files with 173 additions and 173 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-16 Wed 10:21 -->
<!-- 2021-06-16 Wed 12:05 -->
<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-16 Wed 10:21</p>
<p class="date">Created: 2021-06-16 Wed 12:05</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-16 Wed 10:21 -->
<!-- 2021-06-16 Wed 12:05 -->
<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-16 Wed 10:21</p>
<p class="date">Created: 2021-06-16 Wed 12:05</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

174
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-16 Wed 10:21 -->
<!-- 2021-06-16 Wed 12:05 -->
<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,61 +333,61 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgcaef329">1. Coding conventions</a>
<li><a href="#orgb4cf229">1. Coding conventions</a>
<ul>
<li><a href="#org3ba1be7">1.1. Memory allocation</a></li>
<li><a href="#org051e613">1.1. Memory allocation</a></li>
</ul>
</li>
<li><a href="#org6220ca8">2. Front end</a>
<li><a href="#org7010e18">2. Front end</a>
<ul>
<li><a href="#orgc2d8fca">2.1. Error handling</a></li>
<li><a href="#org3061095">2.2. Back ends</a></li>
<li><a href="#orgb0009c1">2.3. Read/write behavior</a></li>
<li><a href="#org085f984">2.4. TREXIO file type</a></li>
<li><a href="#org4223870">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org114d170">2.6. File opening</a></li>
<li><a href="#orgd72364c">2.7. File closing</a></li>
<li><a href="#org08020d4">2.1. Error handling</a></li>
<li><a href="#org2a8c0af">2.2. Back ends</a></li>
<li><a href="#org2fc0f52">2.3. Read/write behavior</a></li>
<li><a href="#org034b55f">2.4. TREXIO file type</a></li>
<li><a href="#org2ec8633">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org438f172">2.6. File opening</a></li>
<li><a href="#orgdb4f7b1">2.7. File closing</a></li>
</ul>
</li>
<li><a href="#org2d018a4">3. Templates for front end</a>
<li><a href="#org8d26983">3. Templates for front end</a>
<ul>
<li><a href="#orgfce91be">3.1. Description</a></li>
<li><a href="#org7b3a93d">3.2. Templates for front end has/read/write a single dimensioning variable</a>
<li><a href="#org5b37bcb">3.1. Description</a></li>
<li><a href="#org82914a5">3.2. Templates for front end has/read/write a single dimensioning variable</a>
<ul>
<li><a href="#org4da212b">3.2.1. C templates for front end</a></li>
<li><a href="#org42d22e3">3.2.2. Fortran templates for front end</a></li>
<li><a href="#org37e3d1e">3.2.1. C templates for front end</a></li>
<li><a href="#org64bee84">3.2.2. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#org03af9ca">3.3. Templates for front end has/read/write a dataset of numerical data</a>
<li><a href="#org8fb5a33">3.3. Templates for front end has/read/write a dataset of numerical data</a>
<ul>
<li><a href="#org215809b">3.3.1. C templates for front end</a></li>
<li><a href="#org2c0b57d">3.3.2. Fortran templates for front end</a></li>
<li><a href="#org871558e">3.3.1. C templates for front end</a></li>
<li><a href="#orgd7d1d38">3.3.2. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#org8329280">3.4. Sparse data structures</a></li>
<li><a href="#org88935cb">3.5. Templates for front end has/read/write a dataset of strings</a>
<li><a href="#orgc444b5d">3.4. Sparse data structures</a></li>
<li><a href="#org6047360">3.5. Templates for front end has/read/write a dataset of strings</a>
<ul>
<li><a href="#org5d1620f">3.5.1. Introduction</a></li>
<li><a href="#org20560a9">3.5.2. C templates for front end</a></li>
<li><a href="#org622064d">3.5.3. Fortran templates for front end</a></li>
<li><a href="#org1d959e6">3.5.1. Introduction</a></li>
<li><a href="#org1d442a1">3.5.2. C templates for front end</a></li>
<li><a href="#org4b6d7e7">3.5.3. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#org86e77d2">3.6. Templates for front end has/read/write a single string attribute</a>
<li><a href="#org69213b3">3.6. Templates for front end has/read/write a single string attribute</a>
<ul>
<li><a href="#org81bb49a">3.6.1. Introduction</a></li>
<li><a href="#org8bf59e3">3.6.2. C templates for front end</a></li>
<li><a href="#org9337deb">3.6.3. Fortran templates for front end</a></li>
<li><a href="#org6151130">3.6.1. Introduction</a></li>
<li><a href="#orgc74a2f9">3.6.2. C templates for front end</a></li>
<li><a href="#org6063c02">3.6.3. Fortran templates for front end</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#org0b34c9d">4. Fortran helper/wrapper functions</a></li>
<li><a href="#orge50880f">4. Fortran helper/wrapper functions</a></li>
</ul>
</div>
</div>
<div id="outline-container-orgcaef329" class="outline-2">
<h2 id="orgcaef329"><span class="section-number-2">1</span> Coding conventions</h2>
<div id="outline-container-orgb4cf229" class="outline-2">
<h2 id="orgb4cf229"><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>
@ -402,8 +402,8 @@ for the JavaScript code in this tag.
</ul>
</div>
<div id="outline-container-org3ba1be7" class="outline-3">
<h3 id="org3ba1be7"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div id="outline-container-org051e613" class="outline-3">
<h3 id="org051e613"><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
@ -438,8 +438,8 @@ The maximum string size for the filenames is 4096 characters.
</div>
</div>
<div id="outline-container-org6220ca8" class="outline-2">
<h2 id="org6220ca8"><span class="section-number-2">2</span> Front end</h2>
<div id="outline-container-org7010e18" class="outline-2">
<h2 id="org7010e18"><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.
@ -447,10 +447,10 @@ TREXIO front end is modular, which simplifies implementation of new back ends.
</p>
</div>
<div id="outline-container-orgc2d8fca" class="outline-3">
<h3 id="orgc2d8fca"><span class="section-number-3">2.1</span> Error handling</h3>
<div id="outline-container-org08020d4" class="outline-3">
<h3 id="org08020d4"><span class="section-number-3">2.1</span> Error handling</h3>
<div class="outline-text-3" id="text-2-1">
<table id="org5e826c1" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orgc786553" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -750,8 +750,8 @@ The text strings are extracted from the previous table.
</div>
</div>
<div id="outline-container-org3061095" class="outline-3">
<h3 id="org3061095"><span class="section-number-3">2.2</span> Back ends</h3>
<div id="outline-container-org2a8c0af" class="outline-3">
<h3 id="org2a8c0af"><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:
@ -783,8 +783,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
</div>
</div>
</div>
<div id="outline-container-orgb0009c1" class="outline-3">
<h3 id="orgb0009c1"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div id="outline-container-org2fc0f52" class="outline-3">
<h3 id="org2fc0f52"><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
@ -812,8 +812,8 @@ concurrent programs, the behavior is not specified.
</p>
</div>
</div>
<div id="outline-container-org085f984" class="outline-3">
<h3 id="org085f984"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div id="outline-container-org034b55f" class="outline-3">
<h3 id="org034b55f"><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
@ -846,8 +846,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
</div>
</div>
</div>
<div id="outline-container-org4223870" class="outline-3">
<h3 id="org4223870"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div id="outline-container-org2ec8633" class="outline-3">
<h3 id="org2ec8633"><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
@ -866,8 +866,8 @@ corresponding types for all back ends can be safely casted to
</div>
</div>
<div id="outline-container-org114d170" class="outline-3">
<h3 id="org114d170"><span class="section-number-3">2.6</span> File opening</h3>
<div id="outline-container-org438f172" class="outline-3">
<h3 id="org438f172"><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.
@ -1058,8 +1058,8 @@ know if we need to shift by 1 arrays of indices.
</div>
</div>
<div id="outline-container-orgd72364c" class="outline-3">
<h3 id="orgd72364c"><span class="section-number-3">2.7</span> File closing</h3>
<div id="outline-container-orgdb4f7b1" class="outline-3">
<h3 id="orgdb4f7b1"><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.
@ -1155,12 +1155,12 @@ output:
</div>
</div>
<div id="outline-container-org2d018a4" class="outline-2">
<h2 id="org2d018a4"><span class="section-number-2">3</span> Templates for front end</h2>
<div id="outline-container-org8d26983" class="outline-2">
<h2 id="org8d26983"><span class="section-number-2">3</span> Templates for front end</h2>
<div class="outline-text-2" id="text-3">
</div>
<div id="outline-container-orgfce91be" class="outline-3">
<h3 id="orgfce91be"><span class="section-number-3">3.1</span> Description</h3>
<div id="outline-container-org5b37bcb" class="outline-3">
<h3 id="org5b37bcb"><span class="section-number-3">3.1</span> Description</h3>
<div class="outline-text-3" id="text-3-1">
<p>
Consider the following block of <code>trex.json</code>:
@ -1350,8 +1350,8 @@ or double precision for integer and floating point numbers.
</div>
</div>
<div id="outline-container-org7b3a93d" class="outline-3">
<h3 id="org7b3a93d"><span class="section-number-3">3.2</span> Templates for front end has/read/write a single dimensioning variable</h3>
<div id="outline-container-org82914a5" class="outline-3">
<h3 id="org82914a5"><span class="section-number-3">3.2</span> Templates for front end has/read/write a single dimensioning variable</h3>
<div class="outline-text-3" id="text-3-2">
<p>
This section concerns API calls related to dimensioning variables.
@ -1420,8 +1420,8 @@ This section concerns API calls related to dimensioning variables.
</table>
</div>
<div id="outline-container-org4da212b" class="outline-4">
<h4 id="org4da212b"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
<div id="outline-container-org37e3d1e" class="outline-4">
<h4 id="org37e3d1e"><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 <code>C</code> templates that correspond to each of the abovementioned
@ -1610,8 +1610,8 @@ precision (see Table above).
</div>
</div>
<div id="outline-container-org42d22e3" class="outline-4">
<h4 id="org42d22e3"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
<div id="outline-container-org64bee84" class="outline-4">
<h4 id="org64bee84"><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 Fortran.
@ -1697,8 +1697,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-org03af9ca" class="outline-3">
<h3 id="org03af9ca"><span class="section-number-3">3.3</span> Templates for front end has/read/write a dataset of numerical data</h3>
<div id="outline-container-org8fb5a33" class="outline-3">
<h3 id="org8fb5a33"><span class="section-number-3">3.3</span> Templates for front end has/read/write a dataset of numerical data</h3>
<div class="outline-text-3" id="text-3-3">
<p>
This section concerns API calls related to datasets.
@ -1767,8 +1767,8 @@ This section concerns API calls related to datasets.
</table>
</div>
<div id="outline-container-org215809b" class="outline-4">
<h4 id="org215809b"><span class="section-number-4">3.3.1</span> C templates for front end</h4>
<div id="outline-container-org871558e" class="outline-4">
<h4 id="org871558e"><span class="section-number-4">3.3.1</span> C templates for front end</h4>
<div class="outline-text-4" id="text-3-3-1">
<p>
The C templates that correspond to each of the abovementioned functions can be found below.
@ -2087,8 +2087,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
</div>
</div>
<div id="outline-container-org2c0b57d" class="outline-4">
<h4 id="org2c0b57d"><span class="section-number-4">3.3.2</span> Fortran templates for front end</h4>
<div id="outline-container-orgd7d1d38" class="outline-4">
<h4 id="orgd7d1d38"><span class="section-number-4">3.3.2</span> Fortran templates for front end</h4>
<div class="outline-text-4" id="text-3-3-2">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
@ -2174,8 +2174,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-org8329280" class="outline-3">
<h3 id="org8329280"><span class="section-number-3">3.4</span> Sparse data structures</h3>
<div id="outline-container-orgc444b5d" class="outline-3">
<h3 id="orgc444b5d"><span class="section-number-3">3.4</span> Sparse data structures</h3>
<div class="outline-text-3" id="text-3-4">
<p>
Sparse data structures are used typically for large tensors such as
@ -2316,12 +2316,12 @@ For the values,
</div>
</div>
<div id="outline-container-org88935cb" class="outline-3">
<h3 id="org88935cb"><span class="section-number-3">3.5</span> Templates for front end has/read/write a dataset of strings</h3>
<div id="outline-container-org6047360" class="outline-3">
<h3 id="org6047360"><span class="section-number-3">3.5</span> Templates for front end has/read/write a dataset of strings</h3>
<div class="outline-text-3" id="text-3-5">
</div>
<div id="outline-container-org5d1620f" class="outline-4">
<h4 id="org5d1620f"><span class="section-number-4">3.5.1</span> Introduction</h4>
<div id="outline-container-org1d959e6" class="outline-4">
<h4 id="org1d959e6"><span class="section-number-4">3.5.1</span> Introduction</h4>
<div class="outline-text-4" id="text-3-5-1">
<p>
This section concerns API calls related to datasets of strings.
@ -2361,8 +2361,8 @@ This section concerns API calls related to datasets of strings.
</div>
</div>
<div id="outline-container-org20560a9" class="outline-4">
<h4 id="org20560a9"><span class="section-number-4">3.5.2</span> C templates for front end</h4>
<div id="outline-container-org1d442a1" class="outline-4">
<h4 id="org1d442a1"><span class="section-number-4">3.5.2</span> C templates for front end</h4>
<div class="outline-text-4" id="text-3-5-2">
<p>
First parameter is the <code>TREXIO</code> file handle. Second parameter is the variable to be written/read
@ -2604,8 +2604,8 @@ to/from the <code>TREXIO</code> file (except for <code>trexio_has_</code> functi
</div>
</div>
<div id="outline-container-org622064d" class="outline-4">
<h4 id="org622064d"><span class="section-number-4">3.5.3</span> Fortran templates for front end</h4>
<div id="outline-container-org4b6d7e7" class="outline-4">
<h4 id="org4b6d7e7"><span class="section-number-4">3.5.3</span> Fortran templates for front end</h4>
<div class="outline-text-4" id="text-3-5-3">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
@ -2702,12 +2702,12 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-org86e77d2" class="outline-3">
<h3 id="org86e77d2"><span class="section-number-3">3.6</span> Templates for front end has/read/write a single string attribute</h3>
<div id="outline-container-org69213b3" class="outline-3">
<h3 id="org69213b3"><span class="section-number-3">3.6</span> Templates for front end has/read/write a single string attribute</h3>
<div class="outline-text-3" id="text-3-6">
</div>
<div id="outline-container-org81bb49a" class="outline-4">
<h4 id="org81bb49a"><span class="section-number-4">3.6.1</span> Introduction</h4>
<div id="outline-container-org6151130" class="outline-4">
<h4 id="org6151130"><span class="section-number-4">3.6.1</span> Introduction</h4>
<div class="outline-text-4" id="text-3-6-1">
<p>
This section concerns API calls related to string attributes.
@ -2747,8 +2747,8 @@ This section concerns API calls related to string attributes.
</div>
</div>
<div id="outline-container-org8bf59e3" class="outline-4">
<h4 id="org8bf59e3"><span class="section-number-4">3.6.2</span> C templates for front end</h4>
<div id="outline-container-orgc74a2f9" class="outline-4">
<h4 id="orgc74a2f9"><span class="section-number-4">3.6.2</span> C templates for front end</h4>
<div class="outline-text-4" id="text-3-6-2">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -2846,8 +2846,8 @@ This section concerns API calls related to string attributes.
</div>
</div>
<div id="outline-container-org9337deb" class="outline-4">
<h4 id="org9337deb"><span class="section-number-4">3.6.3</span> Fortran templates for front end</h4>
<div id="outline-container-org6063c02" class="outline-4">
<h4 id="org6063c02"><span class="section-number-4">3.6.3</span> Fortran templates for front end</h4>
<div class="outline-text-4" id="text-3-6-3">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
@ -2926,8 +2926,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-org0b34c9d" class="outline-2">
<h2 id="org0b34c9d"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div id="outline-container-orge50880f" class="outline-2">
<h2 id="orge50880f"><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.
@ -3061,7 +3061,7 @@ two code are identical, i.e. if the <code>assert</code> statement pass.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-16 Wed 10:21</p>
<p class="date">Created: 2021-06-16 Wed 12:05</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

52
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-16 Wed 10:21 -->
<!-- 2021-06-16 Wed 12:05 -->
<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,27 +311,27 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgaec9b1b">1. HDF5 back end</a>
<li><a href="#org152d527">1. HDF5 back end</a>
<ul>
<li><a href="#orgbd862dd">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org5b4d156">1.2. Template for HDF5 structures</a></li>
<li><a href="#org0ca4412">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org32c0e96">1.4. Template for HDF5 has/read/write a single dimensioning variable</a></li>
<li><a href="#orgf34f1ba">1.5. Template for HDF5 has/read/write a dataset of numerical data</a></li>
<li><a href="#org5080381">1.6. Template for HDF5 has/read/write a dataset of strings</a></li>
<li><a href="#org48583a1">1.7. Template for HDF5 has/read/write a single string attribute</a></li>
<li><a href="#orgec79105">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org65f333a">1.2. Template for HDF5 structures</a></li>
<li><a href="#org9f897c6">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org8c32954">1.4. Template for HDF5 has/read/write a single dimensioning variable</a></li>
<li><a href="#orgb1310ea">1.5. Template for HDF5 has/read/write a dataset of numerical data</a></li>
<li><a href="#org9c7c3c8">1.6. Template for HDF5 has/read/write a dataset of strings</a></li>
<li><a href="#org5eeb6b6">1.7. Template for HDF5 has/read/write a single string attribute</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-orgaec9b1b" class="outline-2">
<h2 id="orgaec9b1b"><span class="section-number-2">1</span> HDF5 back end</h2>
<div id="outline-container-org152d527" class="outline-2">
<h2 id="org152d527"><span class="section-number-2">1</span> HDF5 back end</h2>
<div class="outline-text-2" id="text-1">
</div>
<div id="outline-container-orgbd862dd" class="outline-3">
<h3 id="orgbd862dd"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div id="outline-container-orgec79105" class="outline-3">
<h3 id="orgec79105"><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>
@ -343,8 +343,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org5b4d156" class="outline-3">
<h3 id="org5b4d156"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div id="outline-container-org65f333a" class="outline-3">
<h3 id="org65f333a"><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> {
@ -359,8 +359,8 @@ for the JavaScript code in this tag.
</div>
<div id="outline-container-org0ca4412" class="outline-3">
<h3 id="org0ca4412"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
<div id="outline-container-org9f897c6" class="outline-3">
<h3 id="org9f897c6"><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>
@ -440,8 +440,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org32c0e96" class="outline-3">
<h3 id="org32c0e96"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a single dimensioning variable</h3>
<div id="outline-container-org8c32954" class="outline-3">
<h3 id="org8c32954"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a single dimensioning variable</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>
@ -566,8 +566,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-orgf34f1ba" class="outline-3">
<h3 id="orgf34f1ba"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset of numerical data</h3>
<div id="outline-container-orgb1310ea" class="outline-3">
<h3 id="orgb1310ea"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset of numerical data</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>
@ -696,8 +696,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org5080381" class="outline-3">
<h3 id="org5080381"><span class="section-number-3">1.6</span> Template for HDF5 has/read/write a dataset of strings</h3>
<div id="outline-container-org9c7c3c8" class="outline-3">
<h3 id="org9c7c3c8"><span class="section-number-3">1.6</span> Template for HDF5 has/read/write a dataset of strings</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>
@ -901,8 +901,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org48583a1" class="outline-3">
<h3 id="org48583a1"><span class="section-number-3">1.7</span> Template for HDF5 has/read/write a single string attribute</h3>
<div id="outline-container-org5eeb6b6" class="outline-3">
<h3 id="org5eeb6b6"><span class="section-number-3">1.7</span> Template for HDF5 has/read/write a single string attribute</h3>
<div class="outline-text-3" id="text-1-7">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1029,7 +1029,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-16 Wed 10:21</p>
<p class="date">Created: 2021-06-16 Wed 12:05</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

112
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-16 Wed 10:21 -->
<!-- 2021-06-16 Wed 12:05 -->
<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,26 +311,26 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org83270c0">1. TEXT back end</a>
<li><a href="#org54cf644">1. TEXT back end</a>
<ul>
<li><a href="#org78f4626">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org69d0a9e">1.2. Template for general structure in text back end</a></li>
<li><a href="#org3e0b323">1.3. Initialize function (constant part)</a></li>
<li><a href="#orgfd200ea">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org168727f">1.5. Template for text read struct</a></li>
<li><a href="#orga09a650">1.6. Template for text flush struct</a></li>
<li><a href="#org96ad6a9">1.7. Template for text free memory</a></li>
<li><a href="#org448be9e">1.8. Template for has/read/write the num attribute</a></li>
<li><a href="#orgc2d6bec">1.9. Template for has/read/write the dataset of numerical data</a></li>
<li><a href="#org27c32f5">1.10. Template for has/read/write the dataset of strings</a></li>
<li><a href="#org5f56f4d">1.11. Template for has/read/write the string attribute</a></li>
<li><a href="#org80e844a">1.12. RDM struct (hard-coded)</a>
<li><a href="#org9424ef1">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#orgf137b6b">1.2. Template for general structure in text back end</a></li>
<li><a href="#org537ec52">1.3. Initialize function (constant part)</a></li>
<li><a href="#org94f503c">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org5a9bc32">1.5. Template for text read struct</a></li>
<li><a href="#orge88118a">1.6. Template for text flush struct</a></li>
<li><a href="#org54990d1">1.7. Template for text free memory</a></li>
<li><a href="#org1fd34c7">1.8. Template for has/read/write the num attribute</a></li>
<li><a href="#orgd1e8a28">1.9. Template for has/read/write the dataset of numerical data</a></li>
<li><a href="#org863869b">1.10. Template for has/read/write the dataset of strings</a></li>
<li><a href="#org134b1de">1.11. Template for has/read/write the string attribute</a></li>
<li><a href="#org443f3ae">1.12. RDM struct (hard-coded)</a>
<ul>
<li><a href="#org7525339">1.12.1. Read the complete struct</a></li>
<li><a href="#org6eb132f">1.12.2. Flush the complete struct</a></li>
<li><a href="#orgaa11477">1.12.3. Free memory</a></li>
<li><a href="#org1a16619">1.12.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org690c40a">1.12.5. Read/Write the two<sub>e</sub> attribute</a></li>
<li><a href="#org15b7305">1.12.1. Read the complete struct</a></li>
<li><a href="#org18a61d2">1.12.2. Flush the complete struct</a></li>
<li><a href="#org0aaa542">1.12.3. Free memory</a></li>
<li><a href="#org35b53cd">1.12.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#orgcd65458">1.12.5. Read/Write the two<sub>e</sub> attribute</a></li>
</ul>
</li>
</ul>
@ -339,8 +339,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org83270c0" class="outline-2">
<h2 id="org83270c0"><span class="section-number-2">1</span> TEXT back end</h2>
<div id="outline-container-org54cf644" class="outline-2">
<h2 id="org54cf644"><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
@ -361,8 +361,8 @@ The file is written when closed, or when the flush function is called.
</p>
</div>
<div id="outline-container-org78f4626" class="outline-3">
<h3 id="org78f4626"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
<div id="outline-container-org9424ef1" class="outline-3">
<h3 id="org9424ef1"><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 {
@ -380,8 +380,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org69d0a9e" class="outline-3">
<h3 id="org69d0a9e"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
<div id="outline-container-orgf137b6b" class="outline-3">
<h3 id="orgf137b6b"><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> {
@ -407,8 +407,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org3e0b323" class="outline-3">
<h3 id="org3e0b323"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div id="outline-container-org537ec52" class="outline-3">
<h3 id="org537ec52"><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>
@ -509,8 +509,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-orgfd200ea" class="outline-3">
<h3 id="orgfd200ea"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div id="outline-container-org94f503c" class="outline-3">
<h3 id="org94f503c"><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>
@ -535,8 +535,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org168727f" class="outline-3">
<h3 id="org168727f"><span class="section-number-3">1.5</span> Template for text read struct</h3>
<div id="outline-container-org5a9bc32" class="outline-3">
<h3 id="org5a9bc32"><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*
@ -807,8 +807,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-orga09a650" class="outline-3">
<h3 id="orga09a650"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
<div id="outline-container-orge88118a" class="outline-3">
<h3 id="orge88118a"><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>
@ -872,8 +872,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-org96ad6a9" class="outline-3">
<h3 id="org96ad6a9"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div id="outline-container-org54990d1" class="outline-3">
<h3 id="org54990d1"><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.
@ -918,8 +918,8 @@ Memory is allocated when reading. The following function frees memory.
</div>
</div>
<div id="outline-container-org448be9e" class="outline-3">
<h3 id="org448be9e"><span class="section-number-3">1.8</span> Template for has/read/write the num attribute</h3>
<div id="outline-container-org1fd34c7" class="outline-3">
<h3 id="org1fd34c7"><span class="section-number-3">1.8</span> Template for has/read/write the num 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>
@ -981,8 +981,8 @@ Memory is allocated when reading. The following function frees memory.
</div>
</div>
<div id="outline-container-orgc2d6bec" class="outline-3">
<h3 id="orgc2d6bec"><span class="section-number-3">1.9</span> Template for has/read/write the dataset of numerical data</h3>
<div id="outline-container-orgd1e8a28" class="outline-3">
<h3 id="orgd1e8a28"><span class="section-number-3">1.9</span> Template for has/read/write the dataset of numerical data</h3>
<div class="outline-text-3" id="text-1-9">
<p>
The <code>group_dset</code> array is assumed allocated with the appropriate size.
@ -1078,8 +1078,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
</div>
<div id="outline-container-org27c32f5" class="outline-3">
<h3 id="org27c32f5"><span class="section-number-3">1.10</span> Template for has/read/write the dataset of strings</h3>
<div id="outline-container-org863869b" class="outline-3">
<h3 id="org863869b"><span class="section-number-3">1.10</span> Template for has/read/write the dataset of strings</h3>
<div class="outline-text-3" id="text-1-10">
<p>
The <code>group_dset</code> array is assumed allocated with the appropriate size.
@ -1181,8 +1181,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
</div>
<div id="outline-container-org5f56f4d" class="outline-3">
<h3 id="org5f56f4d"><span class="section-number-3">1.11</span> Template for has/read/write the string attribute</h3>
<div id="outline-container-org134b1de" class="outline-3">
<h3 id="org134b1de"><span class="section-number-3">1.11</span> Template for has/read/write the string attribute</h3>
<div class="outline-text-3" id="text-1-11">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -1256,12 +1256,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
</div>
<div id="outline-container-org80e844a" class="outline-3">
<h3 id="org80e844a"><span class="section-number-3">1.12</span> RDM struct (hard-coded)</h3>
<div id="outline-container-org443f3ae" class="outline-3">
<h3 id="org443f3ae"><span class="section-number-3">1.12</span> RDM struct (hard-coded)</h3>
<div class="outline-text-3" id="text-1-12">
</div>
<div id="outline-container-org7525339" class="outline-4">
<h4 id="org7525339"><span class="section-number-4">1.12.1</span> Read the complete struct</h4>
<div id="outline-container-org15b7305" class="outline-4">
<h4 id="org15b7305"><span class="section-number-4">1.12.1</span> Read the complete struct</h4>
<div class="outline-text-4" id="text-1-12-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>);
@ -1356,8 +1356,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-org6eb132f" class="outline-4">
<h4 id="org6eb132f"><span class="section-number-4">1.12.2</span> Flush the complete struct</h4>
<div id="outline-container-org18a61d2" class="outline-4">
<h4 id="org18a61d2"><span class="section-number-4">1.12.2</span> Flush the complete struct</h4>
<div class="outline-text-4" id="text-1-12-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>);
@ -1399,8 +1399,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-orgaa11477" class="outline-4">
<h4 id="orgaa11477"><span class="section-number-4">1.12.3</span> Free memory</h4>
<div id="outline-container-org0aaa542" class="outline-4">
<h4 id="org0aaa542"><span class="section-number-4">1.12.3</span> Free memory</h4>
<div class="outline-text-4" id="text-1-12-3">
<p>
Memory is allocated when reading. The followig function frees memory.
@ -1436,8 +1436,8 @@ Memory is allocated when reading. The followig function frees memory.
</div>
</div>
<div id="outline-container-org1a16619" class="outline-4">
<h4 id="org1a16619"><span class="section-number-4">1.12.4</span> Read/Write the one<sub>e</sub> attribute</h4>
<div id="outline-container-org35b53cd" class="outline-4">
<h4 id="org35b53cd"><span class="section-number-4">1.12.4</span> Read/Write the one<sub>e</sub> attribute</h4>
<div class="outline-text-4" id="text-1-12-4">
<p>
The <code>one_e</code> array is assumed allocated with the appropriate size.
@ -1503,8 +1503,8 @@ The <code>one_e</code> array is assumed allocated with the appropriate size.
</div>
</div>
<div id="outline-container-org690c40a" class="outline-4">
<h4 id="org690c40a"><span class="section-number-4">1.12.5</span> Read/Write the two<sub>e</sub> attribute</h4>
<div id="outline-container-orgcd65458" class="outline-4">
<h4 id="orgcd65458"><span class="section-number-4">1.12.5</span> Read/Write the two<sub>e</sub> attribute</h4>
<div class="outline-text-4" id="text-1-12-5">
<p>
<code>two_e</code> is a sparse data structure, which can be too large to fit
@ -1612,7 +1612,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-16 Wed 10:21</p>
<p class="date">Created: 2021-06-16 Wed 12:05</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>