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

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

Browse Source
This commit is contained in:
q-posev 2021-05-19 13:05:19 +00:00
parent f57c47e78e
commit 1820097a81
5 changed files with 134 additions and 134 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-18 Tue 10:16 --> <!-- 2021-05-19 Wed 13:05 -->
<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-18 Tue 10:16</p> <p class="date">Created: 2021-05-19 Wed 13:05</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-18 Tue 10:16 --> <!-- 2021-05-19 Wed 13:05 -->
<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-18 Tue 10:16</p> <p class="date">Created: 2021-05-19 Wed 13:05</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-18 Tue 10:16 --> <!-- 2021-05-19 Wed 13:05 -->
<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="#orgb621904">1. Coding conventions</a> <li><a href="#org8e2a6d7">1. Coding conventions</a>
<ul> <ul>
<li><a href="#orgf60579c">1.1. Memory allocation</a></li> <li><a href="#org0fde39b">1.1. Memory allocation</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org33261e1">2. Front end</a> <li><a href="#orgbe44cf8">2. Front end</a>
<ul> <ul>
<li><a href="#orgbd81908">2.1. Error handling</a></li> <li><a href="#org0875a10">2.1. Error handling</a></li>
<li><a href="#orgd8dd1bc">2.2. Back ends</a></li> <li><a href="#orgeea3d1e">2.2. Back ends</a></li>
<li><a href="#orgef576de">2.3. Read/write behavior</a></li> <li><a href="#org298fac7">2.3. Read/write behavior</a></li>
<li><a href="#org7388aca">2.4. TREXIO file type</a></li> <li><a href="#orgc75151e">2.4. TREXIO file type</a></li>
<li><a href="#org87ca0fd">2.5. Polymorphism of the file handle</a></li> <li><a href="#org1ba10fc">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org194ba10">2.6. File opening</a></li> <li><a href="#org095e04b">2.6. File opening</a></li>
<li><a href="#org6fbeaff">2.7. File closing</a></li> <li><a href="#org90d6d38">2.7. File closing</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org850fa00">3. Templates for front end</a> <li><a href="#orgf8f9020">3. Templates for front end</a>
<ul> <ul>
<li><a href="#org5a2c5cf">3.1. Templates for front end has/read/write a dimension</a> <li><a href="#org94647e4">3.1. Templates for front end has/read/write a dimension</a>
<ul> <ul>
<li><a href="#orgc021658">3.1.1. C templates for front end</a></li> <li><a href="#orge7a7af1">3.1.1. C templates for front end</a></li>
<li><a href="#orgff29680">3.1.2. Fortran templates for front end</a></li> <li><a href="#orgb41d34d">3.1.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgbd13b06">3.2. Templates for front end has/read/write a dataset</a> <li><a href="#orgaf28a76">3.2. Templates for front end has/read/write a dataset</a>
<ul> <ul>
<li><a href="#org09d4fd4">3.2.1. C templates for front end</a></li> <li><a href="#orga340702">3.2.1. C templates for front end</a></li>
<li><a href="#org5b154e9">3.2.2. Fortran templates for front end</a></li> <li><a href="#org8e7cb43">3.2.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org55b49cd">4. Fortran helper/wrapper functions</a></li> <li><a href="#org376ccd1">4. Fortran helper/wrapper functions</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-orgb621904" class="outline-2"> <div id="outline-container-org8e2a6d7" class="outline-2">
<h2 id="orgb621904"><span class="section-number-2">1</span> Coding conventions</h2> <h2 id="org8e2a6d7"><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-orgf60579c" class="outline-3"> <div id="outline-container-org0fde39b" class="outline-3">
<h3 id="orgf60579c"><span class="section-number-3">1.1</span> Memory allocation</h3> <h3 id="org0fde39b"><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-org33261e1" class="outline-2"> <div id="outline-container-orgbe44cf8" class="outline-2">
<h2 id="org33261e1"><span class="section-number-2">2</span> Front end</h2> <h2 id="orgbe44cf8"><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-orgbd81908" class="outline-3"> <div id="outline-container-org0875a10" class="outline-3">
<h3 id="orgbd81908"><span class="section-number-3">2.1</span> Error handling</h3> <h3 id="org0875a10"><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="org5c12de5" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgf7ed726" 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-orgd8dd1bc" class="outline-3"> <div id="outline-container-orgeea3d1e" class="outline-3">
<h3 id="orgd8dd1bc"><span class="section-number-3">2.2</span> Back ends</h3> <h3 id="orgeea3d1e"><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-orgef576de" class="outline-3"> <div id="outline-container-org298fac7" class="outline-3">
<h3 id="orgef576de"><span class="section-number-3">2.3</span> Read/write behavior</h3> <h3 id="org298fac7"><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-org7388aca" class="outline-3"> <div id="outline-container-orgc75151e" class="outline-3">
<h3 id="org7388aca"><span class="section-number-3">2.4</span> TREXIO file type</h3> <h3 id="orgc75151e"><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-org87ca0fd" class="outline-3"> <div id="outline-container-org1ba10fc" class="outline-3">
<h3 id="org87ca0fd"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3> <h3 id="org1ba10fc"><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-org194ba10" class="outline-3"> <div id="outline-container-org095e04b" class="outline-3">
<h3 id="org194ba10"><span class="section-number-3">2.6</span> File opening</h3> <h3 id="org095e04b"><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.
@ -970,8 +970,8 @@ should tend to avoid renaming the <code>.txt</code> data files.
</div> </div>
</div> </div>
<div id="outline-container-org6fbeaff" class="outline-3"> <div id="outline-container-org90d6d38" class="outline-3">
<h3 id="org6fbeaff"><span class="section-number-3">2.7</span> File closing</h3> <h3 id="org90d6d38"><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.
@ -1070,8 +1070,8 @@ output:
</div> </div>
</div> </div>
<div id="outline-container-org850fa00" class="outline-2"> <div id="outline-container-orgf8f9020" class="outline-2">
<h2 id="org850fa00"><span class="section-number-2">3</span> Templates for front end</h2> <h2 id="orgf8f9020"><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>:
@ -1261,8 +1261,8 @@ or double precision for integer and floating point numbers.
</p> </p>
</div> </div>
<div id="outline-container-org5a2c5cf" class="outline-3"> <div id="outline-container-org94647e4" class="outline-3">
<h3 id="org5a2c5cf"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3> <h3 id="org94647e4"><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.
@ -1331,8 +1331,8 @@ This section concerns API calls related to dimensioning variables.
</table> </table>
</div> </div>
<div id="outline-container-orgc021658" class="outline-4"> <div id="outline-container-orge7a7af1" class="outline-4">
<h4 id="orgc021658"><span class="section-number-4">3.1.1</span> C templates for front end</h4> <h4 id="orge7a7af1"><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
@ -1524,8 +1524,8 @@ precision (see Table above).
</div> </div>
</div> </div>
<div id="outline-container-orgff29680" class="outline-4"> <div id="outline-container-orgb41d34d" class="outline-4">
<h4 id="orgff29680"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4> <h4 id="orgb41d34d"><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.
@ -1611,8 +1611,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div> </div>
</div> </div>
<div id="outline-container-orgbd13b06" class="outline-3"> <div id="outline-container-orgaf28a76" class="outline-3">
<h3 id="orgbd13b06"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3> <h3 id="orgaf28a76"><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.
@ -1681,8 +1681,8 @@ This section concerns API calls related to datasets.
</table> </table>
</div> </div>
<div id="outline-container-org09d4fd4" class="outline-4"> <div id="outline-container-orga340702" class="outline-4">
<h4 id="org09d4fd4"><span class="section-number-4">3.2.1</span> C templates for front end</h4> <h4 id="orga340702"><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.
@ -1940,8 +1940,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
</div> </div>
</div> </div>
<div id="outline-container-org5b154e9" class="outline-4"> <div id="outline-container-org8e7cb43" class="outline-4">
<h4 id="org5b154e9"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4> <h4 id="org8e7cb43"><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>.
@ -2028,8 +2028,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div> </div>
</div> </div>
<div id="outline-container-org55b49cd" class="outline-2"> <div id="outline-container-org376ccd1" class="outline-2">
<h2 id="org55b49cd"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2> <h2 id="org376ccd1"><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.
@ -2058,7 +2058,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-18 Tue 10:16</p> <p class="date">Created: 2021-05-19 Wed 13:05</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-18 Tue 10:16 --> <!-- 2021-05-19 Wed 13:05 -->
<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="#org379a07d">1. HDF5 back end</a> <li><a href="#orgbc17cda">1. HDF5 back end</a>
<ul> <ul>
<li><a href="#orgc76be96">1.1. Template for HDF5 definitions</a></li> <li><a href="#orgff47e14">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org718f8c4">1.2. Template for HDF5 structures</a></li> <li><a href="#org79e9e16">1.2. Template for HDF5 structures</a></li>
<li><a href="#org0ec6e69">1.3. Template for HDF5 init/deinit</a></li> <li><a href="#orgd2a94f0">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#orgfc9bd3c">1.4. Template for HDF5 has/read/write a number</a></li> <li><a href="#orgc376ea2">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org7ea99e2">1.5. Template for HDF5 has/read/write a dataset</a></li> <li><a href="#org2f35816">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-org379a07d" class="outline-2"> <div id="outline-container-orgbc17cda" class="outline-2">
<h2 id="org379a07d"><span class="section-number-2">1</span> HDF5 back end</h2> <h2 id="orgbc17cda"><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-orgc76be96" class="outline-3"> <div id="outline-container-orgff47e14" class="outline-3">
<h3 id="orgc76be96"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3> <h3 id="orgff47e14"><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-org718f8c4" class="outline-3"> <div id="outline-container-org79e9e16" class="outline-3">
<h3 id="org718f8c4"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3> <h3 id="org79e9e16"><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-org0ec6e69" class="outline-3"> <div id="outline-container-orgd2a94f0" class="outline-3">
<h3 id="org0ec6e69"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3> <h3 id="orgd2a94f0"><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-orgfc9bd3c" class="outline-3"> <div id="outline-container-orgc376ea2" class="outline-3">
<h3 id="orgfc9bd3c"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3> <h3 id="orgc376ea2"><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-org7ea99e2" class="outline-3"> <div id="outline-container-org2f35816" class="outline-3">
<h3 id="org7ea99e2"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3> <h3 id="org2f35816"><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-18 Tue 10:16</p> <p class="date">Created: 2021-05-19 Wed 13:05</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>

