TREX/trexio
1
0
Fork 0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-12-27 06:43:54 +01:00
Code Issues Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
q-posev 2021-04-28 13:58:25 +00:00
parent 5a0e209ad2
commit d2f347f328
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-04-28 Wed 13:31 --> <!-- 2021-04-28 Wed 13:58 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREXIO source code documentation</title> <title>TREXIO source code documentation</title>
@ -341,7 +341,7 @@ and bug reports should be submitted at
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-04-28 Wed 13:31</p> <p class="date">Created: 2021-04-28 Wed 13:58</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

4
index.html
View File

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

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-04-28 Wed 13:31 --> <!-- 2021-04-28 Wed 13:58 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Front end API</title> <title>Front end API</title>
@ -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="#org23d90c6">1. Coding conventions</a> <li><a href="#org5844274">1. Coding conventions</a>
<ul> <ul>
<li><a href="#org1b4e234">1.1. Memory allocation</a></li> <li><a href="#orgd1f3119">1.1. Memory allocation</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org8a0f2e9">2. Front end</a> <li><a href="#org5b5bbd0">2. Front end</a>
<ul> <ul>
<li><a href="#orgda18db2">2.1. Error handling</a></li> <li><a href="#orgb7f90c8">2.1. Error handling</a></li>
<li><a href="#org066912e">2.2. Back ends</a></li> <li><a href="#orgb42c868">2.2. Back ends</a></li>
<li><a href="#org12bcb82">2.3. Read/write behavior</a></li> <li><a href="#org6ad7d73">2.3. Read/write behavior</a></li>
<li><a href="#org36c8338">2.4. TREXIO file type</a></li> <li><a href="#org9338761">2.4. TREXIO file type</a></li>
<li><a href="#org93a81e3">2.5. Polymorphism of the file handle</a></li> <li><a href="#orga862e55">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org5f7cbbe">2.6. File opening</a></li> <li><a href="#org1dfa48d">2.6. File opening</a></li>
<li><a href="#orgae66c0b">2.7. File closing</a></li> <li><a href="#orge070df0">2.7. File closing</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org2952b34">3. Templates for front end</a> <li><a href="#org4546d58">3. Templates for front end</a>
<ul> <ul>
<li><a href="#orgbc3053f">3.1. Templates for front end has/read/write a dimension</a> <li><a href="#orgba51d1f">3.1. Templates for front end has/read/write a dimension</a>
<ul> <ul>
<li><a href="#orgcfc13d8">3.1.1. C templates for front end</a></li> <li><a href="#orgd6e6efa">3.1.1. C templates for front end</a></li>
<li><a href="#orgb19e26e">3.1.2. Fortran templates for front end</a></li> <li><a href="#org78ac7c7">3.1.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org5db198e">3.2. Templates for front end has/read/write a dataset</a> <li><a href="#org2db4f75">3.2. Templates for front end has/read/write a dataset</a>
<ul> <ul>
<li><a href="#org00f8cf1">3.2.1. C templates for front end</a></li> <li><a href="#org0b64ab5">3.2.1. C templates for front end</a></li>
<li><a href="#org695c886">3.2.2. Fortran templates for front end</a></li> <li><a href="#org9b254bf">3.2.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org5098291">4. Fortran helper/wrapper functions</a></li> <li><a href="#org8e74ec2">4. Fortran helper/wrapper functions</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org23d90c6" class="outline-2"> <div id="outline-container-org5844274" class="outline-2">
<h2 id="org23d90c6"><span class="section-number-2">1</span> Coding conventions</h2> <h2 id="org5844274"><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-org1b4e234" class="outline-3"> <div id="outline-container-orgd1f3119" class="outline-3">
<h3 id="org1b4e234"><span class="section-number-3">1.1</span> Memory allocation</h3> <h3 id="orgd1f3119"><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
@ -392,8 +392,8 @@ This can be facilitated by the use of the following macro:
</div> </div>
</div> </div>
<div id="outline-container-org8a0f2e9" class="outline-2"> <div id="outline-container-org5b5bbd0" class="outline-2">
<h2 id="org8a0f2e9"><span class="section-number-2">2</span> Front end</h2> <h2 id="org5b5bbd0"><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.
@ -401,10 +401,10 @@ TREXIO front end is modular, which simplifies impelementation of new back ends.
</p> </p>
</div> </div>
<div id="outline-container-orgda18db2" class="outline-3"> <div id="outline-container-orgb7f90c8" class="outline-3">
<h3 id="orgda18db2"><span class="section-number-3">2.1</span> Error handling</h3> <h3 id="orgb7f90c8"><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="orgba28bcf" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org9098ff2" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -605,8 +605,8 @@ The text strings are extracted from the previous table.
</div> </div>
</div> </div>
<div id="outline-container-org066912e" class="outline-3"> <div id="outline-container-orgb42c868" class="outline-3">
<h3 id="org066912e"><span class="section-number-3">2.2</span> Back ends</h3> <h3 id="orgb42c868"><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:
@ -636,8 +636,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org12bcb82" class="outline-3"> <div id="outline-container-org6ad7d73" class="outline-3">
<h3 id="org12bcb82"><span class="section-number-3">2.3</span> Read/write behavior</h3> <h3 id="org6ad7d73"><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
@ -665,8 +665,8 @@ concurrent programs, the behavior is not specified.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-org36c8338" class="outline-3"> <div id="outline-container-org9338761" class="outline-3">
<h3 id="org36c8338"><span class="section-number-3">2.4</span> TREXIO file type</h3> <h3 id="org9338761"><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
@ -698,8 +698,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org93a81e3" class="outline-3"> <div id="outline-container-orga862e55" class="outline-3">
<h3 id="org93a81e3"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3> <h3 id="orga862e55"><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
@ -718,8 +718,8 @@ corresponding types for all back ends can be safely casted to
</div> </div>
</div> </div>
<div id="outline-container-org5f7cbbe" class="outline-3"> <div id="outline-container-org1dfa48d" class="outline-3">
<h3 id="org5f7cbbe"><span class="section-number-3">2.6</span> File opening</h3> <h3 id="org1dfa48d"><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.
@ -874,8 +874,8 @@ should tend to avoid renaming the <code>.txt</code> data files.
</div> </div>
</div> </div>
<div id="outline-container-orgae66c0b" class="outline-3"> <div id="outline-container-orge070df0" class="outline-3">
<h3 id="orgae66c0b"><span class="section-number-3">2.7</span> File closing</h3> <h3 id="orge070df0"><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.
@ -975,8 +975,8 @@ output:
</div> </div>
</div> </div>
<div id="outline-container-org2952b34" class="outline-2"> <div id="outline-container-org4546d58" class="outline-2">
<h2 id="org2952b34"><span class="section-number-2">3</span> Templates for front end</h2> <h2 id="org4546d58"><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>:
@ -1137,8 +1137,8 @@ TREXIO supports I/O with single or double precision for integer and floating poi
</div> </div>
<div id="outline-container-orgbc3053f" class="outline-3"> <div id="outline-container-orgba51d1f" class="outline-3">
<h3 id="orgbc3053f"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3> <h3 id="orgba51d1f"><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.
@ -1207,8 +1207,8 @@ This section concerns API calls related to dimensioning variables.
</table> </table>
</div> </div>
<div id="outline-container-orgcfc13d8" class="outline-4"> <div id="outline-container-orgd6e6efa" class="outline-4">
<h4 id="orgcfc13d8"><span class="section-number-4">3.1.1</span> C templates for front end</h4> <h4 id="orgd6e6efa"><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.
@ -1397,8 +1397,8 @@ The basic (non-suffixed) API call on dimensioning variables deals with single pr
</div> </div>
</div> </div>
<div id="outline-container-orgb19e26e" class="outline-4"> <div id="outline-container-org78ac7c7" class="outline-4">
<h4 id="orgb19e26e"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4> <h4 id="org78ac7c7"><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.
@ -1485,8 +1485,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div> </div>
<div id="outline-container-org5db198e" class="outline-3"> <div id="outline-container-org2db4f75" class="outline-3">
<h3 id="org5db198e"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3> <h3 id="org2db4f75"><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.
@ -1555,8 +1555,8 @@ This section concerns API calls related to datasets.
</table> </table>
</div> </div>
<div id="outline-container-org00f8cf1" class="outline-4"> <div id="outline-container-org0b64ab5" class="outline-4">
<h4 id="org00f8cf1"><span class="section-number-4">3.2.1</span> C templates for front end</h4> <h4 id="org0b64ab5"><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.
@ -1814,8 +1814,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
</div> </div>
</div> </div>
<div id="outline-container-org695c886" class="outline-4"> <div id="outline-container-org9b254bf" class="outline-4">
<h4 id="org695c886"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4> <h4 id="org9b254bf"><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>.
@ -1902,8 +1902,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div> </div>
</div> </div>
<div id="outline-container-org5098291" class="outline-2"> <div id="outline-container-org8e74ec2" class="outline-2">
<h2 id="org5098291"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2> <h2 id="org8e74ec2"><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.
@ -1932,7 +1932,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-04-28 Wed 13:31</p> <p class="date">Created: 2021-04-28 Wed 13:58</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

