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

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

Browse Source
This commit is contained in:
q-posev 2021-05-03 13:59:05 +00:00
parent 8d6fbc729e
commit c0ac147896
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-03 Mon 13:28 --> <!-- 2021-05-03 Mon 13:59 -->
<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-03 Mon 13:28</p> <p class="date">Created: 2021-05-03 Mon 13:59</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-03 Mon 13:28 --> <!-- 2021-05-03 Mon 13:59 -->
<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-03 Mon 13:28</p> <p class="date">Created: 2021-05-03 Mon 13:59</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-03 Mon 13:28 --> <!-- 2021-05-03 Mon 13:59 -->
<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="#orgbcf1746">1. Coding conventions</a> <li><a href="#orgdbf382c">1. Coding conventions</a>
<ul> <ul>
<li><a href="#orga877960">1.1. Memory allocation</a></li> <li><a href="#org4503912">1.1. Memory allocation</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org041bbd7">2. Front end</a> <li><a href="#org9fa2282">2. Front end</a>
<ul> <ul>
<li><a href="#orga385f2e">2.1. Error handling</a></li> <li><a href="#org2e0f1f7">2.1. Error handling</a></li>
<li><a href="#org23b6baa">2.2. Back ends</a></li> <li><a href="#orge6b0336">2.2. Back ends</a></li>
<li><a href="#org6a8f4c3">2.3. Read/write behavior</a></li> <li><a href="#orgad8ee72">2.3. Read/write behavior</a></li>
<li><a href="#orge0f0fc7">2.4. TREXIO file type</a></li> <li><a href="#org0d31558">2.4. TREXIO file type</a></li>
<li><a href="#orgcc278fa">2.5. Polymorphism of the file handle</a></li> <li><a href="#orgee1609c">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org76161e0">2.6. File opening</a></li> <li><a href="#org60813ff">2.6. File opening</a></li>
<li><a href="#org5723b36">2.7. File closing</a></li> <li><a href="#orgf779071">2.7. File closing</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org06cbd77">3. Templates for front end</a> <li><a href="#orgf10ccdb">3. Templates for front end</a>
<ul> <ul>
<li><a href="#orgea8cf8d">3.1. Templates for front end has/read/write a dimension</a> <li><a href="#org0128eb3">3.1. Templates for front end has/read/write a dimension</a>
<ul> <ul>
<li><a href="#orgec8bad7">3.1.1. C templates for front end</a></li> <li><a href="#org26fe49b">3.1.1. C templates for front end</a></li>
<li><a href="#org56552d0">3.1.2. Fortran templates for front end</a></li> <li><a href="#org90cd6ac">3.1.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org7a9512f">3.2. Templates for front end has/read/write a dataset</a> <li><a href="#org0b7ebd9">3.2. Templates for front end has/read/write a dataset</a>
<ul> <ul>
<li><a href="#org38adcfa">3.2.1. C templates for front end</a></li> <li><a href="#org87607b6">3.2.1. C templates for front end</a></li>
<li><a href="#orgfceb955">3.2.2. Fortran templates for front end</a></li> <li><a href="#org1d94400">3.2.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org8fc4f99">4. Fortran helper/wrapper functions</a></li> <li><a href="#orgd70fbc7">4. Fortran helper/wrapper functions</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-orgbcf1746" class="outline-2"> <div id="outline-container-orgdbf382c" class="outline-2">
<h2 id="orgbcf1746"><span class="section-number-2">1</span> Coding conventions</h2> <h2 id="orgdbf382c"><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-orga877960" class="outline-3"> <div id="outline-container-org4503912" class="outline-3">
<h3 id="orga877960"><span class="section-number-3">1.1</span> Memory allocation</h3> <h3 id="org4503912"><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-org041bbd7" class="outline-2"> <div id="outline-container-org9fa2282" class="outline-2">
<h2 id="org041bbd7"><span class="section-number-2">2</span> Front end</h2> <h2 id="org9fa2282"><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-orga385f2e" class="outline-3"> <div id="outline-container-org2e0f1f7" class="outline-3">
<h3 id="orga385f2e"><span class="section-number-3">2.1</span> Error handling</h3> <h3 id="org2e0f1f7"><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="orgdae52e5" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orga152212" 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-org23b6baa" class="outline-3"> <div id="outline-container-orge6b0336" class="outline-3">
<h3 id="org23b6baa"><span class="section-number-3">2.2</span> Back ends</h3> <h3 id="orge6b0336"><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-org6a8f4c3" class="outline-3"> <div id="outline-container-orgad8ee72" class="outline-3">
<h3 id="org6a8f4c3"><span class="section-number-3">2.3</span> Read/write behavior</h3> <h3 id="orgad8ee72"><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-orge0f0fc7" class="outline-3"> <div id="outline-container-org0d31558" class="outline-3">
<h3 id="orge0f0fc7"><span class="section-number-3">2.4</span> TREXIO file type</h3> <h3 id="org0d31558"><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-orgcc278fa" class="outline-3"> <div id="outline-container-orgee1609c" class="outline-3">
<h3 id="orgcc278fa"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3> <h3 id="orgee1609c"><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-org76161e0" class="outline-3"> <div id="outline-container-org60813ff" class="outline-3">
<h3 id="org76161e0"><span class="section-number-3">2.6</span> File opening</h3> <h3 id="org60813ff"><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-org5723b36" class="outline-3"> <div id="outline-container-orgf779071" class="outline-3">
<h3 id="org5723b36"><span class="section-number-3">2.7</span> File closing</h3> <h3 id="orgf779071"><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-org06cbd77" class="outline-2"> <div id="outline-container-orgf10ccdb" class="outline-2">
<h2 id="org06cbd77"><span class="section-number-2">3</span> Templates for front end</h2> <h2 id="orgf10ccdb"><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-orgea8cf8d" class="outline-3"> <div id="outline-container-org0128eb3" class="outline-3">
<h3 id="orgea8cf8d"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3> <h3 id="org0128eb3"><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-orgec8bad7" class="outline-4"> <div id="outline-container-org26fe49b" class="outline-4">
<h4 id="orgec8bad7"><span class="section-number-4">3.1.1</span> C templates for front end</h4> <h4 id="org26fe49b"><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-org56552d0" class="outline-4"> <div id="outline-container-org90cd6ac" class="outline-4">
<h4 id="org56552d0"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4> <h4 id="org90cd6ac"><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-org7a9512f" class="outline-3"> <div id="outline-container-org0b7ebd9" class="outline-3">
<h3 id="org7a9512f"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3> <h3 id="org0b7ebd9"><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-org38adcfa" class="outline-4"> <div id="outline-container-org87607b6" class="outline-4">
<h4 id="org38adcfa"><span class="section-number-4">3.2.1</span> C templates for front end</h4> <h4 id="org87607b6"><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-orgfceb955" class="outline-4"> <div id="outline-container-org1d94400" class="outline-4">
<h4 id="orgfceb955"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4> <h4 id="org1d94400"><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-org8fc4f99" class="outline-2"> <div id="outline-container-orgd70fbc7" class="outline-2">
<h2 id="org8fc4f99"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2> <h2 id="orgd70fbc7"><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-05-03 Mon 13:28</p> <p class="date">Created: 2021-05-03 Mon 13:59</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-03 Mon 13:28 --> <!-- 2021-05-03 Mon 13:59 -->
<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="#org52bc2ce">1. HDF5 back end</a> <li><a href="#org3d47e58">1. HDF5 back end</a>
<ul> <ul>
<li><a href="#org56a2a80">1.1. Template for HDF5 definitions</a></li> <li><a href="#org8d1c4f6">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org293417a">1.2. Template for HDF5 structures</a></li> <li><a href="#org41102b1">1.2. Template for HDF5 structures</a></li>
<li><a href="#orgbf0cb6f">1.3. Template for HDF5 init/deinit</a></li> <li><a href="#org4fe7c17">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org3f7a4ed">1.4. Template for HDF5 has/read/write a number</a></li> <li><a href="#org61a2a1b">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org54e7eaf">1.5. Template for HDF5 has/read/write a dataset</a></li> <li><a href="#org633b39e">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-org52bc2ce" class="outline-2"> <div id="outline-container-org3d47e58" class="outline-2">
<h2 id="org52bc2ce"><span class="section-number-2">1</span> HDF5 back end</h2> <h2 id="org3d47e58"><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-org56a2a80" class="outline-3"> <div id="outline-container-org8d1c4f6" class="outline-3">
<h3 id="org56a2a80"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3> <h3 id="org8d1c4f6"><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-org293417a" class="outline-3"> <div id="outline-container-org41102b1" class="outline-3">
<h3 id="org293417a"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3> <h3 id="org41102b1"><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-orgbf0cb6f" class="outline-3"> <div id="outline-container-org4fe7c17" class="outline-3">
<h3 id="orgbf0cb6f"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3> <h3 id="org4fe7c17"><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-org3f7a4ed" class="outline-3"> <div id="outline-container-org61a2a1b" class="outline-3">
<h3 id="org3f7a4ed"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3> <h3 id="org61a2a1b"><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-org54e7eaf" class="outline-3"> <div id="outline-container-org633b39e" class="outline-3">
<h3 id="org54e7eaf"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3> <h3 id="org633b39e"><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-05-03 Mon 13:28</p> <p class="date">Created: 2021-05-03 Mon 13:59</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-03 Mon 13:28 --> <!-- 2021-05-03 Mon 13:59 -->
<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="#org41d3ccc">1. TEXT back end</a> <li><a href="#org00c4540">1. TEXT back end</a>
<ul> <ul>
<li><a href="#org2b325cc">1.1. Template for group-related structures in text back end</a></li> <li><a href="#orge4874aa">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org2b2bc6b">1.2. Template for general structure in text back end</a></li> <li><a href="#org7345874">1.2. Template for general structure in text back end</a></li>
<li><a href="#org3554851">1.3. Initialize function (constant part)</a></li> <li><a href="#org4714e9d">1.3. Initialize function (constant part)</a></li>
<li><a href="#orga2fa7cf">1.4. Deinitialize function (templated part)</a></li> <li><a href="#org1746d54">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org0bfccc9">1.5. Template for text read struct</a></li> <li><a href="#org41a784b">1.5. Template for text read struct</a></li>
<li><a href="#org93d2780">1.6. Template for text flush struct</a></li> <li><a href="#orgdf7c991">1.6. Template for text flush struct</a></li>
<li><a href="#org9569240">1.7. Template for text free memory</a></li> <li><a href="#org5910239">1.7. Template for text free memory</a></li>
<li><a href="#org081fbfa">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li> <li><a href="#org92bacd4">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org74931ba">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li> <li><a href="#org9f73219">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#org73b3f5f">1.10. RDM struct (hard-coded)</a> <li><a href="#org0289f90">1.10. RDM struct (hard-coded)</a>
<ul> <ul>
<li><a href="#org12fbb8a">1.10.1. Read the complete struct</a></li> <li><a href="#orgffaf7f6">1.10.1. Read the complete struct</a></li>
<li><a href="#orgc874376">1.10.2. Flush the complete struct</a></li> <li><a href="#org6f476d8">1.10.2. Flush the complete struct</a></li>
<li><a href="#orga918da3">1.10.3. Free memory</a></li> <li><a href="#org39bf352">1.10.3. Free memory</a></li>
<li><a href="#org9a37505">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li> <li><a href="#org09e11e1">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org2eecdb7">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li> <li><a href="#org5cd1d66">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-org41d3ccc" class="outline-2"> <div id="outline-container-org00c4540" class="outline-2">
<h2 id="org41d3ccc"><span class="section-number-2">1</span> TEXT back end</h2> <h2 id="org00c4540"><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-org2b325cc" class="outline-3"> <div id="outline-container-orge4874aa" class="outline-3">
<h3 id="org2b325cc"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3> <h3 id="orge4874aa"><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-org2b2bc6b" class="outline-3"> <div id="outline-container-org7345874" class="outline-3">
<h3 id="org2b2bc6b"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3> <h3 id="org7345874"><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-org3554851" class="outline-3"> <div id="outline-container-org4714e9d" class="outline-3">
<h3 id="org3554851"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3> <h3 id="org4714e9d"><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-orga2fa7cf" class="outline-3"> <div id="outline-container-org1746d54" class="outline-3">
<h3 id="orga2fa7cf"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3> <h3 id="org1746d54"><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-org0bfccc9" class="outline-3"> <div id="outline-container-org41a784b" class="outline-3">
<h3 id="org0bfccc9"><span class="section-number-3">1.5</span> Template for text read struct</h3> <h3 id="org41a784b"><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-org93d2780" class="outline-3"> <div id="outline-container-orgdf7c991" class="outline-3">
<h3 id="org93d2780"><span class="section-number-3">1.6</span> Template for text flush struct</h3> <h3 id="orgdf7c991"><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-org9569240" class="outline-3"> <div id="outline-container-org5910239" class="outline-3">
<h3 id="org9569240"><span class="section-number-3">1.7</span> Template for text free memory</h3> <h3 id="org5910239"><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-org081fbfa" class="outline-3"> <div id="outline-container-org92bacd4" class="outline-3">
<h3 id="org081fbfa"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3> <h3 id="org92bacd4"><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-org74931ba" class="outline-3"> <div id="outline-container-org9f73219" class="outline-3">
<h3 id="org74931ba"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3> <h3 id="org9f73219"><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-org73b3f5f" class="outline-3"> <div id="outline-container-org0289f90" class="outline-3">
<h3 id="org73b3f5f"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3> <h3 id="org0289f90"><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-org12fbb8a" class="outline-4"> <div id="outline-container-orgffaf7f6" class="outline-4">
<h4 id="org12fbb8a"><span class="section-number-4">1.10.1</span> Read the complete struct</h4> <h4 id="orgffaf7f6"><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-orgc874376" class="outline-4"> <div id="outline-container-org6f476d8" class="outline-4">
<h4 id="orgc874376"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4> <h4 id="org6f476d8"><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-orga918da3" class="outline-4"> <div id="outline-container-org39bf352" class="outline-4">
<h4 id="orga918da3"><span class="section-number-4">1.10.3</span> Free memory</h4> <h4 id="org39bf352"><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-org9a37505" class="outline-4"> <div id="outline-container-org09e11e1" class="outline-4">
<h4 id="org9a37505"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4> <h4 id="org09e11e1"><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-org2eecdb7" class="outline-4"> <div id="outline-container-org5cd1d66" class="outline-4">
<h4 id="org2eecdb7"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4> <h4 id="org5cd1d66"><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-05-03 Mon 13:28</p> <p class="date">Created: 2021-05-03 Mon 13:59</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>