106
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-18 Tue 10:16 --> <!-- 2021-05-19 Wed 13:05 -->
<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="#orgeb18814">1. TEXT back end</a> <li><a href="#org67f7d26">1. TEXT back end</a>
<ul> <ul>
<li><a href="#org1ea13bf">1.1. Template for group-related structures in text back end</a></li> <li><a href="#orgcb0a41a">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#orgbd22980">1.2. Template for general structure in text back end</a></li> <li><a href="#org9e95ecd">1.2. Template for general structure in text back end</a></li>
<li><a href="#org679c225">1.3. Initialize function (constant part)</a></li> <li><a href="#org8559b3c">1.3. Initialize function (constant part)</a></li>
<li><a href="#orgfb27c9e">1.4. Deinitialize function (templated part)</a></li> <li><a href="#orgc9de8ae">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#orgd4ddc34">1.5. Template for text read struct</a></li> <li><a href="#org2179410">1.5. Template for text read struct</a></li>
<li><a href="#org55a214f">1.6. Template for text flush struct</a></li> <li><a href="#orgedcee2c">1.6. Template for text flush struct</a></li>
<li><a href="#org12376a1">1.7. Template for text free memory</a></li> <li><a href="#org2187697">1.7. Template for text free memory</a></li>
<li><a href="#org6dcf9c3">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li> <li><a href="#orgfd9441c">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org6533489">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li> <li><a href="#orgc8832df">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#org39093ae">1.10. RDM struct (hard-coded)</a> <li><a href="#org48826e8">1.10. RDM struct (hard-coded)</a>
<ul> <ul>
<li><a href="#org9aa24e5">1.10.1. Read the complete struct</a></li> <li><a href="#org67fa89b">1.10.1. Read the complete struct</a></li>
<li><a href="#orgdd33185">1.10.2. Flush the complete struct</a></li> <li><a href="#org5733884">1.10.2. Flush the complete struct</a></li>
<li><a href="#org781138b">1.10.3. Free memory</a></li> <li><a href="#orged7a20b">1.10.3. Free memory</a></li>
<li><a href="#org42ceb8c">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li> <li><a href="#org0e2ec83">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org2664fa8">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li> <li><a href="#org108224f">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-orgeb18814" class="outline-2"> <div id="outline-container-org67f7d26" class="outline-2">
<h2 id="orgeb18814"><span class="section-number-2">1</span> TEXT back end</h2> <h2 id="org67f7d26"><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-org1ea13bf" class="outline-3"> <div id="outline-container-orgcb0a41a" class="outline-3">
<h3 id="org1ea13bf"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3> <h3 id="orgcb0a41a"><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-orgbd22980" class="outline-3"> <div id="outline-container-org9e95ecd" class="outline-3">
<h3 id="orgbd22980"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3> <h3 id="org9e95ecd"><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-org679c225" class="outline-3"> <div id="outline-container-org8559b3c" class="outline-3">
<h3 id="org679c225"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3> <h3 id="org8559b3c"><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-orgfb27c9e" class="outline-3"> <div id="outline-container-orgc9de8ae" class="outline-3">
<h3 id="orgfb27c9e"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3> <h3 id="orgc9de8ae"><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>
@ -517,10 +517,11 @@ The file is written when closed, or when the flush function is called.
<span style="color: #228b22;">trexio_exit_code</span> <span style="color: #a0522d;">rc</span>; <span style="color: #228b22;">trexio_exit_code</span> <span style="color: #a0522d;">rc</span>;
assert (trexio_text_free_$group$( (<span style="color: #228b22;">trexio_text_t</span>*) file) == TREXIO_SUCCESS); /* <span style="color: #b22222;">Error handling for this call is added by the generator </span>*/
rc = trexio_text_free_$group$( (<span style="color: #228b22;">trexio_text_t</span>*) file);
rc = trexio_text_free_rdm( (<span style="color: #228b22;">trexio_text_t</span>*) file); rc = trexio_text_free_rdm( (<span style="color: #228b22;">trexio_text_t</span>*) file);
assert (rc == TREXIO_SUCCESS); <span style="color: #a020f0;">if</span> (rc != TREXIO_SUCCESS) <span style="color: #a020f0;">return</span> rc;
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS; <span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
@ -530,8 +531,8 @@ The file is written when closed, or when the flush function is called.
</div> </div>
</div> </div>
<div id="outline-container-orgd4ddc34" class="outline-3"> <div id="outline-container-org2179410" class="outline-3">
<h3 id="orgd4ddc34"><span class="section-number-3">1.5</span> Template for text read struct</h3> <h3 id="org2179410"><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*
@ -697,8 +698,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div> </div>
</div> </div>
<div id="outline-container-org55a214f" class="outline-3"> <div id="outline-container-orgedcee2c" class="outline-3">
<h3 id="org55a214f"><span class="section-number-3">1.6</span> Template for text flush struct</h3> <h3 id="orgedcee2c"><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>
@ -757,8 +758,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div> </div>
</div> </div>
<div id="outline-container-org12376a1" class="outline-3"> <div id="outline-container-org2187697" class="outline-3">
<h3 id="org12376a1"><span class="section-number-3">1.7</span> Template for text free memory</h3> <h3 id="org2187697"><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.
@ -794,8 +795,8 @@ Memory is allocated when reading. The following function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-org6dcf9c3" class="outline-3"> <div id="outline-container-orgfd9441c" class="outline-3">
<h3 id="org6dcf9c3"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3> <h3 id="orgfd9441c"><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>
@ -857,8 +858,8 @@ Memory is allocated when reading. The following function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-org6533489" class="outline-3"> <div id="outline-container-orgc8832df" class="outline-3">
<h3 id="org6533489"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3> <h3 id="orgc8832df"><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.
@ -955,12 +956,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
<div id="outline-container-org39093ae" class="outline-3"> <div id="outline-container-org48826e8" class="outline-3">
<h3 id="org39093ae"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3> <h3 id="org48826e8"><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-org9aa24e5" class="outline-4"> <div id="outline-container-org67fa89b" class="outline-4">
<h4 id="org9aa24e5"><span class="section-number-4">1.10.1</span> Read the complete struct</h4> <h4 id="org67fa89b"><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>);
@ -1055,8 +1056,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
<div id="outline-container-orgdd33185" class="outline-4"> <div id="outline-container-org5733884" class="outline-4">
<h4 id="orgdd33185"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4> <h4 id="org5733884"><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>);
@ -1074,7 +1075,6 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
<span style="color: #a020f0;">if</span> (rdm-&gt;to_flush == 0) <span style="color: #a020f0;">return</span> TREXIO_SUCCESS; <span style="color: #a020f0;">if</span> (rdm-&gt;to_flush == 0) <span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
<span style="color: #228b22;">FILE</span>* <span style="color: #a0522d;">f</span> = fopen(rdm-&gt;file_name,<span style="color: #8b2252;">"w"</span>); <span style="color: #228b22;">FILE</span>* <span style="color: #a0522d;">f</span> = fopen(rdm-&gt;file_name,<span style="color: #8b2252;">"w"</span>);
assert (f != <span style="color: #008b8b;">NULL</span>); assert (f != <span style="color: #008b8b;">NULL</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-org781138b" class="outline-4"> <div id="outline-container-orged7a20b" class="outline-4">
<h4 id="org781138b"><span class="section-number-4">1.10.3</span> Free memory</h4> <h4 id="orged7a20b"><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-org42ceb8c" class="outline-4"> <div id="outline-container-org0e2ec83" class="outline-4">
<h4 id="org42ceb8c"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4> <h4 id="org0e2ec83"><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-org2664fa8" class="outline-4"> <div id="outline-container-org108224f" class="outline-4">
<h4 id="org2664fa8"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4> <h4 id="org108224f"><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-18 Tue 10:16</p> <p class="date">Created: 2021-05-19 Wed 13:05</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>