40
templator_hdf5.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-04-28 Wed 13:31 --> <!-- 2021-04-28 Wed 13:58 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>HDF5 back end</title> <title>HDF5 back end</title>
@ -311,25 +311,25 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org74d5a7a">1. HDF5 back end</a> <li><a href="#org0e6f1ac">1. HDF5 back end</a>
<ul> <ul>
<li><a href="#orgd2cb048">1.1. Template for HDF5 definitions</a></li> <li><a href="#org0dc4d63">1.1. Template for HDF5 definitions</a></li>
<li><a href="#orgdbef80e">1.2. Template for HDF5 structures</a></li> <li><a href="#org51143ff">1.2. Template for HDF5 structures</a></li>
<li><a href="#org13821db">1.3. Template for HDF5 init/deinit</a></li> <li><a href="#org3f9c7b2">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#orgd5e7d11">1.4. Template for HDF5 has/read/write a number</a></li> <li><a href="#org31b0f1c">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#orgf2080d6">1.5. Template for HDF5 has/read/write a dataset</a></li> <li><a href="#orgb75a875">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-org74d5a7a" class="outline-2"> <div id="outline-container-org0e6f1ac" class="outline-2">
<h2 id="org74d5a7a"><span class="section-number-2">1</span> HDF5 back end</h2> <h2 id="org0e6f1ac"><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-orgd2cb048" class="outline-3"> <div id="outline-container-org0dc4d63" class="outline-3">
<h3 id="orgd2cb048"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3> <h3 id="org0dc4d63"><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-orgdbef80e" class="outline-3"> <div id="outline-container-org51143ff" class="outline-3">
<h3 id="orgdbef80e"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3> <h3 id="org51143ff"><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-org13821db" class="outline-3"> <div id="outline-container-org3f9c7b2" class="outline-3">
<h3 id="org13821db"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3> <h3 id="org3f9c7b2"><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-orgd5e7d11" class="outline-3"> <div id="outline-container-org31b0f1c" class="outline-3">
<h3 id="orgd5e7d11"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3> <h3 id="org31b0f1c"><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-orgf2080d6" class="outline-3"> <div id="outline-container-orgb75a875" class="outline-3">
<h3 id="orgf2080d6"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3> <h3 id="orgb75a875"><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>
@ -696,7 +696,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-04-28 Wed 13:31</p> <p class="date">Created: 2021-04-28 Wed 13:58</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

