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@331e3d64fd 🚀

Browse Source
This commit is contained in:
scemama 2021-05-24 22:02:57 +00:00
parent 40f436b50d
commit d84dfaea8d
5 changed files with 131 additions and 131 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-05-24 Mon 13:01 --> <!-- 2021-05-24 Mon 22:02 -->
<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-05-24 Mon 13:01</p> <p class="date">Created: 2021-05-24 Mon 22:02</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-05-24 Mon 13:01 --> <!-- 2021-05-24 Mon 22:02 -->
<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-05-24 Mon 13:01</p> <p class="date">Created: 2021-05-24 Mon 22:02</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>

114
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-05-24 Mon 13:01 --> <!-- 2021-05-24 Mon 22:02 -->
<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>
@ -311,45 +311,45 @@ 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="#org159f545">1. Coding conventions</a> <li><a href="#org080e62e">1. Coding conventions</a>
<ul> <ul>
<li><a href="#orge17d4bd">1.1. Memory allocation</a></li> <li><a href="#org77a3de5">1.1. Memory allocation</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgf046485">2. Front end</a> <li><a href="#orgd9f19a8">2. Front end</a>
<ul> <ul>
<li><a href="#org6d2787e">2.1. Error handling</a></li> <li><a href="#org4c481b2">2.1. Error handling</a></li>
<li><a href="#orgb644b64">2.2. Back ends</a></li> <li><a href="#org7dc5deb">2.2. Back ends</a></li>
<li><a href="#org9dab251">2.3. Read/write behavior</a></li> <li><a href="#org009ed55">2.3. Read/write behavior</a></li>
<li><a href="#org76ce074">2.4. TREXIO file type</a></li> <li><a href="#orgf766e93">2.4. TREXIO file type</a></li>
<li><a href="#org9a7442d">2.5. Polymorphism of the file handle</a></li> <li><a href="#org87243a7">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org9860d4d">2.6. File opening</a></li> <li><a href="#org4b9fcf0">2.6. File opening</a></li>
<li><a href="#orgde48474">2.7. File closing</a></li> <li><a href="#org82aee32">2.7. File closing</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgab926e5">3. Templates for front end</a> <li><a href="#org066d790">3. Templates for front end</a>
<ul> <ul>
<li><a href="#orgb4e9f50">3.1. Templates for front end has/read/write a dimension</a> <li><a href="#org259896f">3.1. Templates for front end has/read/write a dimension</a>
<ul> <ul>
<li><a href="#org8911e00">3.1.1. C templates for front end</a></li> <li><a href="#org2c758a9">3.1.1. C templates for front end</a></li>
<li><a href="#org6ea0a41">3.1.2. Fortran templates for front end</a></li> <li><a href="#orgdc46bb0">3.1.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgc7316bd">3.2. Templates for front end has/read/write a dataset</a> <li><a href="#org6f2e305">3.2. Templates for front end has/read/write a dataset</a>
<ul> <ul>
<li><a href="#orga7f4451">3.2.1. C templates for front end</a></li> <li><a href="#org8bd3db4">3.2.1. C templates for front end</a></li>
<li><a href="#org996dbd0">3.2.2. Fortran templates for front end</a></li> <li><a href="#orge1f773f">3.2.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org8021c3e">4. Fortran helper/wrapper functions</a></li> <li><a href="#orge1275cb">4. Fortran helper/wrapper functions</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org159f545" class="outline-2"> <div id="outline-container-org080e62e" class="outline-2">
<h2 id="org159f545"><span class="section-number-2">1</span> Coding conventions</h2> <h2 id="org080e62e"><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>
@ -364,8 +364,8 @@ for the JavaScript code in this tag.
</ul> </ul>
</div> </div>
<div id="outline-container-orge17d4bd" class="outline-3"> <div id="outline-container-org77a3de5" class="outline-3">
<h3 id="orge17d4bd"><span class="section-number-3">1.1</span> Memory allocation</h3> <h3 id="org77a3de5"><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
@ -400,8 +400,8 @@ The maximum string size for the filenames is 4096 characters.
</div> </div>
</div> </div>
<div id="outline-container-orgf046485" class="outline-2"> <div id="outline-container-orgd9f19a8" class="outline-2">
<h2 id="orgf046485"><span class="section-number-2">2</span> Front end</h2> <h2 id="orgd9f19a8"><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.
@ -409,10 +409,10 @@ TREXIO front end is modular, which simplifies implementation of new back ends.
</p> </p>
</div> </div>
<div id="outline-container-org6d2787e" class="outline-3"> <div id="outline-container-org4c481b2" class="outline-3">
<h3 id="org6d2787e"><span class="section-number-3">2.1</span> Error handling</h3> <h3 id="org4c481b2"><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="org5c951dd" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orga038f02" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -694,8 +694,8 @@ The text strings are extracted from the previous table.
</div> </div>
</div> </div>
<div id="outline-container-orgb644b64" class="outline-3"> <div id="outline-container-org7dc5deb" class="outline-3">
<h3 id="orgb644b64"><span class="section-number-3">2.2</span> Back ends</h3> <h3 id="org7dc5deb"><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:
@ -725,8 +725,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org9dab251" class="outline-3"> <div id="outline-container-org009ed55" class="outline-3">
<h3 id="org9dab251"><span class="section-number-3">2.3</span> Read/write behavior</h3> <h3 id="org009ed55"><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
@ -754,8 +754,8 @@ concurrent programs, the behavior is not specified.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-org76ce074" class="outline-3"> <div id="outline-container-orgf766e93" class="outline-3">
<h3 id="org76ce074"><span class="section-number-3">2.4</span> TREXIO file type</h3> <h3 id="orgf766e93"><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
@ -787,8 +787,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org9a7442d" class="outline-3"> <div id="outline-container-org87243a7" class="outline-3">
<h3 id="org9a7442d"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3> <h3 id="org87243a7"><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
@ -807,8 +807,8 @@ corresponding types for all back ends can be safely casted to
</div> </div>
</div> </div>
<div id="outline-container-org9860d4d" class="outline-3"> <div id="outline-container-org4b9fcf0" class="outline-3">
<h3 id="org9860d4d"><span class="section-number-3">2.6</span> File opening</h3> <h3 id="org4b9fcf0"><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.
@ -972,8 +972,8 @@ should tend to avoid renaming the <code>.txt</code> data files.
</div> </div>
</div> </div>
<div id="outline-container-orgde48474" class="outline-3"> <div id="outline-container-org82aee32" class="outline-3">
<h3 id="orgde48474"><span class="section-number-3">2.7</span> File closing</h3> <h3 id="org82aee32"><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.
@ -1072,8 +1072,8 @@ output:
</div> </div>
</div> </div>
<div id="outline-container-orgab926e5" class="outline-2"> <div id="outline-container-org066d790" class="outline-2">
<h2 id="orgab926e5"><span class="section-number-2">3</span> Templates for front end</h2> <h2 id="org066d790"><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>:
@ -1263,8 +1263,8 @@ or double precision for integer and floating point numbers.
</p> </p>
</div> </div>
<div id="outline-container-orgb4e9f50" class="outline-3"> <div id="outline-container-org259896f" class="outline-3">
<h3 id="orgb4e9f50"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3> <h3 id="org259896f"><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.
@ -1333,8 +1333,8 @@ This section concerns API calls related to dimensioning variables.
</table> </table>
</div> </div>
<div id="outline-container-org8911e00" class="outline-4"> <div id="outline-container-org2c758a9" class="outline-4">
<h4 id="org8911e00"><span class="section-number-4">3.1.1</span> C templates for front end</h4> <h4 id="org2c758a9"><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
@ -1527,8 +1527,8 @@ precision (see Table above).
</div> </div>
</div> </div>
<div id="outline-container-org6ea0a41" class="outline-4"> <div id="outline-container-orgdc46bb0" class="outline-4">
<h4 id="org6ea0a41"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4> <h4 id="orgdc46bb0"><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.
@ -1614,8 +1614,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div> </div>
</div> </div>
<div id="outline-container-orgc7316bd" class="outline-3"> <div id="outline-container-org6f2e305" class="outline-3">
<h3 id="orgc7316bd"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3> <h3 id="org6f2e305"><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.
@ -1684,8 +1684,8 @@ This section concerns API calls related to datasets.
</table> </table>
</div> </div>
<div id="outline-container-orga7f4451" class="outline-4"> <div id="outline-container-org8bd3db4" class="outline-4">
<h4 id="orga7f4451"><span class="section-number-4">3.2.1</span> C templates for front end</h4> <h4 id="org8bd3db4"><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.
@ -1949,8 +1949,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
</div> </div>
</div> </div>
<div id="outline-container-org996dbd0" class="outline-4"> <div id="outline-container-orge1f773f" class="outline-4">
<h4 id="org996dbd0"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4> <h4 id="orge1f773f"><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>.
@ -2037,8 +2037,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div> </div>
</div> </div>
<div id="outline-container-org8021c3e" class="outline-2"> <div id="outline-container-orge1275cb" class="outline-2">
<h2 id="org8021c3e"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2> <h2 id="orge1275cb"><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.
@ -2067,7 +2067,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-05-24 Mon 13:01</p> <p class="date">Created: 2021-05-24 Mon 22:02</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-05-24 Mon 13:01 --> <!-- 2021-05-24 Mon 22:02 -->
<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="#org2833d41">1. HDF5 back end</a> <li><a href="#orgd9d1f81">1. HDF5 back end</a>
<ul> <ul>
<li><a href="#org1599735">1.1. Template for HDF5 definitions</a></li> <li><a href="#org59cf013">1.1. Template for HDF5 definitions</a></li>
<li><a href="#orgb2d728c">1.2. Template for HDF5 structures</a></li> <li><a href="#org5d29550">1.2. Template for HDF5 structures</a></li>
<li><a href="#org5b2eee1">1.3. Template for HDF5 init/deinit</a></li> <li><a href="#orga4e301d">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#orge38fad4">1.4. Template for HDF5 has/read/write a number</a></li> <li><a href="#orgb37b35d">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#orgd03fb67">1.5. Template for HDF5 has/read/write a dataset</a></li> <li><a href="#org0cf72a1">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-org2833d41" class="outline-2"> <div id="outline-container-orgd9d1f81" class="outline-2">
<h2 id="org2833d41"><span class="section-number-2">1</span> HDF5 back end</h2> <h2 id="orgd9d1f81"><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-org1599735" class="outline-3"> <div id="outline-container-org59cf013" class="outline-3">
<h3 id="org1599735"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3> <h3 id="org59cf013"><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-orgb2d728c" class="outline-3"> <div id="outline-container-org5d29550" class="outline-3">
<h3 id="orgb2d728c"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3> <h3 id="org5d29550"><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-org5b2eee1" class="outline-3"> <div id="outline-container-orga4e301d" class="outline-3">
<h3 id="org5b2eee1"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3> <h3 id="orga4e301d"><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>
@ -440,8 +440,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-orge38fad4" class="outline-3"> <div id="outline-container-orgb37b35d" class="outline-3">
<h3 id="orge38fad4"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3> <h3 id="orgb37b35d"><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>
@ -563,8 +563,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-orgd03fb67" class="outline-3"> <div id="outline-container-org0cf72a1" class="outline-3">
<h3 id="orgd03fb67"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3> <h3 id="org0cf72a1"><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>
@ -698,7 +698,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-05-24 Mon 13:01</p> <p class="date">Created: 2021-05-24 Mon 22:02</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-05-24 Mon 13:01 --> <!-- 2021-05-24 Mon 22:02 -->
<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="#orgad82a33">1. TEXT back end</a> <li><a href="#orgf64dd42">1. TEXT back end</a>
<ul> <ul>
<li><a href="#orgf56a96b">1.1. Template for group-related structures in text back end</a></li> <li><a href="#orgf8eb90e">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#orgae12222">1.2. Template for general structure in text back end</a></li> <li><a href="#org186e202">1.2. Template for general structure in text back end</a></li>
<li><a href="#org42a17b9">1.3. Initialize function (constant part)</a></li> <li><a href="#org334018b">1.3. Initialize function (constant part)</a></li>
<li><a href="#org1d1515c">1.4. Deinitialize function (templated part)</a></li> <li><a href="#org5ce7e06">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#orga769e33">1.5. Template for text read struct</a></li> <li><a href="#org40eb616">1.5. Template for text read struct</a></li>
<li><a href="#org0e868e7">1.6. Template for text flush struct</a></li> <li><a href="#org332e8d5">1.6. Template for text flush struct</a></li>
<li><a href="#orgfde65c0">1.7. Template for text free memory</a></li> <li><a href="#orgba81a42">1.7. Template for text free memory</a></li>
<li><a href="#orgb5ba8e9">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li> <li><a href="#org953f59a">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org2049522">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li> <li><a href="#org4f2716e">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#orgece5e32">1.10. RDM struct (hard-coded)</a> <li><a href="#org6034fdc">1.10. RDM struct (hard-coded)</a>
<ul> <ul>
<li><a href="#orgb71f685">1.10.1. Read the complete struct</a></li> <li><a href="#org64cd129">1.10.1. Read the complete struct</a></li>
<li><a href="#orgaad4bac">1.10.2. Flush the complete struct</a></li> <li><a href="#org1b0d854">1.10.2. Flush the complete struct</a></li>
<li><a href="#org996e20b">1.10.3. Free memory</a></li> <li><a href="#orgf44bbdd">1.10.3. Free memory</a></li>
<li><a href="#orgd1bb834">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li> <li><a href="#orga35603f">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#orgd90783f">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li> <li><a href="#org8b8b525">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-orgad82a33" class="outline-2"> <div id="outline-container-orgf64dd42" class="outline-2">
<h2 id="orgad82a33"><span class="section-number-2">1</span> TEXT back end</h2> <h2 id="orgf64dd42"><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-orgf56a96b" class="outline-3"> <div id="outline-container-orgf8eb90e" class="outline-3">
<h3 id="orgf56a96b"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3> <h3 id="orgf8eb90e"><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-orgae12222" class="outline-3"> <div id="outline-container-org186e202" class="outline-3">
<h3 id="orgae12222"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3> <h3 id="org186e202"><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-org42a17b9" class="outline-3"> <div id="outline-container-org334018b" class="outline-3">
<h3 id="org42a17b9"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3> <h3 id="org334018b"><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-org1d1515c" class="outline-3"> <div id="outline-container-org5ce7e06" class="outline-3">
<h3 id="org1d1515c"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3> <h3 id="org5ce7e06"><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-orga769e33" class="outline-3"> <div id="outline-container-org40eb616" class="outline-3">
<h3 id="orga769e33"><span class="section-number-3">1.5</span> Template for text read struct</h3> <h3 id="org40eb616"><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-org0e868e7" class="outline-3"> <div id="outline-container-org332e8d5" class="outline-3">
<h3 id="org0e868e7"><span class="section-number-3">1.6</span> Template for text flush struct</h3> <h3 id="org332e8d5"><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-orgfde65c0" class="outline-3"> <div id="outline-container-orgba81a42" class="outline-3">
<h3 id="orgfde65c0"><span class="section-number-3">1.7</span> Template for text free memory</h3> <h3 id="orgba81a42"><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-orgb5ba8e9" class="outline-3"> <div id="outline-container-org953f59a" class="outline-3">
<h3 id="orgb5ba8e9"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3> <h3 id="org953f59a"><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-org2049522" class="outline-3"> <div id="outline-container-org4f2716e" class="outline-3">
<h3 id="org2049522"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3> <h3 id="org4f2716e"><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-orgece5e32" class="outline-3"> <div id="outline-container-org6034fdc" class="outline-3">
<h3 id="orgece5e32"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3> <h3 id="org6034fdc"><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-orgb71f685" class="outline-4"> <div id="outline-container-org64cd129" class="outline-4">
<h4 id="orgb71f685"><span class="section-number-4">1.10.1</span> Read the complete struct</h4> <h4 id="org64cd129"><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-orgaad4bac" class="outline-4"> <div id="outline-container-org1b0d854" class="outline-4">
<h4 id="orgaad4bac"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4> <h4 id="org1b0d854"><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-org996e20b" class="outline-4"> <div id="outline-container-orgf44bbdd" class="outline-4">
<h4 id="org996e20b"><span class="section-number-4">1.10.3</span> Free memory</h4> <h4 id="orgf44bbdd"><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-orgd1bb834" class="outline-4"> <div id="outline-container-orga35603f" class="outline-4">
<h4 id="orgd1bb834"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4> <h4 id="orga35603f"><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-orgd90783f" class="outline-4"> <div id="outline-container-org8b8b525" class="outline-4">
<h4 id="orgd90783f"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4> <h4 id="org8b8b525"><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-05-24 Mon 13:01</p> <p class="date">Created: 2021-05-24 Mon 22:02</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>