TREX/trexio
1
0
Fork 0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-10-02 14:31:05 +02:00
Code Issues Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
q-posev 2021-06-25 12:16:48 +00:00
parent 0766555a92
commit 7dce17951b
7 changed files with 1707 additions and 181 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-25 Fri 11:33 -->
<!-- 2021-06-25 Fri 12:16 -->
<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>
@ -342,7 +342,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-25 Fri 11:33</p>
<p class="date">Created: 2021-06-25 Fri 12:16</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

16
Sparse.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-25 Fri 11:33 -->
<!-- 2021-06-25 Fri 12:16 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>&lrm;</title>
@ -232,8 +232,8 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org1374a1a">1. Text back end</a></li>
<li><a href="#orge4a0cac">2. HDF5 Back end</a></li>
<li><a href="#org5e55320">1. Text back end</a></li>
<li><a href="#orge7dce7e">2. HDF5 Back end</a></li>
</ul>
</div>
</div>
@ -241,8 +241,8 @@ for the JavaScript code in this tag.
See templator<sub>front.org</sub>
</p>
<div id="outline-container-org1374a1a" class="outline-2">
<h2 id="org1374a1a"><span class="section-number-2">1</span> Text back end</h2>
<div id="outline-container-org5e55320" class="outline-2">
<h2 id="org5e55320"><span class="section-number-2">1</span> Text back end</h2>
<div class="outline-text-2" id="text-1">
<p>
As the size of the dataset should be extensible, the simplest
@ -256,8 +256,8 @@ The offset can be used with <code>fseek(69L*offset, SEEK_SET)</code>
</div>
</div>
<div id="outline-container-orge4a0cac" class="outline-2">
<h2 id="orge4a0cac"><span class="section-number-2">2</span> HDF5 Back end</h2>
<div id="outline-container-orge7dce7e" class="outline-2">
<h2 id="orge7dce7e"><span class="section-number-2">2</span> HDF5 Back end</h2>
<div class="outline-text-2" id="text-2">
<p>
We need to declare the number of rows of the dataset as
@ -278,7 +278,7 @@ If the offset+num &gt; nmax, we need to extend the dataset.
</div>
</div>
<div id="postamble" class="status">
<p class="date">Created: 2021-06-25 Fri 11:33</p>
<p class="date">Created: 2021-06-25 Fri 12:16</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-25 Fri 11:33 -->
<!-- 2021-06-25 Fri 12:16 -->
<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>
@ -342,7 +342,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-25 Fri 11:33</p>
<p class="date">Created: 2021-06-25 Fri 12:16</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-25 Fri 11:33 -->
<!-- 2021-06-25 Fri 12:16 -->
<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="#orgacac099">1. Coding conventions</a>
<li><a href="#orgabded4c">1. Coding conventions</a>
<ul>
<li><a href="#org5970039">1.1. Memory allocation</a></li>
<li><a href="#orga43d747">1.1. Memory allocation</a></li>
</ul>
</li>
<li><a href="#org9eba1ef">2. Front end</a>
<li><a href="#orgbbcd004">2. Front end</a>
<ul>
<li><a href="#orgd85e29d">2.1. Error handling</a></li>
<li><a href="#orgdaca657">2.2. Back ends</a></li>
<li><a href="#org03b7d19">2.3. Read/write behavior</a></li>
<li><a href="#org6048754">2.4. TREXIO file type</a></li>
<li><a href="#orge9bb969">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org5fd2a0b">2.6. File opening</a></li>
<li><a href="#org4a01f00">2.7. File closing</a></li>
<li><a href="#org51cecf6">2.1. Error handling</a></li>
<li><a href="#orgdce18d1">2.2. Back ends</a></li>
<li><a href="#org06e65a3">2.3. Read/write behavior</a></li>
<li><a href="#orgc1dbed6">2.4. TREXIO file type</a></li>
<li><a href="#orgf66f730">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org6712cea">2.6. File opening</a></li>
<li><a href="#orgffd2801">2.7. File closing</a></li>
</ul>
</li>
<li><a href="#orgb6a6afd">3. Templates for front end</a>
<li><a href="#orga724746">3. Templates for front end</a>
<ul>
<li><a href="#org6c90d82">3.1. Description</a></li>
<li><a href="#org3091a1a">3.2. Templates for front end has/read/write a single dimensioning variable</a>
<li><a href="#orgdfaaaf2">3.1. Description</a></li>
<li><a href="#orgb838e66">3.2. Templates for front end has/read/write a single dimensioning variable</a>
<ul>
<li><a href="#org43b4d3f">3.2.1. C templates for front end</a></li>
<li><a href="#org2006186">3.2.2. Fortran templates for front end</a></li>
<li><a href="#orga0c288d">3.2.1. C templates for front end</a></li>
<li><a href="#org63ab490">3.2.2. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#org5d1ee16">3.3. Templates for front end has/read/write a dataset of numerical data</a>
<li><a href="#org558b480">3.3. Templates for front end has/read/write a dataset of numerical data</a>
<ul>
<li><a href="#org7ffc03c">3.3.1. C templates for front end</a></li>
<li><a href="#org51abf24">3.3.2. Fortran templates for front end</a></li>
<li><a href="#org3cc007c">3.3.1. C templates for front end</a></li>
<li><a href="#org71c9d47">3.3.2. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#org4965135">3.4. Sparse data structures</a></li>
<li><a href="#org62e0fac">3.5. Templates for front end has/read/write a dataset of strings</a>
<li><a href="#orgfce8bff">3.4. Sparse data structures</a></li>
<li><a href="#orgc4ba5ad">3.5. Templates for front end has/read/write a dataset of strings</a>
<ul>
<li><a href="#org3ff3ff9">3.5.1. Introduction</a></li>
<li><a href="#org878f017">3.5.2. C templates for front end</a></li>
<li><a href="#orgcd933e5">3.5.3. Fortran templates for front end</a></li>
<li><a href="#org3799822">3.5.1. Introduction</a></li>
<li><a href="#org3b5c6a2">3.5.2. C templates for front end</a></li>
<li><a href="#orgd8931b8">3.5.3. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#org713373e">3.6. Templates for front end has/read/write a single string attribute</a>
<li><a href="#org3b0b7ca">3.6. Templates for front end has/read/write a single string attribute</a>
<ul>
<li><a href="#org3d2e75a">3.6.1. Introduction</a></li>
<li><a href="#org5e20ff8">3.6.2. C templates for front end</a></li>
<li><a href="#org1a652b8">3.6.3. Fortran templates for front end</a></li>
<li><a href="#org4f8aae2">3.6.1. Introduction</a></li>
<li><a href="#org6adfbd2">3.6.2. C templates for front end</a></li>
<li><a href="#orge303c66">3.6.3. Fortran templates for front end</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#org2606815">4. Fortran helper/wrapper functions</a></li>
<li><a href="#orgdd229fa">4. Fortran helper/wrapper functions</a></li>
</ul>
</div>
</div>
<div id="outline-container-orgacac099" class="outline-2">
<h2 id="orgacac099"><span class="section-number-2">1</span> Coding conventions</h2>
<div id="outline-container-orgabded4c" class="outline-2">
<h2 id="orgabded4c"><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-org5970039" class="outline-3">
<h3 id="org5970039"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div id="outline-container-orga43d747" class="outline-3">
<h3 id="orga43d747"><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-org9eba1ef" class="outline-2">
<h2 id="org9eba1ef"><span class="section-number-2">2</span> Front end</h2>
<div id="outline-container-orgbbcd004" class="outline-2">
<h2 id="orgbbcd004"><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-orgd85e29d" class="outline-3">
<h3 id="orgd85e29d"><span class="section-number-3">2.1</span> Error handling</h3>
<div id="outline-container-org51cecf6" class="outline-3">
<h3 id="org51cecf6"><span class="section-number-3">2.1</span> Error handling</h3>
<div class="outline-text-3" id="text-2-1">
<table id="org4f205c1" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="org5998135" 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-orgdaca657" class="outline-3">
<h3 id="orgdaca657"><span class="section-number-3">2.2</span> Back ends</h3>
<div id="outline-container-orgdce18d1" class="outline-3">
<h3 id="orgdce18d1"><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-org03b7d19" class="outline-3">
<h3 id="org03b7d19"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div id="outline-container-org06e65a3" class="outline-3">
<h3 id="org06e65a3"><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-org6048754" class="outline-3">
<h3 id="org6048754"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div id="outline-container-orgc1dbed6" class="outline-3">
<h3 id="orgc1dbed6"><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-orge9bb969" class="outline-3">
<h3 id="orge9bb969"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div id="outline-container-orgf66f730" class="outline-3">
<h3 id="orgf66f730"><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-org5fd2a0b" class="outline-3">
<h3 id="org5fd2a0b"><span class="section-number-3">2.6</span> File opening</h3>
<div id="outline-container-org6712cea" class="outline-3">
<h3 id="org6712cea"><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-org4a01f00" class="outline-3">
<h3 id="org4a01f00"><span class="section-number-3">2.7</span> File closing</h3>
<div id="outline-container-orgffd2801" class="outline-3">
<h3 id="orgffd2801"><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-orgb6a6afd" class="outline-2">
<h2 id="orgb6a6afd"><span class="section-number-2">3</span> Templates for front end</h2>
<div id="outline-container-orga724746" class="outline-2">
<h2 id="orga724746"><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-org6c90d82" class="outline-3">
<h3 id="org6c90d82"><span class="section-number-3">3.1</span> Description</h3>
<div id="outline-container-orgdfaaaf2" class="outline-3">
<h3 id="orgdfaaaf2"><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-org3091a1a" class="outline-3">
<h3 id="org3091a1a"><span class="section-number-3">3.2</span> Templates for front end has/read/write a single dimensioning variable</h3>
<div id="outline-container-orgb838e66" class="outline-3">
<h3 id="orgb838e66"><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-org43b4d3f" class="outline-4">
<h4 id="org43b4d3f"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
<div id="outline-container-orga0c288d" class="outline-4">
<h4 id="orga0c288d"><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-org2006186" class="outline-4">
<h4 id="org2006186"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
<div id="outline-container-org63ab490" class="outline-4">
<h4 id="org63ab490"><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-org5d1ee16" class="outline-3">
<h3 id="org5d1ee16"><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-org558b480" class="outline-3">
<h3 id="org558b480"><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-org7ffc03c" class="outline-4">
<h4 id="org7ffc03c"><span class="section-number-4">3.3.1</span> C templates for front end</h4>
<div id="outline-container-org3cc007c" class="outline-4">
<h4 id="org3cc007c"><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-org51abf24" class="outline-4">
<h4 id="org51abf24"><span class="section-number-4">3.3.2</span> Fortran templates for front end</h4>
<div id="outline-container-org71c9d47" class="outline-4">
<h4 id="org71c9d47"><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-org4965135" class="outline-3">
<h3 id="org4965135"><span class="section-number-3">3.4</span> Sparse data structures</h3>
<div id="outline-container-orgfce8bff" class="outline-3">
<h3 id="orgfce8bff"><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-org62e0fac" class="outline-3">
<h3 id="org62e0fac"><span class="section-number-3">3.5</span> Templates for front end has/read/write a dataset of strings</h3>
<div id="outline-container-orgc4ba5ad" class="outline-3">
<h3 id="orgc4ba5ad"><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-org3ff3ff9" class="outline-4">
<h4 id="org3ff3ff9"><span class="section-number-4">3.5.1</span> Introduction</h4>
<div id="outline-container-org3799822" class="outline-4">
<h4 id="org3799822"><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-org878f017" class="outline-4">
<h4 id="org878f017"><span class="section-number-4">3.5.2</span> C templates for front end</h4>
<div id="outline-container-org3b5c6a2" class="outline-4">
<h4 id="org3b5c6a2"><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
@ -2605,8 +2605,8 @@ to/from the <code>TREXIO</code> file (except for <code>trexio_has_</code> functi
</div>
</div>
<div id="outline-container-orgcd933e5" class="outline-4">
<h4 id="orgcd933e5"><span class="section-number-4">3.5.3</span> Fortran templates for front end</h4>
<div id="outline-container-orgd8931b8" class="outline-4">
<h4 id="orgd8931b8"><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>.
@ -2703,12 +2703,12 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-org713373e" class="outline-3">
<h3 id="org713373e"><span class="section-number-3">3.6</span> Templates for front end has/read/write a single string attribute</h3>
<div id="outline-container-org3b0b7ca" class="outline-3">
<h3 id="org3b0b7ca"><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-org3d2e75a" class="outline-4">
<h4 id="org3d2e75a"><span class="section-number-4">3.6.1</span> Introduction</h4>
<div id="outline-container-org4f8aae2" class="outline-4">
<h4 id="org4f8aae2"><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.
@ -2748,8 +2748,8 @@ This section concerns API calls related to string attributes.
</div>
</div>
<div id="outline-container-org5e20ff8" class="outline-4">
<h4 id="org5e20ff8"><span class="section-number-4">3.6.2</span> C templates for front end</h4>
<div id="outline-container-org6adfbd2" class="outline-4">
<h4 id="org6adfbd2"><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>
@ -2849,8 +2849,8 @@ This section concerns API calls related to string attributes.
</div>
</div>
<div id="outline-container-org1a652b8" class="outline-4">
<h4 id="org1a652b8"><span class="section-number-4">3.6.3</span> Fortran templates for front end</h4>
<div id="outline-container-orge303c66" class="outline-4">
<h4 id="orge303c66"><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.
@ -2929,8 +2929,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-org2606815" class="outline-2">
<h2 id="org2606815"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div id="outline-container-orgdd229fa" class="outline-2">
<h2 id="orgdd229fa"><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.
@ -3064,7 +3064,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-25 Fri 11:33</p>
<p class="date">Created: 2021-06-25 Fri 12:16</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-25 Fri 11:33 -->
<!-- 2021-06-25 Fri 12:16 -->
<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="#org5445da1">1. HDF5 back end</a>
<li><a href="#org23eccc0">1. HDF5 back end</a>
<ul>
<li><a href="#org6dbb574">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org41ced8d">1.2. Template for HDF5 structures</a></li>
<li><a href="#org83240b5">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org24a57c3">1.4. Template for HDF5 has/read/write a single dimensioning variable</a></li>
<li><a href="#org6cefa5c">1.5. Template for HDF5 has/read/write a dataset of numerical data</a></li>
<li><a href="#orgf808287">1.6. Template for HDF5 has/read/write a dataset of strings</a></li>
<li><a href="#orgbe00acb">1.7. Template for HDF5 has/read/write a single string attribute</a></li>
<li><a href="#org4b68ad3">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org7b90a90">1.2. Template for HDF5 structures</a></li>
<li><a href="#org5b86fe7">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org7089349">1.4. Template for HDF5 has/read/write a single dimensioning variable</a></li>
<li><a href="#orgc4ae520">1.5. Template for HDF5 has/read/write a dataset of numerical data</a></li>
<li><a href="#orgca125f2">1.6. Template for HDF5 has/read/write a dataset of strings</a></li>
<li><a href="#org8a085df">1.7. Template for HDF5 has/read/write a single string attribute</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-org5445da1" class="outline-2">
<h2 id="org5445da1"><span class="section-number-2">1</span> HDF5 back end</h2>
<div id="outline-container-org23eccc0" class="outline-2">
<h2 id="org23eccc0"><span class="section-number-2">1</span> HDF5 back end</h2>
<div class="outline-text-2" id="text-1">
</div>
<div id="outline-container-org6dbb574" class="outline-3">
<h3 id="org6dbb574"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div id="outline-container-org4b68ad3" class="outline-3">
<h3 id="org4b68ad3"><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-org41ced8d" class="outline-3">
<h3 id="org41ced8d"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div id="outline-container-org7b90a90" class="outline-3">
<h3 id="org7b90a90"><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-org83240b5" class="outline-3">
<h3 id="org83240b5"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
<div id="outline-container-org5b86fe7" class="outline-3">
<h3 id="org5b86fe7"><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-org24a57c3" class="outline-3">
<h3 id="org24a57c3"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a single dimensioning variable</h3>
<div id="outline-container-org7089349" class="outline-3">
<h3 id="org7089349"><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>
@ -557,8 +557,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org6cefa5c" class="outline-3">
<h3 id="org6cefa5c"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset of numerical data</h3>
<div id="outline-container-orgc4ae520" class="outline-3">
<h3 id="orgc4ae520"><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>
@ -687,8 +687,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-orgf808287" class="outline-3">
<h3 id="orgf808287"><span class="section-number-3">1.6</span> Template for HDF5 has/read/write a dataset of strings</h3>
<div id="outline-container-orgca125f2" class="outline-3">
<h3 id="orgca125f2"><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>
@ -892,8 +892,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-orgbe00acb" class="outline-3">
<h3 id="orgbe00acb"><span class="section-number-3">1.7</span> Template for HDF5 has/read/write a single string attribute</h3>
<div id="outline-container-org8a085df" class="outline-3">
<h3 id="org8a085df"><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>
@ -1020,7 +1020,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-25 Fri 11:33</p>
<p class="date">Created: 2021-06-25 Fri 12:16</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-25 Fri 11:33 -->
<!-- 2021-06-25 Fri 12:16 -->
<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="#orgdab62b2">1. TEXT back end</a>
<li><a href="#orgee2de4d">1. TEXT back end</a>
<ul>
<li><a href="#orgfdaa1dc">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#orgf88472a">1.2. Template for general structure in text back end</a></li>
<li><a href="#orgd224c6d">1.3. Initialize function (constant part)</a></li>
<li><a href="#org0066507">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org00db74f">1.5. Template for text read struct</a></li>
<li><a href="#orgbcc04cd">1.6. Template for text flush struct</a></li>
<li><a href="#orgc907663">1.7. Template for text free memory</a></li>
<li><a href="#org5c9c613">1.8. Template for has/read/write the num attribute</a></li>
<li><a href="#org10d1e8e">1.9. Template for has/read/write the dataset of numerical data</a></li>
<li><a href="#org0ccfbf1">1.10. Template for has/read/write the dataset of strings</a></li>
<li><a href="#orgabef7de">1.11. Template for has/read/write the string attribute</a></li>
<li><a href="#org381622f">1.12. RDM struct (hard-coded)</a>
<li><a href="#org5fde2f7">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#orgb499cbb">1.2. Template for general structure in text back end</a></li>
<li><a href="#org60de191">1.3. Initialize function (constant part)</a></li>
<li><a href="#orgdc87597">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org7161abf">1.5. Template for text read struct</a></li>
<li><a href="#orga56f594">1.6. Template for text flush struct</a></li>
<li><a href="#org8f0bfde">1.7. Template for text free memory</a></li>
<li><a href="#org19a15ad">1.8. Template for has/read/write the num attribute</a></li>
<li><a href="#org40a96fb">1.9. Template for has/read/write the dataset of numerical data</a></li>
<li><a href="#org19b8b76">1.10. Template for has/read/write the dataset of strings</a></li>
<li><a href="#org34b9920">1.11. Template for has/read/write the string attribute</a></li>
<li><a href="#orge268680">1.12. RDM struct (hard-coded)</a>
<ul>
<li><a href="#orge592c72">1.12.1. Read the complete struct</a></li>
<li><a href="#orgf5b0948">1.12.2. Flush the complete struct</a></li>
<li><a href="#org43f2d01">1.12.3. Free memory</a></li>
<li><a href="#orgaa70280">1.12.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org5c48fec">1.12.5. Read/Write the two<sub>e</sub> attribute</a></li>
<li><a href="#org371643b">1.12.1. Read the complete struct</a></li>
<li><a href="#org7bc53c2">1.12.2. Flush the complete struct</a></li>
<li><a href="#orge1847f0">1.12.3. Free memory</a></li>
<li><a href="#orgd7043b7">1.12.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#orga84a050">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-orgdab62b2" class="outline-2">
<h2 id="orgdab62b2"><span class="section-number-2">1</span> TEXT back end</h2>
<div id="outline-container-orgee2de4d" class="outline-2">
<h2 id="orgee2de4d"><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-orgfdaa1dc" class="outline-3">
<h3 id="orgfdaa1dc"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
<div id="outline-container-org5fde2f7" class="outline-3">
<h3 id="org5fde2f7"><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-orgf88472a" class="outline-3">
<h3 id="orgf88472a"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
<div id="outline-container-orgb499cbb" class="outline-3">
<h3 id="orgb499cbb"><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-orgd224c6d" class="outline-3">
<h3 id="orgd224c6d"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div id="outline-container-org60de191" class="outline-3">
<h3 id="org60de191"><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-org0066507" class="outline-3">
<h3 id="org0066507"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div id="outline-container-orgdc87597" class="outline-3">
<h3 id="orgdc87597"><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-org00db74f" class="outline-3">
<h3 id="org00db74f"><span class="section-number-3">1.5</span> Template for text read struct</h3>
<div id="outline-container-org7161abf" class="outline-3">
<h3 id="org7161abf"><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-orgbcc04cd" class="outline-3">
<h3 id="orgbcc04cd"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
<div id="outline-container-orga56f594" class="outline-3">
<h3 id="orga56f594"><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-orgc907663" class="outline-3">
<h3 id="orgc907663"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div id="outline-container-org8f0bfde" class="outline-3">
<h3 id="org8f0bfde"><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-org5c9c613" class="outline-3">
<h3 id="org5c9c613"><span class="section-number-3">1.8</span> Template for has/read/write the num attribute</h3>
<div id="outline-container-org19a15ad" class="outline-3">
<h3 id="org19a15ad"><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-org10d1e8e" class="outline-3">
<h3 id="org10d1e8e"><span class="section-number-3">1.9</span> Template for has/read/write the dataset of numerical data</h3>
<div id="outline-container-org40a96fb" class="outline-3">
<h3 id="org40a96fb"><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-org0ccfbf1" class="outline-3">
<h3 id="org0ccfbf1"><span class="section-number-3">1.10</span> Template for has/read/write the dataset of strings</h3>
<div id="outline-container-org19b8b76" class="outline-3">
<h3 id="org19b8b76"><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-orgabef7de" class="outline-3">
<h3 id="orgabef7de"><span class="section-number-3">1.11</span> Template for has/read/write the string attribute</h3>
<div id="outline-container-org34b9920" class="outline-3">
<h3 id="org34b9920"><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-org381622f" class="outline-3">
<h3 id="org381622f"><span class="section-number-3">1.12</span> RDM struct (hard-coded)</h3>
<div id="outline-container-orge268680" class="outline-3">
<h3 id="orge268680"><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-orge592c72" class="outline-4">
<h4 id="orge592c72"><span class="section-number-4">1.12.1</span> Read the complete struct</h4>
<div id="outline-container-org371643b" class="outline-4">
<h4 id="org371643b"><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-orgf5b0948" class="outline-4">
<h4 id="orgf5b0948"><span class="section-number-4">1.12.2</span> Flush the complete struct</h4>
<div id="outline-container-org7bc53c2" class="outline-4">
<h4 id="org7bc53c2"><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-org43f2d01" class="outline-4">
<h4 id="org43f2d01"><span class="section-number-4">1.12.3</span> Free memory</h4>
<div id="outline-container-orge1847f0" class="outline-4">
<h4 id="orge1847f0"><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-orgaa70280" class="outline-4">
<h4 id="orgaa70280"><span class="section-number-4">1.12.4</span> Read/Write the one<sub>e</sub> attribute</h4>
<div id="outline-container-orgd7043b7" class="outline-4">
<h4 id="orgd7043b7"><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-org5c48fec" class="outline-4">
<h4 id="org5c48fec"><span class="section-number-4">1.12.5</span> Read/Write the two<sub>e</sub> attribute</h4>
<div id="outline-container-orga84a050" class="outline-4">
<h4 id="orga84a050"><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-25 Fri 11:33</p>
<p class="date">Created: 2021-06-25 Fri 12:16</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

1526
trex.html Normal file
View File

File diff suppressed because it is too large Load Diff