100
templator_text.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-04-28 Wed 13:31 --> <!-- 2021-04-28 Wed 13:58 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TEXT back end</title> <title>TEXT back end</title>
@ -311,24 +311,24 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orga7edac1">1. TEXT back end</a> <li><a href="#org5f72a01">1. TEXT back end</a>
<ul> <ul>
<li><a href="#org700464a">1.1. Template for group-related structures in text back end</a></li> <li><a href="#orgc08f04d">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org8830f14">1.2. Template for general structure in text back end</a></li> <li><a href="#orgad04087">1.2. Template for general structure in text back end</a></li>
<li><a href="#orga5d9585">1.3. Initialize function (constant part)</a></li> <li><a href="#orga39f191">1.3. Initialize function (constant part)</a></li>
<li><a href="#org9a28438">1.4. Deinitialize function (templated part)</a></li> <li><a href="#orgac97a06">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#orgc837d1b">1.5. Template for text read struct</a></li> <li><a href="#org6feceb3">1.5. Template for text read struct</a></li>
<li><a href="#org4bbf248">1.6. Template for text flush struct</a></li> <li><a href="#orgbfa41a3">1.6. Template for text flush struct</a></li>
<li><a href="#org5ec0d72">1.7. Template for text free memory</a></li> <li><a href="#orgea07648">1.7. Template for text free memory</a></li>
<li><a href="#org74f50af">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li> <li><a href="#org09c74ff">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#orgd173f96">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li> <li><a href="#org5458047">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#org8da3442">1.10. RDM struct (hard-coded)</a> <li><a href="#org1fcd542">1.10. RDM struct (hard-coded)</a>
<ul> <ul>
<li><a href="#org06ca143">1.10.1. Read the complete struct</a></li> <li><a href="#org5f42552">1.10.1. Read the complete struct</a></li>
<li><a href="#orgf164a03">1.10.2. Flush the complete struct</a></li> <li><a href="#org2c7c401">1.10.2. Flush the complete struct</a></li>
<li><a href="#org0282d86">1.10.3. Free memory</a></li> <li><a href="#org72eaf77">1.10.3. Free memory</a></li>
<li><a href="#org863001f">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li> <li><a href="#orgc78c9ec">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org2e44326">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li> <li><a href="#orgc44a380">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-orga7edac1" class="outline-2"> <div id="outline-container-org5f72a01" class="outline-2">
<h2 id="orga7edac1"><span class="section-number-2">1</span> TEXT back end</h2> <h2 id="org5f72a01"><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-org700464a" class="outline-3"> <div id="outline-container-orgc08f04d" class="outline-3">
<h3 id="org700464a"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3> <h3 id="orgc08f04d"><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-org8830f14" class="outline-3"> <div id="outline-container-orgad04087" class="outline-3">
<h3 id="org8830f14"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3> <h3 id="orgad04087"><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-orga5d9585" class="outline-3"> <div id="outline-container-orga39f191" class="outline-3">
<h3 id="orga5d9585"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3> <h3 id="orga39f191"><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>
@ -507,8 +507,8 @@ The file is written when closed, or when the flush function is called.
</div> </div>
</div> </div>
<div id="outline-container-org9a28438" class="outline-3"> <div id="outline-container-orgac97a06" class="outline-3">
<h3 id="org9a28438"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3> <h3 id="orgac97a06"><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>
@ -532,8 +532,8 @@ The file is written when closed, or when the flush function is called.
</div> </div>
</div> </div>
<div id="outline-container-orgc837d1b" class="outline-3"> <div id="outline-container-org6feceb3" class="outline-3">
<h3 id="orgc837d1b"><span class="section-number-3">1.5</span> Template for text read struct</h3> <h3 id="org6feceb3"><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*
@ -724,8 +724,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div> </div>
</div> </div>
<div id="outline-container-org4bbf248" class="outline-3"> <div id="outline-container-orgbfa41a3" class="outline-3">
<h3 id="org4bbf248"><span class="section-number-3">1.6</span> Template for text flush struct</h3> <h3 id="orgbfa41a3"><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>
@ -783,8 +783,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div> </div>
</div> </div>
<div id="outline-container-org5ec0d72" class="outline-3"> <div id="outline-container-orgea07648" class="outline-3">
<h3 id="org5ec0d72"><span class="section-number-3">1.7</span> Template for text free memory</h3> <h3 id="orgea07648"><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.
@ -825,8 +825,8 @@ Memory is allocated when reading. The following function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-org74f50af" class="outline-3"> <div id="outline-container-org09c74ff" class="outline-3">
<h3 id="org74f50af"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3> <h3 id="org09c74ff"><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>
@ -888,8 +888,8 @@ Memory is allocated when reading. The following function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-orgd173f96" class="outline-3"> <div id="outline-container-org5458047" class="outline-3">
<h3 id="orgd173f96"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3> <h3 id="org5458047"><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.
@ -986,12 +986,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
<div id="outline-container-org8da3442" class="outline-3"> <div id="outline-container-org1fcd542" class="outline-3">
<h3 id="org8da3442"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3> <h3 id="org1fcd542"><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-org06ca143" class="outline-4"> <div id="outline-container-org5f42552" class="outline-4">
<h4 id="org06ca143"><span class="section-number-4">1.10.1</span> Read the complete struct</h4> <h4 id="org5f42552"><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>);
@ -1085,8 +1085,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
<div id="outline-container-orgf164a03" class="outline-4"> <div id="outline-container-org2c7c401" class="outline-4">
<h4 id="orgf164a03"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4> <h4 id="org2c7c401"><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>);
@ -1129,8 +1129,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
<div id="outline-container-org0282d86" class="outline-4"> <div id="outline-container-org72eaf77" class="outline-4">
<h4 id="org0282d86"><span class="section-number-4">1.10.3</span> Free memory</h4> <h4 id="org72eaf77"><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.
@ -1175,8 +1175,8 @@ Memory is allocated when reading. The followig function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-org863001f" class="outline-4"> <div id="outline-container-orgc78c9ec" class="outline-4">
<h4 id="org863001f"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4> <h4 id="orgc78c9ec"><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.
@ -1242,8 +1242,8 @@ The <code>one_e</code> array is assumed allocated with the appropriate size.
</div> </div>
</div> </div>
<div id="outline-container-org2e44326" class="outline-4"> <div id="outline-container-orgc44a380" class="outline-4">
<h4 id="org2e44326"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4> <h4 id="orgc44a380"><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
@ -1351,7 +1351,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-04-28 Wed 13:31</p> <p class="date">Created: 2021-04-28 Wed 13:58</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>