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@fe4a4fa99b 🚀

Browse Source
This commit is contained in:
scemama 2021-06-09 14:58:26 +00:00
parent d6d19f9918
commit d788f33d9d
5 changed files with 137 additions and 137 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"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-06-07 Mon 12:06 --> <!-- 2021-06-09 Wed 14:58 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREXIO source code documentation</title> <title>TREXIO source code documentation</title>
@ -341,7 +341,7 @@ and bug reports should be submitted at
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-07 Mon 12:06</p> <p class="date">Created: 2021-06-09 Wed 14:58</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

4
index.html
View File

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

126
templator_front.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-06-07 Mon 12:06 --> <!-- 2021-06-09 Wed 14:58 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Front end API</title> <title>Front end API</title>
@ -333,47 +333,47 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org8232752">1. Coding conventions</a> <li><a href="#org6d82fe2">1. Coding conventions</a>
<ul> <ul>
<li><a href="#orgbdc0abb">1.1. Memory allocation</a></li> <li><a href="#org844b53b">1.1. Memory allocation</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orga4e45c8">2. Front end</a> <li><a href="#org676c9b2">2. Front end</a>
<ul> <ul>
<li><a href="#orgc18ac05">2.1. Error handling</a></li> <li><a href="#org8db0541">2.1. Error handling</a></li>
<li><a href="#orge40c06d">2.2. Back ends</a></li> <li><a href="#org27a960f">2.2. Back ends</a></li>
<li><a href="#orgf13f689">2.3. Read/write behavior</a></li> <li><a href="#org68e66b0">2.3. Read/write behavior</a></li>
<li><a href="#orgb27de2a">2.4. TREXIO file type</a></li> <li><a href="#org9fa3935">2.4. TREXIO file type</a></li>
<li><a href="#orga801619">2.5. Polymorphism of the file handle</a></li> <li><a href="#org3552fa9">2.5. Polymorphism of the file handle</a></li>
<li><a href="#orgdcc61c3">2.6. File opening</a></li> <li><a href="#org59ae030">2.6. File opening</a></li>
<li><a href="#org749b783">2.7. File closing</a></li> <li><a href="#orgf60c4c4">2.7. File closing</a></li>
<li><a href="#orga204e5c">2.8. C helper functions</a></li> <li><a href="#org2ff4b2e">2.8. C helper functions</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org80640b3">3. Templates for front end</a> <li><a href="#orgc74df05">3. Templates for front end</a>
<ul> <ul>
<li><a href="#orgbea2508">3.1. Templates for front end has/read/write a dimension</a> <li><a href="#org01189a1">3.1. Templates for front end has/read/write a dimension</a>
<ul> <ul>
<li><a href="#orgddad42a">3.1.1. C templates for front end</a></li> <li><a href="#orgae9ed3f">3.1.1. C templates for front end</a></li>
<li><a href="#orgc8f5289">3.1.2. Fortran templates for front end</a></li> <li><a href="#org3088cff">3.1.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org6b132ac">3.2. Templates for front end has/read/write a dataset</a> <li><a href="#orgcff2c9e">3.2. Templates for front end has/read/write a dataset</a>
<ul> <ul>
<li><a href="#orgd2e9221">3.2.1. C templates for front end</a></li> <li><a href="#org95517f5">3.2.1. C templates for front end</a></li>
<li><a href="#orga876f95">3.2.2. Fortran templates for front end</a></li> <li><a href="#org73a1525">3.2.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org49cc721">3.3. Sparse data structures</a></li> <li><a href="#org9f23637">3.3. Sparse data structures</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org576f410">4. Fortran helper/wrapper functions</a></li> <li><a href="#org2568822">4. Fortran helper/wrapper functions</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org8232752" class="outline-2"> <div id="outline-container-org6d82fe2" class="outline-2">
<h2 id="org8232752"><span class="section-number-2">1</span> Coding conventions</h2> <h2 id="org6d82fe2"><span class="section-number-2">1</span> Coding conventions</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<ul class="org-ul"> <ul class="org-ul">
<li>integer types will be defined using types given in <code>stdint.h</code></li> <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> </ul>
</div> </div>
<div id="outline-container-orgbdc0abb" class="outline-3"> <div id="outline-container-org844b53b" class="outline-3">
<h3 id="orgbdc0abb"><span class="section-number-3">1.1</span> Memory allocation</h3> <h3 id="org844b53b"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<p> <p>
Memory allocation of structures can be facilitated by using the 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> </div>
<div id="outline-container-orga4e45c8" class="outline-2"> <div id="outline-container-org676c9b2" class="outline-2">
<h2 id="orga4e45c8"><span class="section-number-2">2</span> Front end</h2> <h2 id="org676c9b2"><span class="section-number-2">2</span> Front end</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
All calls to TREXIO are thread-safe. All calls to TREXIO are thread-safe.
@ -433,10 +433,10 @@ TREXIO front end is modular, which simplifies implementation of new back ends.
</p> </p>
</div> </div>
<div id="outline-container-orgc18ac05" class="outline-3"> <div id="outline-container-org8db0541" class="outline-3">
<h3 id="orgc18ac05"><span class="section-number-3">2.1</span> Error handling</h3> <h3 id="org8db0541"><span class="section-number-3">2.1</span> Error handling</h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
<table id="orga79b728" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org8eb865e" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -727,8 +727,8 @@ The text strings are extracted from the previous table.
</div> </div>
</div> </div>
<div id="outline-container-orge40c06d" class="outline-3"> <div id="outline-container-org27a960f" class="outline-3">
<h3 id="orge40c06d"><span class="section-number-3">2.2</span> Back ends</h3> <h3 id="org27a960f"><span class="section-number-3">2.2</span> Back ends</h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
<p> <p>
TREXIO has several back ends: 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>
</div> </div>
<div id="outline-container-orgf13f689" class="outline-3"> <div id="outline-container-org68e66b0" class="outline-3">
<h3 id="orgf13f689"><span class="section-number-3">2.3</span> Read/write behavior</h3> <h3 id="org68e66b0"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div class="outline-text-3" id="text-2-3"> <div class="outline-text-3" id="text-2-3">
<p> <p>
Every time a reading function is called, the data is read from the 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> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgb27de2a" class="outline-3"> <div id="outline-container-org9fa3935" class="outline-3">
<h3 id="orgb27de2a"><span class="section-number-3">2.4</span> TREXIO file type</h3> <h3 id="org9fa3935"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div class="outline-text-3" id="text-2-4"> <div class="outline-text-3" id="text-2-4">
<p> <p>
<code>trexio_s</code> is the the main type for TREXIO files, visible to the users <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>
</div> </div>
<div id="outline-container-orga801619" class="outline-3"> <div id="outline-container-org3552fa9" class="outline-3">
<h3 id="orga801619"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3> <h3 id="org3552fa9"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div class="outline-text-3" id="text-2-5"> <div class="outline-text-3" id="text-2-5">
<p> <p>
Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the 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> </div>
<div id="outline-container-orgdcc61c3" class="outline-3"> <div id="outline-container-org59ae030" class="outline-3">
<h3 id="orgdcc61c3"><span class="section-number-3">2.6</span> File opening</h3> <h3 id="org59ae030"><span class="section-number-3">2.6</span> File opening</h3>
<div class="outline-text-3" id="text-2-6"> <div class="outline-text-3" id="text-2-6">
<p> <p>
<code>trexio_open</code> creates a new TREXIO file or opens existing one. <code>trexio_open</code> creates a new TREXIO file or opens existing one.
@ -1005,8 +1005,8 @@ should tend to avoid renaming the <code>.txt</code> data files.
</div> </div>
</div> </div>
<div id="outline-container-org749b783" class="outline-3"> <div id="outline-container-orgf60c4c4" class="outline-3">
<h3 id="org749b783"><span class="section-number-3">2.7</span> File closing</h3> <h3 id="orgf60c4c4"><span class="section-number-3">2.7</span> File closing</h3>
<div class="outline-text-3" id="text-2-7"> <div class="outline-text-3" id="text-2-7">
<p> <p>
<code>trexio_close</code> closes an existing <code>trexio_t</code> file. <code>trexio_close</code> closes an existing <code>trexio_t</code> file.
@ -1104,8 +1104,8 @@ output:
</div> </div>
</div> </div>
<div id="outline-container-orga204e5c" class="outline-3"> <div id="outline-container-org2ff4b2e" class="outline-3">
<h3 id="orga204e5c"><span class="section-number-3">2.8</span> C helper functions</h3> <h3 id="org2ff4b2e"><span class="section-number-3">2.8</span> C helper functions</h3>
<div class="outline-text-3" id="text-2-8"> <div class="outline-text-3" id="text-2-8">
<p> <p>
#+begin<sub>src</sub> c :tangle prefix<sub>front.c</sub> #+begin<sub>src</sub> c :tangle prefix<sub>front.c</sub>
@ -1143,8 +1143,8 @@ for (int i=0; i&lt;str<sub>max</sub><sub>num</sub>; i++){
</div> </div>
</div> </div>
<div id="outline-container-org80640b3" class="outline-2"> <div id="outline-container-orgc74df05" class="outline-2">
<h2 id="org80640b3"><span class="section-number-2">3</span> Templates for front end</h2> <h2 id="orgc74df05"><span class="section-number-2">3</span> Templates for front end</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
<p> <p>
Consider the following block of <code>trex.json</code>: Consider the following block of <code>trex.json</code>:
@ -1333,8 +1333,8 @@ or double precision for integer and floating point numbers.
</p> </p>
</div> </div>
<div id="outline-container-orgbea2508" class="outline-3"> <div id="outline-container-org01189a1" class="outline-3">
<h3 id="orgbea2508"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3> <h3 id="org01189a1"><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"> <div class="outline-text-3" id="text-3-1">
<p> <p>
This section concerns API calls related to dimensioning variables. This section concerns API calls related to dimensioning variables.
@ -1403,8 +1403,8 @@ This section concerns API calls related to dimensioning variables.
</table> </table>
</div> </div>
<div id="outline-container-orgddad42a" class="outline-4"> <div id="outline-container-orgae9ed3f" class="outline-4">
<h4 id="orgddad42a"><span class="section-number-4">3.1.1</span> C templates for front end</h4> <h4 id="orgae9ed3f"><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"> <div class="outline-text-4" id="text-3-1-1">
<p> <p>
The <code>C</code> templates that correspond to each of the abovementioned The <code>C</code> templates that correspond to each of the abovementioned
@ -1599,8 +1599,8 @@ precision (see Table above).
</div> </div>
</div> </div>
<div id="outline-container-orgc8f5289" class="outline-4"> <div id="outline-container-org3088cff" class="outline-4">
<h4 id="orgc8f5289"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4> <h4 id="org3088cff"><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"> <div class="outline-text-4" id="text-3-1-2">
<p> <p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran. The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
@ -1686,8 +1686,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div> </div>
</div> </div>
<div id="outline-container-org6b132ac" class="outline-3"> <div id="outline-container-orgcff2c9e" class="outline-3">
<h3 id="org6b132ac"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3> <h3 id="orgcff2c9e"><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"> <div class="outline-text-3" id="text-3-2">
<p> <p>
This section concerns API calls related to datasets. This section concerns API calls related to datasets.
@ -1756,8 +1756,8 @@ This section concerns API calls related to datasets.
</table> </table>
</div> </div>
<div id="outline-container-orgd2e9221" class="outline-4"> <div id="outline-container-org95517f5" class="outline-4">
<h4 id="orgd2e9221"><span class="section-number-4">3.2.1</span> C templates for front end</h4> <h4 id="org95517f5"><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"> <div class="outline-text-4" id="text-3-2-1">
<p> <p>
The C templates that correspond to each of the abovementioned functions can be found below. The C templates that correspond to each of the abovementioned functions can be found below.
@ -2023,8 +2023,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
</div> </div>
</div> </div>
<div id="outline-container-orga876f95" class="outline-4"> <div id="outline-container-org73a1525" class="outline-4">
<h4 id="orga876f95"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4> <h4 id="org73a1525"><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"> <div class="outline-text-4" id="text-3-2-2">
<p> <p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>. The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
@ -2110,8 +2110,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div> </div>
</div> </div>
<div id="outline-container-org49cc721" class="outline-3"> <div id="outline-container-org9f23637" class="outline-3">
<h3 id="org49cc721"><span class="section-number-3">3.3</span> Sparse data structures</h3> <h3 id="org9f23637"><span class="section-number-3">3.3</span> Sparse data structures</h3>
<div class="outline-text-3" id="text-3-3"> <div class="outline-text-3" id="text-3-3">
<p> <p>
Sparse data structures are used typically for large tensors such as Sparse data structures are used typically for large tensors such as
@ -2253,8 +2253,8 @@ For the values,
</div> </div>
</div> </div>
<div id="outline-container-org576f410" class="outline-2"> <div id="outline-container-org2568822" class="outline-2">
<h2 id="org576f410"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2> <h2 id="org2568822"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div class="outline-text-2" id="text-4"> <div class="outline-text-2" id="text-4">
<p> <p>
The function below adapts the original C-based <code>trexio_open</code> for Fortran. The function below adapts the original C-based <code>trexio_open</code> for Fortran.
@ -2283,7 +2283,7 @@ Note, that Fortran interface calls the main <code>TREXIO</code> API, which is wr
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-07 Mon 12:06</p> <p class="date">Created: 2021-06-09 Wed 14:58</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

40
templator_hdf5.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-06-07 Mon 12:06 --> <!-- 2021-06-09 Wed 14:58 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>HDF5 back end</title> <title>HDF5 back end</title>
@ -311,25 +311,25 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orge34febb">1. HDF5 back end</a> <li><a href="#orga049ead">1. HDF5 back end</a>
<ul> <ul>
<li><a href="#org36d68e7">1.1. Template for HDF5 definitions</a></li> <li><a href="#org0768fb9">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org123d7e0">1.2. Template for HDF5 structures</a></li> <li><a href="#orgdf414fe">1.2. Template for HDF5 structures</a></li>
<li><a href="#orgd4c581c">1.3. Template for HDF5 init/deinit</a></li> <li><a href="#org4b4cf10">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org72548d1">1.4. Template for HDF5 has/read/write a number</a></li> <li><a href="#org26eef60">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org4eb4b34">1.5. Template for HDF5 has/read/write a dataset</a></li> <li><a href="#org7928d56">1.5. Template for HDF5 has/read/write a dataset</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-orge34febb" class="outline-2"> <div id="outline-container-orga049ead" class="outline-2">
<h2 id="orge34febb"><span class="section-number-2">1</span> HDF5 back end</h2> <h2 id="orga049ead"><span class="section-number-2">1</span> HDF5 back end</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
</div> </div>
<div id="outline-container-org36d68e7" class="outline-3"> <div id="outline-container-org0768fb9" class="outline-3">
<h3 id="org36d68e7"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3> <h3 id="org0768fb9"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<div class="org-src-container"> <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> <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> </div>
<div id="outline-container-org123d7e0" class="outline-3"> <div id="outline-container-orgdf414fe" class="outline-3">
<h3 id="org123d7e0"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3> <h3 id="orgdf414fe"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<div class="org-src-container"> <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> { <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>
<div id="outline-container-orgd4c581c" class="outline-3"> <div id="outline-container-org4b4cf10" class="outline-3">
<h3 id="orgd4c581c"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3> <h3 id="org4b4cf10"><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="outline-text-3" id="text-1-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <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> </div>
<div id="outline-container-org72548d1" class="outline-3"> <div id="outline-container-org26eef60" class="outline-3">
<h3 id="org72548d1"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3> <h3 id="org26eef60"><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="outline-text-3" id="text-1-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <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> </div>
<div id="outline-container-org4eb4b34" class="outline-3"> <div id="outline-container-org7928d56" class="outline-3">
<h3 id="org4eb4b34"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3> <h3 id="org7928d56"><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="outline-text-3" id="text-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -695,7 +695,7 @@ for the JavaScript code in this tag.
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-07 Mon 12:06</p> <p class="date">Created: 2021-06-09 Wed 14:58</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

100
templator_text.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-06-07 Mon 12:06 --> <!-- 2021-06-09 Wed 14:58 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TEXT back end</title> <title>TEXT back end</title>
@ -311,24 +311,24 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org1952291">1. TEXT back end</a> <li><a href="#orgd146892">1. TEXT back end</a>
<ul> <ul>
<li><a href="#orgf35ac40">1.1. Template for group-related structures in text back end</a></li> <li><a href="#org44381d8">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#orgf3e2634">1.2. Template for general structure in text back end</a></li> <li><a href="#orgf677b3d">1.2. Template for general structure in text back end</a></li>
<li><a href="#org95e2a31">1.3. Initialize function (constant part)</a></li> <li><a href="#orge110ee7">1.3. Initialize function (constant part)</a></li>
<li><a href="#org7cf0baa">1.4. Deinitialize function (templated part)</a></li> <li><a href="#org617c07a">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#orgd81f432">1.5. Template for text read struct</a></li> <li><a href="#orgbe239e8">1.5. Template for text read struct</a></li>
<li><a href="#orgd65acdb">1.6. Template for text flush struct</a></li> <li><a href="#org6993631">1.6. Template for text flush struct</a></li>
<li><a href="#org4f3a171">1.7. Template for text free memory</a></li> <li><a href="#orge9ee64f">1.7. Template for text free memory</a></li>
<li><a href="#org0077359">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li> <li><a href="#orgd30c4fa">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org4a2081c">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li> <li><a href="#orgfbc2358">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#orgfa5686a">1.10. RDM struct (hard-coded)</a> <li><a href="#orgf90dc44">1.10. RDM struct (hard-coded)</a>
<ul> <ul>
<li><a href="#orgab0e444">1.10.1. Read the complete struct</a></li> <li><a href="#org830af28">1.10.1. Read the complete struct</a></li>
<li><a href="#org93d1f0d">1.10.2. Flush the complete struct</a></li> <li><a href="#org75520e6">1.10.2. Flush the complete struct</a></li>
<li><a href="#orgedc864f">1.10.3. Free memory</a></li> <li><a href="#org4f3e088">1.10.3. Free memory</a></li>
<li><a href="#orgdf4e551">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li> <li><a href="#org210a274">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#orge4e8689">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li> <li><a href="#org88497f5">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -337,8 +337,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-org1952291" class="outline-2"> <div id="outline-container-orgd146892" class="outline-2">
<h2 id="org1952291"><span class="section-number-2">1</span> TEXT back end</h2> <h2 id="orgd146892"><span class="section-number-2">1</span> TEXT back end</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The "file" produced by the text back end is a directory with one 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> </p>
</div> </div>
<div id="outline-container-orgf35ac40" class="outline-3"> <div id="outline-container-org44381d8" class="outline-3">
<h3 id="orgf35ac40"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3> <h3 id="org44381d8"><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="outline-text-3" id="text-1-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> $group$_s { <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> </div>
<div id="outline-container-orgf3e2634" class="outline-3"> <div id="outline-container-orgf677b3d" class="outline-3">
<h3 id="orgf3e2634"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3> <h3 id="orgf677b3d"><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="outline-text-3" id="text-1-2">
<div class="org-src-container"> <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> { <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> </div>
<div id="outline-container-org95e2a31" class="outline-3"> <div id="outline-container-orge110ee7" class="outline-3">
<h3 id="org95e2a31"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3> <h3 id="orge110ee7"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <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> </div>
<div id="outline-container-org7cf0baa" class="outline-3"> <div id="outline-container-org617c07a" class="outline-3">
<h3 id="org7cf0baa"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3> <h3 id="org617c07a"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <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> </div>
<div id="outline-container-orgd81f432" class="outline-3"> <div id="outline-container-orgbe239e8" class="outline-3">
<h3 id="orgd81f432"><span class="section-number-3">1.5</span> Template for text read struct</h3> <h3 id="orgbe239e8"><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="outline-text-3" id="text-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">$group$_t* <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> </div>
<div id="outline-container-orgd65acdb" class="outline-3"> <div id="outline-container-org6993631" class="outline-3">
<h3 id="orgd65acdb"><span class="section-number-3">1.6</span> Template for text flush struct</h3> <h3 id="org6993631"><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="outline-text-3" id="text-1-6">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <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> </div>
<div id="outline-container-org4f3a171" class="outline-3"> <div id="outline-container-orge9ee64f" class="outline-3">
<h3 id="org4f3a171"><span class="section-number-3">1.7</span> Template for text free memory</h3> <h3 id="orge9ee64f"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div class="outline-text-3" id="text-1-7"> <div class="outline-text-3" id="text-1-7">
<p> <p>
Memory is allocated when reading. The following function frees memory. 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> </div>
<div id="outline-container-org0077359" class="outline-3"> <div id="outline-container-orgd30c4fa" class="outline-3">
<h3 id="org0077359"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3> <h3 id="orgd30c4fa"><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="outline-text-3" id="text-1-8">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <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> </div>
<div id="outline-container-org4a2081c" class="outline-3"> <div id="outline-container-orgfbc2358" class="outline-3">
<h3 id="org4a2081c"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3> <h3 id="orgfbc2358"><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"> <div class="outline-text-3" id="text-1-9">
<p> <p>
The <code>group_dset</code> array is assumed allocated with the appropriate size. 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> </div>
<div id="outline-container-orgfa5686a" class="outline-3"> <div id="outline-container-orgf90dc44" class="outline-3">
<h3 id="orgfa5686a"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3> <h3 id="orgf90dc44"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3>
<div class="outline-text-3" id="text-1-10"> <div class="outline-text-3" id="text-1-10">
</div> </div>
<div id="outline-container-orgab0e444" class="outline-4"> <div id="outline-container-org830af28" class="outline-4">
<h4 id="orgab0e444"><span class="section-number-4">1.10.1</span> Read the complete struct</h4> <h4 id="org830af28"><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="outline-text-4" id="text-1-10-1">
<div class="org-src-container"> <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>); <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> </div>
<div id="outline-container-org93d1f0d" class="outline-4"> <div id="outline-container-org75520e6" class="outline-4">
<h4 id="org93d1f0d"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4> <h4 id="org75520e6"><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="outline-text-4" id="text-1-10-2">
<div class="org-src-container"> <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>); <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> </div>
<div id="outline-container-orgedc864f" class="outline-4"> <div id="outline-container-org4f3e088" class="outline-4">
<h4 id="orgedc864f"><span class="section-number-4">1.10.3</span> Free memory</h4> <h4 id="org4f3e088"><span class="section-number-4">1.10.3</span> Free memory</h4>
<div class="outline-text-4" id="text-1-10-3"> <div class="outline-text-4" id="text-1-10-3">
<p> <p>
Memory is allocated when reading. The followig function frees memory. 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> </div>
<div id="outline-container-orgdf4e551" class="outline-4"> <div id="outline-container-org210a274" class="outline-4">
<h4 id="orgdf4e551"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4> <h4 id="org210a274"><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"> <div class="outline-text-4" id="text-1-10-4">
<p> <p>
The <code>one_e</code> array is assumed allocated with the appropriate size. 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> </div>
<div id="outline-container-orge4e8689" class="outline-4"> <div id="outline-container-org88497f5" class="outline-4">
<h4 id="orge4e8689"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4> <h4 id="org88497f5"><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"> <div class="outline-text-4" id="text-1-10-5">
<p> <p>
<code>two_e</code> is a sparse data structure, which can be too large to fit <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>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-06-07 Mon 12:06</p> <p class="date">Created: 2021-06-09 Wed 14:58</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>