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

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

Browse Source
This commit is contained in:
q-posev 2021-04-30 12:31:58 +00:00
parent 9a7ceb9a8c
commit 81cf9b479a
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-30 Fri 12:30 --> <!-- 2021-04-30 Fri 12:31 -->
<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-30 Fri 12:30</p> <p class="date">Created: 2021-04-30 Fri 12:31</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-30 Fri 12:30 --> <!-- 2021-04-30 Fri 12:31 -->
<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-30 Fri 12:30</p> <p class="date">Created: 2021-04-30 Fri 12:31</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-30 Fri 12:30 --> <!-- 2021-04-30 Fri 12:31 -->
<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="#org743770a">1. Coding conventions</a> <li><a href="#org5c5d4f4">1. Coding conventions</a>
<ul> <ul>
<li><a href="#org797853d">1.1. Memory allocation</a></li> <li><a href="#org06d94ce">1.1. Memory allocation</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgbb3a3ce">2. Front end</a> <li><a href="#org535bf98">2. Front end</a>
<ul> <ul>
<li><a href="#orgbd73ac3">2.1. Error handling</a></li> <li><a href="#org966dfa1">2.1. Error handling</a></li>
<li><a href="#orgd2432af">2.2. Back ends</a></li> <li><a href="#org79f7a47">2.2. Back ends</a></li>
<li><a href="#orga7b14cb">2.3. Read/write behavior</a></li> <li><a href="#org64fad22">2.3. Read/write behavior</a></li>
<li><a href="#org7e7ca6e">2.4. TREXIO file type</a></li> <li><a href="#orgdaa8fd9">2.4. TREXIO file type</a></li>
<li><a href="#org6fbf3fd">2.5. Polymorphism of the file handle</a></li> <li><a href="#orga9ee72e">2.5. Polymorphism of the file handle</a></li>
<li><a href="#orgba25cb3">2.6. File opening</a></li> <li><a href="#org694ec0a">2.6. File opening</a></li>
<li><a href="#org619da8d">2.7. File closing</a></li> <li><a href="#orge1e02bf">2.7. File closing</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org715e17f">3. Templates for front end</a> <li><a href="#org26ec709">3. Templates for front end</a>
<ul> <ul>
<li><a href="#orgb0f1220">3.1. Templates for front end has/read/write a dimension</a> <li><a href="#org739fa0c">3.1. Templates for front end has/read/write a dimension</a>
<ul> <ul>
<li><a href="#orgec2b67d">3.1.1. C templates for front end</a></li> <li><a href="#org236f51b">3.1.1. C templates for front end</a></li>
<li><a href="#org79d3511">3.1.2. Fortran templates for front end</a></li> <li><a href="#orge658d4d">3.1.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orga12bad6">3.2. Templates for front end has/read/write a dataset</a> <li><a href="#orgd4c7c56">3.2. Templates for front end has/read/write a dataset</a>
<ul> <ul>
<li><a href="#org701a6a7">3.2.1. C templates for front end</a></li> <li><a href="#org4a94e8f">3.2.1. C templates for front end</a></li>
<li><a href="#orgc877672">3.2.2. Fortran templates for front end</a></li> <li><a href="#org321fc14">3.2.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org8a98a21">4. Fortran helper/wrapper functions</a></li> <li><a href="#org8907b61">4. Fortran helper/wrapper functions</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org743770a" class="outline-2"> <div id="outline-container-org5c5d4f4" class="outline-2">
<h2 id="org743770a"><span class="section-number-2">1</span> Coding conventions</h2> <h2 id="org5c5d4f4"><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-org797853d" class="outline-3"> <div id="outline-container-org06d94ce" class="outline-3">
<h3 id="org797853d"><span class="section-number-3">1.1</span> Memory allocation</h3> <h3 id="org06d94ce"><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-orgbb3a3ce" class="outline-2"> <div id="outline-container-org535bf98" class="outline-2">
<h2 id="orgbb3a3ce"><span class="section-number-2">2</span> Front end</h2> <h2 id="org535bf98"><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-orgbd73ac3" class="outline-3"> <div id="outline-container-org966dfa1" class="outline-3">
<h3 id="orgbd73ac3"><span class="section-number-3">2.1</span> Error handling</h3> <h3 id="org966dfa1"><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="org8b6fb79" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org6905217" 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-orgd2432af" class="outline-3"> <div id="outline-container-org79f7a47" class="outline-3">
<h3 id="orgd2432af"><span class="section-number-3">2.2</span> Back ends</h3> <h3 id="org79f7a47"><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-orga7b14cb" class="outline-3"> <div id="outline-container-org64fad22" class="outline-3">
<h3 id="orga7b14cb"><span class="section-number-3">2.3</span> Read/write behavior</h3> <h3 id="org64fad22"><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-org7e7ca6e" class="outline-3"> <div id="outline-container-orgdaa8fd9" class="outline-3">
<h3 id="org7e7ca6e"><span class="section-number-3">2.4</span> TREXIO file type</h3> <h3 id="orgdaa8fd9"><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-org6fbf3fd" class="outline-3"> <div id="outline-container-orga9ee72e" class="outline-3">
<h3 id="org6fbf3fd"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3> <h3 id="orga9ee72e"><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-orgba25cb3" class="outline-3"> <div id="outline-container-org694ec0a" class="outline-3">
<h3 id="orgba25cb3"><span class="section-number-3">2.6</span> File opening</h3> <h3 id="org694ec0a"><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-org619da8d" class="outline-3"> <div id="outline-container-orge1e02bf" class="outline-3">
<h3 id="org619da8d"><span class="section-number-3">2.7</span> File closing</h3> <h3 id="orge1e02bf"><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-org715e17f" class="outline-2"> <div id="outline-container-org26ec709" class="outline-2">
<h2 id="org715e17f"><span class="section-number-2">3</span> Templates for front end</h2> <h2 id="org26ec709"><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-orgb0f1220" class="outline-3"> <div id="outline-container-org739fa0c" class="outline-3">
<h3 id="orgb0f1220"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3> <h3 id="org739fa0c"><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-orgec2b67d" class="outline-4"> <div id="outline-container-org236f51b" class="outline-4">
<h4 id="orgec2b67d"><span class="section-number-4">3.1.1</span> C templates for front end</h4> <h4 id="org236f51b"><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-org79d3511" class="outline-4"> <div id="outline-container-orge658d4d" class="outline-4">
<h4 id="org79d3511"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4> <h4 id="orge658d4d"><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-orga12bad6" class="outline-3"> <div id="outline-container-orgd4c7c56" class="outline-3">
<h3 id="orga12bad6"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3> <h3 id="orgd4c7c56"><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-org701a6a7" class="outline-4"> <div id="outline-container-org4a94e8f" class="outline-4">
<h4 id="org701a6a7"><span class="section-number-4">3.2.1</span> C templates for front end</h4> <h4 id="org4a94e8f"><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-orgc877672" class="outline-4"> <div id="outline-container-org321fc14" class="outline-4">
<h4 id="orgc877672"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4> <h4 id="org321fc14"><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-org8a98a21" class="outline-2"> <div id="outline-container-org8907b61" class="outline-2">
<h2 id="org8a98a21"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2> <h2 id="org8907b61"><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-30 Fri 12:30</p> <p class="date">Created: 2021-04-30 Fri 12:31</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-30 Fri 12:30 --> <!-- 2021-04-30 Fri 12:31 -->
<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="#org4f59a77">1. HDF5 back end</a> <li><a href="#org6ea8b43">1. HDF5 back end</a>
<ul> <ul>
<li><a href="#org313d57a">1.1. Template for HDF5 definitions</a></li> <li><a href="#org33a36cd">1.1. Template for HDF5 definitions</a></li>
<li><a href="#orgf70f6dd">1.2. Template for HDF5 structures</a></li> <li><a href="#orgacd2c6a">1.2. Template for HDF5 structures</a></li>
<li><a href="#org3c0b219">1.3. Template for HDF5 init/deinit</a></li> <li><a href="#org3caafb5">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org2939ccf">1.4. Template for HDF5 has/read/write a number</a></li> <li><a href="#org7ea80e8">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org7f2f990">1.5. Template for HDF5 has/read/write a dataset</a></li> <li><a href="#org027e992">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-org4f59a77" class="outline-2"> <div id="outline-container-org6ea8b43" class="outline-2">
<h2 id="org4f59a77"><span class="section-number-2">1</span> HDF5 back end</h2> <h2 id="org6ea8b43"><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-org313d57a" class="outline-3"> <div id="outline-container-org33a36cd" class="outline-3">
<h3 id="org313d57a"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3> <h3 id="org33a36cd"><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-orgf70f6dd" class="outline-3"> <div id="outline-container-orgacd2c6a" class="outline-3">
<h3 id="orgf70f6dd"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3> <h3 id="orgacd2c6a"><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-org3c0b219" class="outline-3"> <div id="outline-container-org3caafb5" class="outline-3">
<h3 id="org3c0b219"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3> <h3 id="org3caafb5"><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-org2939ccf" class="outline-3"> <div id="outline-container-org7ea80e8" class="outline-3">
<h3 id="org2939ccf"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3> <h3 id="org7ea80e8"><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-org7f2f990" class="outline-3"> <div id="outline-container-org027e992" class="outline-3">
<h3 id="org7f2f990"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3> <h3 id="org027e992"><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-30 Fri 12:30</p> <p class="date">Created: 2021-04-30 Fri 12:31</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-30 Fri 12:30 --> <!-- 2021-04-30 Fri 12:31 -->
<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="#orgff62af8">1. TEXT back end</a> <li><a href="#org4a86adf">1. TEXT back end</a>
<ul> <ul>
<li><a href="#orgb40c654">1.1. Template for group-related structures in text back end</a></li> <li><a href="#orgf849950">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#orga1ea520">1.2. Template for general structure in text back end</a></li> <li><a href="#org94b706d">1.2. Template for general structure in text back end</a></li>
<li><a href="#org55515d1">1.3. Initialize function (constant part)</a></li> <li><a href="#org5940578">1.3. Initialize function (constant part)</a></li>
<li><a href="#org23b6009">1.4. Deinitialize function (templated part)</a></li> <li><a href="#orgfaf5794">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org5c6a95f">1.5. Template for text read struct</a></li> <li><a href="#orgfdd5720">1.5. Template for text read struct</a></li>
<li><a href="#org1f3eafe">1.6. Template for text flush struct</a></li> <li><a href="#orge3d801d">1.6. Template for text flush struct</a></li>
<li><a href="#org931f05f">1.7. Template for text free memory</a></li> <li><a href="#org00c5396">1.7. Template for text free memory</a></li>
<li><a href="#org15edfa4">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li> <li><a href="#org7569b6d">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#orgfcb3bcd">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li> <li><a href="#orgf200f46">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#orga9960e9">1.10. RDM struct (hard-coded)</a> <li><a href="#orgaa1ea5e">1.10. RDM struct (hard-coded)</a>
<ul> <ul>
<li><a href="#org1408a34">1.10.1. Read the complete struct</a></li> <li><a href="#orge8d79e4">1.10.1. Read the complete struct</a></li>
<li><a href="#orged7cc81">1.10.2. Flush the complete struct</a></li> <li><a href="#orgab9c5b4">1.10.2. Flush the complete struct</a></li>
<li><a href="#org14179c4">1.10.3. Free memory</a></li> <li><a href="#orge74f396">1.10.3. Free memory</a></li>
<li><a href="#org43a74f1">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li> <li><a href="#orgd69408a">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org27835d6">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li> <li><a href="#org202d4ef">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-orgff62af8" class="outline-2"> <div id="outline-container-org4a86adf" class="outline-2">
<h2 id="orgff62af8"><span class="section-number-2">1</span> TEXT back end</h2> <h2 id="org4a86adf"><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-orgb40c654" class="outline-3"> <div id="outline-container-orgf849950" class="outline-3">
<h3 id="orgb40c654"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3> <h3 id="orgf849950"><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-orga1ea520" class="outline-3"> <div id="outline-container-org94b706d" class="outline-3">
<h3 id="orga1ea520"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3> <h3 id="org94b706d"><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-org55515d1" class="outline-3"> <div id="outline-container-org5940578" class="outline-3">
<h3 id="org55515d1"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3> <h3 id="org5940578"><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-org23b6009" class="outline-3"> <div id="outline-container-orgfaf5794" class="outline-3">
<h3 id="org23b6009"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3> <h3 id="orgfaf5794"><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-org5c6a95f" class="outline-3"> <div id="outline-container-orgfdd5720" class="outline-3">
<h3 id="org5c6a95f"><span class="section-number-3">1.5</span> Template for text read struct</h3> <h3 id="orgfdd5720"><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-org1f3eafe" class="outline-3"> <div id="outline-container-orge3d801d" class="outline-3">
<h3 id="org1f3eafe"><span class="section-number-3">1.6</span> Template for text flush struct</h3> <h3 id="orge3d801d"><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-org931f05f" class="outline-3"> <div id="outline-container-org00c5396" class="outline-3">
<h3 id="org931f05f"><span class="section-number-3">1.7</span> Template for text free memory</h3> <h3 id="org00c5396"><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-org15edfa4" class="outline-3"> <div id="outline-container-org7569b6d" class="outline-3">
<h3 id="org15edfa4"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3> <h3 id="org7569b6d"><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-orgfcb3bcd" class="outline-3"> <div id="outline-container-orgf200f46" class="outline-3">
<h3 id="orgfcb3bcd"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3> <h3 id="orgf200f46"><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-orga9960e9" class="outline-3"> <div id="outline-container-orgaa1ea5e" class="outline-3">
<h3 id="orga9960e9"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3> <h3 id="orgaa1ea5e"><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-org1408a34" class="outline-4"> <div id="outline-container-orge8d79e4" class="outline-4">
<h4 id="org1408a34"><span class="section-number-4">1.10.1</span> Read the complete struct</h4> <h4 id="orge8d79e4"><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-orged7cc81" class="outline-4"> <div id="outline-container-orgab9c5b4" class="outline-4">
<h4 id="orged7cc81"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4> <h4 id="orgab9c5b4"><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-org14179c4" class="outline-4"> <div id="outline-container-orge74f396" class="outline-4">
<h4 id="org14179c4"><span class="section-number-4">1.10.3</span> Free memory</h4> <h4 id="orge74f396"><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-org43a74f1" class="outline-4"> <div id="outline-container-orgd69408a" class="outline-4">
<h4 id="org43a74f1"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4> <h4 id="orgd69408a"><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-org27835d6" class="outline-4"> <div id="outline-container-org202d4ef" class="outline-4">
<h4 id="org27835d6"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4> <h4 id="org202d4ef"><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-30 Fri 12:30</p> <p class="date">Created: 2021-04-30 Fri 12:31</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>