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@9ec75c2892 🚀

Browse Source
This commit is contained in:
scemama 2021-05-21 10:11:30 +00:00
parent cdab5498be
commit 255a65a8c7
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-19 Wed 20:03 --> <!-- 2021-05-21 Fri 10:11 -->
<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-19 Wed 20:03</p> <p class="date">Created: 2021-05-21 Fri 10:11</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-19 Wed 20:03 --> <!-- 2021-05-21 Fri 10:11 -->
<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-19 Wed 20:03</p> <p class="date">Created: 2021-05-21 Fri 10:11</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-19 Wed 20:03 --> <!-- 2021-05-21 Fri 10:11 -->
<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="#orgdc49748">1. Coding conventions</a> <li><a href="#org4ec310b">1. Coding conventions</a>
<ul> <ul>
<li><a href="#orga7950fc">1.1. Memory allocation</a></li> <li><a href="#org2609f71">1.1. Memory allocation</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org2991b00">2. Front end</a> <li><a href="#orgc62a228">2. Front end</a>
<ul> <ul>
<li><a href="#orgdaf17ba">2.1. Error handling</a></li> <li><a href="#org194bf4e">2.1. Error handling</a></li>
<li><a href="#org95544cf">2.2. Back ends</a></li> <li><a href="#org9e41399">2.2. Back ends</a></li>
<li><a href="#org2182097">2.3. Read/write behavior</a></li> <li><a href="#org75293aa">2.3. Read/write behavior</a></li>
<li><a href="#org0e936a3">2.4. TREXIO file type</a></li> <li><a href="#org4ae40e6">2.4. TREXIO file type</a></li>
<li><a href="#org7bbd997">2.5. Polymorphism of the file handle</a></li> <li><a href="#org778716c">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org1a02f87">2.6. File opening</a></li> <li><a href="#orgbb5e2f5">2.6. File opening</a></li>
<li><a href="#org9ba0774">2.7. File closing</a></li> <li><a href="#org9a821b2">2.7. File closing</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orga48506b">3. Templates for front end</a> <li><a href="#orgee92537">3. Templates for front end</a>
<ul> <ul>
<li><a href="#org8530b55">3.1. Templates for front end has/read/write a dimension</a> <li><a href="#orgfdb55f0">3.1. Templates for front end has/read/write a dimension</a>
<ul> <ul>
<li><a href="#org960c8a7">3.1.1. C templates for front end</a></li> <li><a href="#org481add1">3.1.1. C templates for front end</a></li>
<li><a href="#org4a10fc8">3.1.2. Fortran templates for front end</a></li> <li><a href="#org65112ec">3.1.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org2c24725">3.2. Templates for front end has/read/write a dataset</a> <li><a href="#org076b93c">3.2. Templates for front end has/read/write a dataset</a>
<ul> <ul>
<li><a href="#org8e87e91">3.2.1. C templates for front end</a></li> <li><a href="#orgf4a3a42">3.2.1. C templates for front end</a></li>
<li><a href="#org2f13c87">3.2.2. Fortran templates for front end</a></li> <li><a href="#orgcb0e0c4">3.2.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org7ec4413">4. Fortran helper/wrapper functions</a></li> <li><a href="#orgebc9a04">4. Fortran helper/wrapper functions</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-orgdc49748" class="outline-2"> <div id="outline-container-org4ec310b" class="outline-2">
<h2 id="orgdc49748"><span class="section-number-2">1</span> Coding conventions</h2> <h2 id="org4ec310b"><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-orga7950fc" class="outline-3"> <div id="outline-container-org2609f71" class="outline-3">
<h3 id="orga7950fc"><span class="section-number-3">1.1</span> Memory allocation</h3> <h3 id="org2609f71"><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-org2991b00" class="outline-2"> <div id="outline-container-orgc62a228" class="outline-2">
<h2 id="org2991b00"><span class="section-number-2">2</span> Front end</h2> <h2 id="orgc62a228"><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-orgdaf17ba" class="outline-3"> <div id="outline-container-org194bf4e" class="outline-3">
<h3 id="orgdaf17ba"><span class="section-number-3">2.1</span> Error handling</h3> <h3 id="org194bf4e"><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="org3332708" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orge41f276" 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-org95544cf" class="outline-3"> <div id="outline-container-org9e41399" class="outline-3">
<h3 id="org95544cf"><span class="section-number-3">2.2</span> Back ends</h3> <h3 id="org9e41399"><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-org2182097" class="outline-3"> <div id="outline-container-org75293aa" class="outline-3">
<h3 id="org2182097"><span class="section-number-3">2.3</span> Read/write behavior</h3> <h3 id="org75293aa"><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-org0e936a3" class="outline-3"> <div id="outline-container-org4ae40e6" class="outline-3">
<h3 id="org0e936a3"><span class="section-number-3">2.4</span> TREXIO file type</h3> <h3 id="org4ae40e6"><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-org7bbd997" class="outline-3"> <div id="outline-container-org778716c" class="outline-3">
<h3 id="org7bbd997"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3> <h3 id="org778716c"><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-org1a02f87" class="outline-3"> <div id="outline-container-orgbb5e2f5" class="outline-3">
<h3 id="org1a02f87"><span class="section-number-3">2.6</span> File opening</h3> <h3 id="orgbb5e2f5"><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-org9ba0774" class="outline-3"> <div id="outline-container-org9a821b2" class="outline-3">
<h3 id="org9ba0774"><span class="section-number-3">2.7</span> File closing</h3> <h3 id="org9a821b2"><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-orga48506b" class="outline-2"> <div id="outline-container-orgee92537" class="outline-2">
<h2 id="orga48506b"><span class="section-number-2">3</span> Templates for front end</h2> <h2 id="orgee92537"><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-org8530b55" class="outline-3"> <div id="outline-container-orgfdb55f0" class="outline-3">
<h3 id="org8530b55"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3> <h3 id="orgfdb55f0"><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-org960c8a7" class="outline-4"> <div id="outline-container-org481add1" class="outline-4">
<h4 id="org960c8a7"><span class="section-number-4">3.1.1</span> C templates for front end</h4> <h4 id="org481add1"><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-org4a10fc8" class="outline-4"> <div id="outline-container-org65112ec" class="outline-4">
<h4 id="org4a10fc8"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4> <h4 id="org65112ec"><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-org2c24725" class="outline-3"> <div id="outline-container-org076b93c" class="outline-3">
<h3 id="org2c24725"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3> <h3 id="org076b93c"><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-org8e87e91" class="outline-4"> <div id="outline-container-orgf4a3a42" class="outline-4">
<h4 id="org8e87e91"><span class="section-number-4">3.2.1</span> C templates for front end</h4> <h4 id="orgf4a3a42"><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-org2f13c87" class="outline-4"> <div id="outline-container-orgcb0e0c4" class="outline-4">
<h4 id="org2f13c87"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4> <h4 id="orgcb0e0c4"><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-org7ec4413" class="outline-2"> <div id="outline-container-orgebc9a04" class="outline-2">
<h2 id="org7ec4413"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2> <h2 id="orgebc9a04"><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-19 Wed 20:03</p> <p class="date">Created: 2021-05-21 Fri 10:11</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-19 Wed 20:03 --> <!-- 2021-05-21 Fri 10:11 -->
<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="#orgd0756e7">1. HDF5 back end</a> <li><a href="#orgd478d0c">1. HDF5 back end</a>
<ul> <ul>
<li><a href="#orge174b55">1.1. Template for HDF5 definitions</a></li> <li><a href="#org6dc666e">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org40291b2">1.2. Template for HDF5 structures</a></li> <li><a href="#org4e8940e">1.2. Template for HDF5 structures</a></li>
<li><a href="#org3d47cb5">1.3. Template for HDF5 init/deinit</a></li> <li><a href="#org5aceef7">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#orga65a1ac">1.4. Template for HDF5 has/read/write a number</a></li> <li><a href="#org33b3539">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org0f8d9f4">1.5. Template for HDF5 has/read/write a dataset</a></li> <li><a href="#org48c219c">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-orgd0756e7" class="outline-2"> <div id="outline-container-orgd478d0c" class="outline-2">
<h2 id="orgd0756e7"><span class="section-number-2">1</span> HDF5 back end</h2> <h2 id="orgd478d0c"><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-orge174b55" class="outline-3"> <div id="outline-container-org6dc666e" class="outline-3">
<h3 id="orge174b55"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3> <h3 id="org6dc666e"><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-org40291b2" class="outline-3"> <div id="outline-container-org4e8940e" class="outline-3">
<h3 id="org40291b2"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3> <h3 id="org4e8940e"><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-org3d47cb5" class="outline-3"> <div id="outline-container-org5aceef7" class="outline-3">
<h3 id="org3d47cb5"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3> <h3 id="org5aceef7"><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-orga65a1ac" class="outline-3"> <div id="outline-container-org33b3539" class="outline-3">
<h3 id="orga65a1ac"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3> <h3 id="org33b3539"><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-org0f8d9f4" class="outline-3"> <div id="outline-container-org48c219c" class="outline-3">
<h3 id="org0f8d9f4"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3> <h3 id="org48c219c"><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-19 Wed 20:03</p> <p class="date">Created: 2021-05-21 Fri 10:11</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-19 Wed 20:03 --> <!-- 2021-05-21 Fri 10:11 -->
<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="#org45642ac">1. TEXT back end</a> <li><a href="#org63ef0e5">1. TEXT back end</a>
<ul> <ul>
<li><a href="#org5b786b6">1.1. Template for group-related structures in text back end</a></li> <li><a href="#orgf5448fc">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org3f66a4a">1.2. Template for general structure in text back end</a></li> <li><a href="#orge1f104b">1.2. Template for general structure in text back end</a></li>
<li><a href="#org09f6c43">1.3. Initialize function (constant part)</a></li> <li><a href="#org10d252a">1.3. Initialize function (constant part)</a></li>
<li><a href="#org40d9188">1.4. Deinitialize function (templated part)</a></li> <li><a href="#orgeaab349">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org749469d">1.5. Template for text read struct</a></li> <li><a href="#org530d5fa">1.5. Template for text read struct</a></li>
<li><a href="#org5e1b9b6">1.6. Template for text flush struct</a></li> <li><a href="#org3c63d60">1.6. Template for text flush struct</a></li>
<li><a href="#orgc429d48">1.7. Template for text free memory</a></li> <li><a href="#org42ead2f">1.7. Template for text free memory</a></li>
<li><a href="#org342afc4">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li> <li><a href="#orgfd102ea">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org5457534">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li> <li><a href="#org95e61a7">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#orgd050afa">1.10. RDM struct (hard-coded)</a> <li><a href="#orgf6b78ab">1.10. RDM struct (hard-coded)</a>
<ul> <ul>
<li><a href="#org327082a">1.10.1. Read the complete struct</a></li> <li><a href="#org9b40e1f">1.10.1. Read the complete struct</a></li>
<li><a href="#org54d487a">1.10.2. Flush the complete struct</a></li> <li><a href="#orgd7adf7c">1.10.2. Flush the complete struct</a></li>
<li><a href="#orgfdf7283">1.10.3. Free memory</a></li> <li><a href="#org53b0064">1.10.3. Free memory</a></li>
<li><a href="#org9541462">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li> <li><a href="#orgff6fac5">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org9069570">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li> <li><a href="#org2f637f1">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-org45642ac" class="outline-2"> <div id="outline-container-org63ef0e5" class="outline-2">
<h2 id="org45642ac"><span class="section-number-2">1</span> TEXT back end</h2> <h2 id="org63ef0e5"><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-org5b786b6" class="outline-3"> <div id="outline-container-orgf5448fc" class="outline-3">
<h3 id="org5b786b6"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3> <h3 id="orgf5448fc"><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-org3f66a4a" class="outline-3"> <div id="outline-container-orge1f104b" class="outline-3">
<h3 id="org3f66a4a"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3> <h3 id="orge1f104b"><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-org09f6c43" class="outline-3"> <div id="outline-container-org10d252a" class="outline-3">
<h3 id="org09f6c43"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3> <h3 id="org10d252a"><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-org40d9188" class="outline-3"> <div id="outline-container-orgeaab349" class="outline-3">
<h3 id="org40d9188"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3> <h3 id="orgeaab349"><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-org749469d" class="outline-3"> <div id="outline-container-org530d5fa" class="outline-3">
<h3 id="org749469d"><span class="section-number-3">1.5</span> Template for text read struct</h3> <h3 id="org530d5fa"><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-org5e1b9b6" class="outline-3"> <div id="outline-container-org3c63d60" class="outline-3">
<h3 id="org5e1b9b6"><span class="section-number-3">1.6</span> Template for text flush struct</h3> <h3 id="org3c63d60"><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-orgc429d48" class="outline-3"> <div id="outline-container-org42ead2f" class="outline-3">
<h3 id="orgc429d48"><span class="section-number-3">1.7</span> Template for text free memory</h3> <h3 id="org42ead2f"><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-org342afc4" class="outline-3"> <div id="outline-container-orgfd102ea" class="outline-3">
<h3 id="org342afc4"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3> <h3 id="orgfd102ea"><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-org5457534" class="outline-3"> <div id="outline-container-org95e61a7" class="outline-3">
<h3 id="org5457534"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3> <h3 id="org95e61a7"><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-orgd050afa" class="outline-3"> <div id="outline-container-orgf6b78ab" class="outline-3">
<h3 id="orgd050afa"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3> <h3 id="orgf6b78ab"><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-org327082a" class="outline-4"> <div id="outline-container-org9b40e1f" class="outline-4">
<h4 id="org327082a"><span class="section-number-4">1.10.1</span> Read the complete struct</h4> <h4 id="org9b40e1f"><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-org54d487a" class="outline-4"> <div id="outline-container-orgd7adf7c" class="outline-4">
<h4 id="org54d487a"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4> <h4 id="orgd7adf7c"><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-orgfdf7283" class="outline-4"> <div id="outline-container-org53b0064" class="outline-4">
<h4 id="orgfdf7283"><span class="section-number-4">1.10.3</span> Free memory</h4> <h4 id="org53b0064"><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-org9541462" class="outline-4"> <div id="outline-container-orgff6fac5" class="outline-4">
<h4 id="org9541462"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4> <h4 id="orgff6fac5"><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-org9069570" class="outline-4"> <div id="outline-container-org2f637f1" class="outline-4">
<h4 id="org9069570"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4> <h4 id="org2f637f1"><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-19 Wed 20:03</p> <p class="date">Created: 2021-05-21 Fri 10:11</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>