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@8ff9b1d717 🚀

Browse Source
This commit is contained in:
scemama 2021-05-05 16:18:55 +00:00
parent 24e5b58be8
commit 955f6373cc
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-05 Wed 11:55 --> <!-- 2021-05-05 Wed 16:18 -->
<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-05 Wed 11:55</p> <p class="date">Created: 2021-05-05 Wed 16:18</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-05 Wed 11:55 --> <!-- 2021-05-05 Wed 16:18 -->
<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-05 Wed 11:55</p> <p class="date">Created: 2021-05-05 Wed 16:18</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-05 Wed 11:55 --> <!-- 2021-05-05 Wed 16:18 -->
<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="#org3fb6aee">1. Coding conventions</a> <li><a href="#org2306c63">1. Coding conventions</a>
<ul> <ul>
<li><a href="#org16483f3">1.1. Memory allocation</a></li> <li><a href="#org9d76dbd">1.1. Memory allocation</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orge12d430">2. Front end</a> <li><a href="#org6381a7d">2. Front end</a>
<ul> <ul>
<li><a href="#org1df7b10">2.1. Error handling</a></li> <li><a href="#org96d9246">2.1. Error handling</a></li>
<li><a href="#org55b92f6">2.2. Back ends</a></li> <li><a href="#org7c7e5be">2.2. Back ends</a></li>
<li><a href="#org189cadb">2.3. Read/write behavior</a></li> <li><a href="#orga6763dc">2.3. Read/write behavior</a></li>
<li><a href="#orgb0411d6">2.4. TREXIO file type</a></li> <li><a href="#org119ae02">2.4. TREXIO file type</a></li>
<li><a href="#orga3a0309">2.5. Polymorphism of the file handle</a></li> <li><a href="#org4fdc3a8">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org43d4440">2.6. File opening</a></li> <li><a href="#org3402512">2.6. File opening</a></li>
<li><a href="#org580c35b">2.7. File closing</a></li> <li><a href="#org3376549">2.7. File closing</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org07200d9">3. Templates for front end</a> <li><a href="#orga89c4a0">3. Templates for front end</a>
<ul> <ul>
<li><a href="#org9022cec">3.1. Templates for front end has/read/write a dimension</a> <li><a href="#org9b4ffa7">3.1. Templates for front end has/read/write a dimension</a>
<ul> <ul>
<li><a href="#org91b1ba0">3.1.1. C templates for front end</a></li> <li><a href="#orgacf427c">3.1.1. C templates for front end</a></li>
<li><a href="#orgafb74f9">3.1.2. Fortran templates for front end</a></li> <li><a href="#orgc6b0080">3.1.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org88b8100">3.2. Templates for front end has/read/write a dataset</a> <li><a href="#org243f392">3.2. Templates for front end has/read/write a dataset</a>
<ul> <ul>
<li><a href="#org43bfc71">3.2.1. C templates for front end</a></li> <li><a href="#orgfd0b655">3.2.1. C templates for front end</a></li>
<li><a href="#org779c7c9">3.2.2. Fortran templates for front end</a></li> <li><a href="#orgaa5a68f">3.2.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org32503ed">4. Fortran helper/wrapper functions</a></li> <li><a href="#orgb091d39">4. Fortran helper/wrapper functions</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org3fb6aee" class="outline-2"> <div id="outline-container-org2306c63" class="outline-2">
<h2 id="org3fb6aee"><span class="section-number-2">1</span> Coding conventions</h2> <h2 id="org2306c63"><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-org16483f3" class="outline-3"> <div id="outline-container-org9d76dbd" class="outline-3">
<h3 id="org16483f3"><span class="section-number-3">1.1</span> Memory allocation</h3> <h3 id="org9d76dbd"><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
@ -399,8 +399,8 @@ The maximum string size for the filenames is 4096 characters.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-orge12d430" class="outline-2"> <div id="outline-container-org6381a7d" class="outline-2">
<h2 id="orge12d430"><span class="section-number-2">2</span> Front end</h2> <h2 id="org6381a7d"><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.
@ -408,10 +408,10 @@ TREXIO front end is modular, which simplifies impelementation of new back ends.
</p> </p>
</div> </div>
<div id="outline-container-org1df7b10" class="outline-3"> <div id="outline-container-org96d9246" class="outline-3">
<h3 id="org1df7b10"><span class="section-number-3">2.1</span> Error handling</h3> <h3 id="org96d9246"><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="org51cef65" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgc65968b" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -612,8 +612,8 @@ The text strings are extracted from the previous table.
</div> </div>
</div> </div>
<div id="outline-container-org55b92f6" class="outline-3"> <div id="outline-container-org7c7e5be" class="outline-3">
<h3 id="org55b92f6"><span class="section-number-3">2.2</span> Back ends</h3> <h3 id="org7c7e5be"><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:
@ -643,8 +643,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org189cadb" class="outline-3"> <div id="outline-container-orga6763dc" class="outline-3">
<h3 id="org189cadb"><span class="section-number-3">2.3</span> Read/write behavior</h3> <h3 id="orga6763dc"><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
@ -672,8 +672,8 @@ concurrent programs, the behavior is not specified.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgb0411d6" class="outline-3"> <div id="outline-container-org119ae02" class="outline-3">
<h3 id="orgb0411d6"><span class="section-number-3">2.4</span> TREXIO file type</h3> <h3 id="org119ae02"><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
@ -705,8 +705,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-orga3a0309" class="outline-3"> <div id="outline-container-org4fdc3a8" class="outline-3">
<h3 id="orga3a0309"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3> <h3 id="org4fdc3a8"><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
@ -725,8 +725,8 @@ corresponding types for all back ends can be safely casted to
</div> </div>
</div> </div>
<div id="outline-container-org43d4440" class="outline-3"> <div id="outline-container-org3402512" class="outline-3">
<h3 id="org43d4440"><span class="section-number-3">2.6</span> File opening</h3> <h3 id="org3402512"><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.
@ -888,8 +888,8 @@ should tend to avoid renaming the <code>.txt</code> data files.
</div> </div>
</div> </div>
<div id="outline-container-org580c35b" class="outline-3"> <div id="outline-container-org3376549" class="outline-3">
<h3 id="org580c35b"><span class="section-number-3">2.7</span> File closing</h3> <h3 id="org3376549"><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.
@ -988,8 +988,8 @@ output:
</div> </div>
</div> </div>
<div id="outline-container-org07200d9" class="outline-2"> <div id="outline-container-orga89c4a0" class="outline-2">
<h2 id="org07200d9"><span class="section-number-2">3</span> Templates for front end</h2> <h2 id="orga89c4a0"><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>:
@ -1150,8 +1150,8 @@ TREXIO supports I/O with single or double precision for integer and floating poi
</div> </div>
<div id="outline-container-org9022cec" class="outline-3"> <div id="outline-container-org9b4ffa7" class="outline-3">
<h3 id="org9022cec"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3> <h3 id="org9b4ffa7"><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.
@ -1220,8 +1220,8 @@ This section concerns API calls related to dimensioning variables.
</table> </table>
</div> </div>
<div id="outline-container-org91b1ba0" class="outline-4"> <div id="outline-container-orgacf427c" class="outline-4">
<h4 id="org91b1ba0"><span class="section-number-4">3.1.1</span> C templates for front end</h4> <h4 id="orgacf427c"><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 functions can be found below. The <code>C</code> templates that correspond to each of the abovementioned functions can be found below.
@ -1410,8 +1410,8 @@ The basic (non-suffixed) API call on dimensioning variables deals with single pr
</div> </div>
</div> </div>
<div id="outline-container-orgafb74f9" class="outline-4"> <div id="outline-container-orgc6b0080" class="outline-4">
<h4 id="orgafb74f9"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4> <h4 id="orgc6b0080"><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.
@ -1498,8 +1498,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div> </div>
<div id="outline-container-org88b8100" class="outline-3"> <div id="outline-container-org243f392" class="outline-3">
<h3 id="org88b8100"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3> <h3 id="org243f392"><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.
@ -1568,8 +1568,8 @@ This section concerns API calls related to datasets.
</table> </table>
</div> </div>
<div id="outline-container-org43bfc71" class="outline-4"> <div id="outline-container-orgfd0b655" class="outline-4">
<h4 id="org43bfc71"><span class="section-number-4">3.2.1</span> C templates for front end</h4> <h4 id="orgfd0b655"><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.
@ -1827,8 +1827,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
</div> </div>
</div> </div>
<div id="outline-container-org779c7c9" class="outline-4"> <div id="outline-container-orgaa5a68f" class="outline-4">
<h4 id="org779c7c9"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4> <h4 id="orgaa5a68f"><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>.
@ -1915,8 +1915,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div> </div>
</div> </div>
<div id="outline-container-org32503ed" class="outline-2"> <div id="outline-container-orgb091d39" class="outline-2">
<h2 id="org32503ed"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2> <h2 id="orgb091d39"><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.
@ -1945,7 +1945,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-05 Wed 11:55</p> <p class="date">Created: 2021-05-05 Wed 16:18</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-05 Wed 11:55 --> <!-- 2021-05-05 Wed 16:18 -->
<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="#org9d7556f">1. HDF5 back end</a> <li><a href="#orgae54eee">1. HDF5 back end</a>
<ul> <ul>
<li><a href="#org0d4276c">1.1. Template for HDF5 definitions</a></li> <li><a href="#orge5093fa">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org9707bc3">1.2. Template for HDF5 structures</a></li> <li><a href="#org8b7ea54">1.2. Template for HDF5 structures</a></li>
<li><a href="#org465e457">1.3. Template for HDF5 init/deinit</a></li> <li><a href="#org2f980e8">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org1b2e001">1.4. Template for HDF5 has/read/write a number</a></li> <li><a href="#org166e330">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org26cc93b">1.5. Template for HDF5 has/read/write a dataset</a></li> <li><a href="#org3f39a3c">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-org9d7556f" class="outline-2"> <div id="outline-container-orgae54eee" class="outline-2">
<h2 id="org9d7556f"><span class="section-number-2">1</span> HDF5 back end</h2> <h2 id="orgae54eee"><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-org0d4276c" class="outline-3"> <div id="outline-container-orge5093fa" class="outline-3">
<h3 id="org0d4276c"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3> <h3 id="orge5093fa"><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-org9707bc3" class="outline-3"> <div id="outline-container-org8b7ea54" class="outline-3">
<h3 id="org9707bc3"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3> <h3 id="org8b7ea54"><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-org465e457" class="outline-3"> <div id="outline-container-org2f980e8" class="outline-3">
<h3 id="org465e457"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3> <h3 id="org2f980e8"><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-org1b2e001" class="outline-3"> <div id="outline-container-org166e330" class="outline-3">
<h3 id="org1b2e001"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3> <h3 id="org166e330"><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>
@ -564,8 +564,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-org26cc93b" class="outline-3"> <div id="outline-container-org3f39a3c" class="outline-3">
<h3 id="org26cc93b"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3> <h3 id="org3f39a3c"><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>
@ -699,7 +699,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-05 Wed 11:55</p> <p class="date">Created: 2021-05-05 Wed 16:18</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-05 Wed 11:55 --> <!-- 2021-05-05 Wed 16:18 -->
<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="#org836f887">1. TEXT back end</a> <li><a href="#orgbac3a54">1. TEXT back end</a>
<ul> <ul>
<li><a href="#org30600a6">1.1. Template for group-related structures in text back end</a></li> <li><a href="#orgac6af50">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org2d8b1f2">1.2. Template for general structure in text back end</a></li> <li><a href="#org3bb84b0">1.2. Template for general structure in text back end</a></li>
<li><a href="#org05b574d">1.3. Initialize function (constant part)</a></li> <li><a href="#orga10b188">1.3. Initialize function (constant part)</a></li>
<li><a href="#org7c80c0d">1.4. Deinitialize function (templated part)</a></li> <li><a href="#org5fd00d1">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#orgcfbf7e0">1.5. Template for text read struct</a></li> <li><a href="#org39f209d">1.5. Template for text read struct</a></li>
<li><a href="#org3700af3">1.6. Template for text flush struct</a></li> <li><a href="#orgd417916">1.6. Template for text flush struct</a></li>
<li><a href="#org9701c2c">1.7. Template for text free memory</a></li> <li><a href="#orgde177bd">1.7. Template for text free memory</a></li>
<li><a href="#org13e900d">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li> <li><a href="#orgab3b7b1">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#orgd3200a1">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li> <li><a href="#org8cd6e08">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#org8733ce8">1.10. RDM struct (hard-coded)</a> <li><a href="#orga2c3450">1.10. RDM struct (hard-coded)</a>
<ul> <ul>
<li><a href="#orgc47d221">1.10.1. Read the complete struct</a></li> <li><a href="#org6b93964">1.10.1. Read the complete struct</a></li>
<li><a href="#orgc0e2e3c">1.10.2. Flush the complete struct</a></li> <li><a href="#org937acd4">1.10.2. Flush the complete struct</a></li>
<li><a href="#org6b3405d">1.10.3. Free memory</a></li> <li><a href="#orgfcf44fa">1.10.3. Free memory</a></li>
<li><a href="#org1479cc8">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li> <li><a href="#orgfbbdb6d">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org86768f5">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li> <li><a href="#org126b1a1">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-org836f887" class="outline-2"> <div id="outline-container-orgbac3a54" class="outline-2">
<h2 id="org836f887"><span class="section-number-2">1</span> TEXT back end</h2> <h2 id="orgbac3a54"><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-org30600a6" class="outline-3"> <div id="outline-container-orgac6af50" class="outline-3">
<h3 id="org30600a6"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3> <h3 id="orgac6af50"><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-org2d8b1f2" class="outline-3"> <div id="outline-container-org3bb84b0" class="outline-3">
<h3 id="org2d8b1f2"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3> <h3 id="org3bb84b0"><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-org05b574d" class="outline-3"> <div id="outline-container-orga10b188" class="outline-3">
<h3 id="org05b574d"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3> <h3 id="orga10b188"><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>
@ -511,8 +511,8 @@ The file is written when closed, or when the flush function is called.
</div> </div>
</div> </div>
<div id="outline-container-org7c80c0d" class="outline-3"> <div id="outline-container-org5fd00d1" class="outline-3">
<h3 id="org7c80c0d"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3> <h3 id="org5fd00d1"><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>
@ -536,8 +536,8 @@ The file is written when closed, or when the flush function is called.
</div> </div>
</div> </div>
<div id="outline-container-orgcfbf7e0" class="outline-3"> <div id="outline-container-org39f209d" class="outline-3">
<h3 id="orgcfbf7e0"><span class="section-number-3">1.5</span> Template for text read struct</h3> <h3 id="org39f209d"><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*
@ -734,8 +734,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div> </div>
</div> </div>
<div id="outline-container-org3700af3" class="outline-3"> <div id="outline-container-orgd417916" class="outline-3">
<h3 id="org3700af3"><span class="section-number-3">1.6</span> Template for text flush struct</h3> <h3 id="orgd417916"><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>
@ -793,8 +793,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div> </div>
</div> </div>
<div id="outline-container-org9701c2c" class="outline-3"> <div id="outline-container-orgde177bd" class="outline-3">
<h3 id="org9701c2c"><span class="section-number-3">1.7</span> Template for text free memory</h3> <h3 id="orgde177bd"><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.
@ -835,8 +835,8 @@ Memory is allocated when reading. The following function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-org13e900d" class="outline-3"> <div id="outline-container-orgab3b7b1" class="outline-3">
<h3 id="org13e900d"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3> <h3 id="orgab3b7b1"><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>
@ -898,8 +898,8 @@ Memory is allocated when reading. The following function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-orgd3200a1" class="outline-3"> <div id="outline-container-org8cd6e08" class="outline-3">
<h3 id="orgd3200a1"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3> <h3 id="org8cd6e08"><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.
@ -996,12 +996,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
<div id="outline-container-org8733ce8" class="outline-3"> <div id="outline-container-orga2c3450" class="outline-3">
<h3 id="org8733ce8"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3> <h3 id="orga2c3450"><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-orgc47d221" class="outline-4"> <div id="outline-container-org6b93964" class="outline-4">
<h4 id="orgc47d221"><span class="section-number-4">1.10.1</span> Read the complete struct</h4> <h4 id="org6b93964"><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>);
@ -1109,8 +1109,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
<div id="outline-container-orgc0e2e3c" class="outline-4"> <div id="outline-container-org937acd4" class="outline-4">
<h4 id="orgc0e2e3c"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4> <h4 id="org937acd4"><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>);
@ -1153,8 +1153,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
<div id="outline-container-org6b3405d" class="outline-4"> <div id="outline-container-orgfcf44fa" class="outline-4">
<h4 id="org6b3405d"><span class="section-number-4">1.10.3</span> Free memory</h4> <h4 id="orgfcf44fa"><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.
@ -1199,8 +1199,8 @@ Memory is allocated when reading. The followig function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-org1479cc8" class="outline-4"> <div id="outline-container-orgfbbdb6d" class="outline-4">
<h4 id="org1479cc8"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4> <h4 id="orgfbbdb6d"><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.
@ -1266,8 +1266,8 @@ The <code>one_e</code> array is assumed allocated with the appropriate size.
</div> </div>
</div> </div>
<div id="outline-container-org86768f5" class="outline-4"> <div id="outline-container-org126b1a1" class="outline-4">
<h4 id="org86768f5"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4> <h4 id="org126b1a1"><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
@ -1375,7 +1375,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-05 Wed 11:55</p> <p class="date">Created: 2021-05-05 Wed 16:18</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>