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

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

Browse Source
This commit is contained in:
scemama 2021-05-05 09:38:58 +00:00
parent 08c51df287
commit 7d8076a903
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-04 Tue 18:30 --> <!-- 2021-05-05 Wed 09:38 -->
<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-04 Tue 18:30</p> <p class="date">Created: 2021-05-05 Wed 09:38</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-04 Tue 18:30 --> <!-- 2021-05-05 Wed 09:38 -->
<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-04 Tue 18:30</p> <p class="date">Created: 2021-05-05 Wed 09:38</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-04 Tue 18:30 --> <!-- 2021-05-05 Wed 09:38 -->
<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="#org2efd785">1. Coding conventions</a> <li><a href="#orgeb1a20b">1. Coding conventions</a>
<ul> <ul>
<li><a href="#org5b753ac">1.1. Memory allocation</a></li> <li><a href="#org5d18956">1.1. Memory allocation</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orge18589e">2. Front end</a> <li><a href="#org5f88e86">2. Front end</a>
<ul> <ul>
<li><a href="#org5bb8b74">2.1. Error handling</a></li> <li><a href="#org3d1aa69">2.1. Error handling</a></li>
<li><a href="#orgd777a6c">2.2. Back ends</a></li> <li><a href="#org487f572">2.2. Back ends</a></li>
<li><a href="#orgdae76ce">2.3. Read/write behavior</a></li> <li><a href="#orgbc99dcb">2.3. Read/write behavior</a></li>
<li><a href="#org0e3de38">2.4. TREXIO file type</a></li> <li><a href="#org2950cb7">2.4. TREXIO file type</a></li>
<li><a href="#org5754a2a">2.5. Polymorphism of the file handle</a></li> <li><a href="#org848c014">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org3b4bb05">2.6. File opening</a></li> <li><a href="#orgf6684b8">2.6. File opening</a></li>
<li><a href="#org8d6d4bf">2.7. File closing</a></li> <li><a href="#orge78b2bb">2.7. File closing</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org57e5025">3. Templates for front end</a> <li><a href="#org7be86a5">3. Templates for front end</a>
<ul> <ul>
<li><a href="#org088287b">3.1. Templates for front end has/read/write a dimension</a> <li><a href="#org6e3e500">3.1. Templates for front end has/read/write a dimension</a>
<ul> <ul>
<li><a href="#org76589f0">3.1.1. C templates for front end</a></li> <li><a href="#orga239030">3.1.1. C templates for front end</a></li>
<li><a href="#org27357ab">3.1.2. Fortran templates for front end</a></li> <li><a href="#orga907e99">3.1.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org78d6e69">3.2. Templates for front end has/read/write a dataset</a> <li><a href="#orgd770395">3.2. Templates for front end has/read/write a dataset</a>
<ul> <ul>
<li><a href="#org92b10fd">3.2.1. C templates for front end</a></li> <li><a href="#org3d7bf06">3.2.1. C templates for front end</a></li>
<li><a href="#org1cefff9">3.2.2. Fortran templates for front end</a></li> <li><a href="#org6d26f2e">3.2.2. Fortran templates for front end</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#orga6c60fe">4. Fortran helper/wrapper functions</a></li> <li><a href="#org530f5f2">4. Fortran helper/wrapper functions</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org2efd785" class="outline-2"> <div id="outline-container-orgeb1a20b" class="outline-2">
<h2 id="org2efd785"><span class="section-number-2">1</span> Coding conventions</h2> <h2 id="orgeb1a20b"><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-org5b753ac" class="outline-3"> <div id="outline-container-org5d18956" class="outline-3">
<h3 id="org5b753ac"><span class="section-number-3">1.1</span> Memory allocation</h3> <h3 id="org5d18956"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<p> <p>
Memory allocation of structures can be facilitated by using the Memory allocation of structures can be facilitated by using the
@ -399,8 +399,8 @@ The maximum string size for the filenames is 4096 characters.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-orge18589e" class="outline-2"> <div id="outline-container-org5f88e86" class="outline-2">
<h2 id="orge18589e"><span class="section-number-2">2</span> Front end</h2> <h2 id="org5f88e86"><span class="section-number-2">2</span> Front end</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
All calls to TREXIO are thread-safe. All calls to TREXIO are thread-safe.
@ -408,10 +408,10 @@ TREXIO front end is modular, which simplifies impelementation of new back ends.
</p> </p>
</div> </div>
<div id="outline-container-org5bb8b74" class="outline-3"> <div id="outline-container-org3d1aa69" class="outline-3">
<h3 id="org5bb8b74"><span class="section-number-3">2.1</span> Error handling</h3> <h3 id="org3d1aa69"><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="orgc9d9e19" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgac72473" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -612,8 +612,8 @@ The text strings are extracted from the previous table.
</div> </div>
</div> </div>
<div id="outline-container-orgd777a6c" class="outline-3"> <div id="outline-container-org487f572" class="outline-3">
<h3 id="orgd777a6c"><span class="section-number-3">2.2</span> Back ends</h3> <h3 id="org487f572"><span class="section-number-3">2.2</span> Back ends</h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
<p> <p>
TREXIO has several back ends: TREXIO has several back ends:
@ -643,8 +643,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-orgdae76ce" class="outline-3"> <div id="outline-container-orgbc99dcb" class="outline-3">
<h3 id="orgdae76ce"><span class="section-number-3">2.3</span> Read/write behavior</h3> <h3 id="orgbc99dcb"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div class="outline-text-3" id="text-2-3"> <div class="outline-text-3" id="text-2-3">
<p> <p>
Every time a reading function is called, the data is read from the Every time a reading function is called, the data is read from the
@ -672,8 +672,8 @@ concurrent programs, the behavior is not specified.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-org0e3de38" class="outline-3"> <div id="outline-container-org2950cb7" class="outline-3">
<h3 id="org0e3de38"><span class="section-number-3">2.4</span> TREXIO file type</h3> <h3 id="org2950cb7"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div class="outline-text-3" id="text-2-4"> <div class="outline-text-3" id="text-2-4">
<p> <p>
<code>trexio_s</code> is the the main type for TREXIO files, visible to the users <code>trexio_s</code> is the the main type for TREXIO files, visible to the users
@ -705,8 +705,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org5754a2a" class="outline-3"> <div id="outline-container-org848c014" class="outline-3">
<h3 id="org5754a2a"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3> <h3 id="org848c014"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div class="outline-text-3" id="text-2-5"> <div class="outline-text-3" id="text-2-5">
<p> <p>
Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the
@ -725,8 +725,8 @@ corresponding types for all back ends can be safely casted to
</div> </div>
</div> </div>
<div id="outline-container-org3b4bb05" class="outline-3"> <div id="outline-container-orgf6684b8" class="outline-3">
<h3 id="org3b4bb05"><span class="section-number-3">2.6</span> File opening</h3> <h3 id="orgf6684b8"><span class="section-number-3">2.6</span> File opening</h3>
<div class="outline-text-3" id="text-2-6"> <div class="outline-text-3" id="text-2-6">
<p> <p>
<code>trexio_open</code> creates a new TREXIO file or opens existing one. <code>trexio_open</code> creates a new TREXIO file or opens existing one.
@ -888,8 +888,8 @@ should tend to avoid renaming the <code>.txt</code> data files.
</div> </div>
</div> </div>
<div id="outline-container-org8d6d4bf" class="outline-3"> <div id="outline-container-orge78b2bb" class="outline-3">
<h3 id="org8d6d4bf"><span class="section-number-3">2.7</span> File closing</h3> <h3 id="orge78b2bb"><span class="section-number-3">2.7</span> File closing</h3>
<div class="outline-text-3" id="text-2-7"> <div class="outline-text-3" id="text-2-7">
<p> <p>
<code>trexio_close</code> closes an existing <code>trexio_t</code> file. <code>trexio_close</code> closes an existing <code>trexio_t</code> file.
@ -988,8 +988,8 @@ output:
</div> </div>
</div> </div>
<div id="outline-container-org57e5025" class="outline-2"> <div id="outline-container-org7be86a5" class="outline-2">
<h2 id="org57e5025"><span class="section-number-2">3</span> Templates for front end</h2> <h2 id="org7be86a5"><span class="section-number-2">3</span> Templates for front end</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
<p> <p>
Consider the following block of <code>trex.json</code>: Consider the following block of <code>trex.json</code>:
@ -1150,8 +1150,8 @@ TREXIO supports I/O with single or double precision for integer and floating poi
</div> </div>
<div id="outline-container-org088287b" class="outline-3"> <div id="outline-container-org6e3e500" class="outline-3">
<h3 id="org088287b"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3> <h3 id="org6e3e500"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3>
<div class="outline-text-3" id="text-3-1"> <div class="outline-text-3" id="text-3-1">
<p> <p>
This section concerns API calls related to dimensioning variables. This section concerns API calls related to dimensioning variables.
@ -1220,8 +1220,8 @@ This section concerns API calls related to dimensioning variables.
</table> </table>
</div> </div>
<div id="outline-container-org76589f0" class="outline-4"> <div id="outline-container-orga239030" class="outline-4">
<h4 id="org76589f0"><span class="section-number-4">3.1.1</span> C templates for front end</h4> <h4 id="orga239030"><span class="section-number-4">3.1.1</span> C templates for front end</h4>
<div class="outline-text-4" id="text-3-1-1"> <div class="outline-text-4" id="text-3-1-1">
<p> <p>
The <code>C</code> templates that correspond to each of the abovementioned functions can be found below. The <code>C</code> templates that correspond to each of the abovementioned functions can be found below.
@ -1410,8 +1410,8 @@ The basic (non-suffixed) API call on dimensioning variables deals with single pr
</div> </div>
</div> </div>
<div id="outline-container-org27357ab" class="outline-4"> <div id="outline-container-orga907e99" class="outline-4">
<h4 id="org27357ab"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4> <h4 id="orga907e99"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4>
<div class="outline-text-4" id="text-3-1-2"> <div class="outline-text-4" id="text-3-1-2">
<p> <p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran. The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
@ -1498,8 +1498,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div> </div>
<div id="outline-container-org78d6e69" class="outline-3"> <div id="outline-container-orgd770395" class="outline-3">
<h3 id="org78d6e69"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3> <h3 id="orgd770395"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3>
<div class="outline-text-3" id="text-3-2"> <div class="outline-text-3" id="text-3-2">
<p> <p>
This section concerns API calls related to datasets. This section concerns API calls related to datasets.
@ -1568,8 +1568,8 @@ This section concerns API calls related to datasets.
</table> </table>
</div> </div>
<div id="outline-container-org92b10fd" class="outline-4"> <div id="outline-container-org3d7bf06" class="outline-4">
<h4 id="org92b10fd"><span class="section-number-4">3.2.1</span> C templates for front end</h4> <h4 id="org3d7bf06"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
<div class="outline-text-4" id="text-3-2-1"> <div class="outline-text-4" id="text-3-2-1">
<p> <p>
The C templates that correspond to each of the abovementioned functions can be found below. The C templates that correspond to each of the abovementioned functions can be found below.
@ -1827,8 +1827,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
</div> </div>
</div> </div>
<div id="outline-container-org1cefff9" class="outline-4"> <div id="outline-container-org6d26f2e" class="outline-4">
<h4 id="org1cefff9"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4> <h4 id="org6d26f2e"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
<div class="outline-text-4" id="text-3-2-2"> <div class="outline-text-4" id="text-3-2-2">
<p> <p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>. The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
@ -1915,8 +1915,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div> </div>
</div> </div>
<div id="outline-container-orga6c60fe" class="outline-2"> <div id="outline-container-org530f5f2" class="outline-2">
<h2 id="orga6c60fe"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2> <h2 id="org530f5f2"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div class="outline-text-2" id="text-4"> <div class="outline-text-2" id="text-4">
<p> <p>
The function below adapts the original C-based <code>trexio_open</code> for Fortran. The function below adapts the original C-based <code>trexio_open</code> for Fortran.
@ -1945,7 +1945,7 @@ Note, that Fortran interface calls the main <code>TREXIO</code> API, which is wr
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-05-04 Tue 18:30</p> <p class="date">Created: 2021-05-05 Wed 09:38</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-04 Tue 18:30 --> <!-- 2021-05-05 Wed 09:38 -->
<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="#orgb271fc0">1. HDF5 back end</a> <li><a href="#org90617b2">1. HDF5 back end</a>
<ul> <ul>
<li><a href="#org41f053f">1.1. Template for HDF5 definitions</a></li> <li><a href="#org5dac1d1">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org03a86f5">1.2. Template for HDF5 structures</a></li> <li><a href="#org1b81500">1.2. Template for HDF5 structures</a></li>
<li><a href="#org8d0218a">1.3. Template for HDF5 init/deinit</a></li> <li><a href="#org8081aa9">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org9552dd2">1.4. Template for HDF5 has/read/write a number</a></li> <li><a href="#org7dfd443">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org4ef22e1">1.5. Template for HDF5 has/read/write a dataset</a></li> <li><a href="#org7a9fdc0">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-orgb271fc0" class="outline-2"> <div id="outline-container-org90617b2" class="outline-2">
<h2 id="orgb271fc0"><span class="section-number-2">1</span> HDF5 back end</h2> <h2 id="org90617b2"><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-org41f053f" class="outline-3"> <div id="outline-container-org5dac1d1" class="outline-3">
<h3 id="org41f053f"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3> <h3 id="org5dac1d1"><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-org03a86f5" class="outline-3"> <div id="outline-container-org1b81500" class="outline-3">
<h3 id="org03a86f5"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3> <h3 id="org1b81500"><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-org8d0218a" class="outline-3"> <div id="outline-container-org8081aa9" class="outline-3">
<h3 id="org8d0218a"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3> <h3 id="org8081aa9"><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-org9552dd2" class="outline-3"> <div id="outline-container-org7dfd443" class="outline-3">
<h3 id="org9552dd2"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3> <h3 id="org7dfd443"><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-org4ef22e1" class="outline-3"> <div id="outline-container-org7a9fdc0" class="outline-3">
<h3 id="org4ef22e1"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3> <h3 id="org7a9fdc0"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3>
<div class="outline-text-3" id="text-1-5"> <div class="outline-text-3" id="text-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -699,7 +699,7 @@ for the JavaScript code in this tag.
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-05-04 Tue 18:30</p> <p class="date">Created: 2021-05-05 Wed 09:38</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-04 Tue 18:30 --> <!-- 2021-05-05 Wed 09:38 -->
<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="#org52ded83">1. TEXT back end</a> <li><a href="#org3fd5ce3">1. TEXT back end</a>
<ul> <ul>
<li><a href="#org4c1cbbe">1.1. Template for group-related structures in text back end</a></li> <li><a href="#org363a57e">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org3926d6c">1.2. Template for general structure in text back end</a></li> <li><a href="#org0deec7e">1.2. Template for general structure in text back end</a></li>
<li><a href="#org0c69e93">1.3. Initialize function (constant part)</a></li> <li><a href="#org2fa4283">1.3. Initialize function (constant part)</a></li>
<li><a href="#orgba7f5a7">1.4. Deinitialize function (templated part)</a></li> <li><a href="#org1b846a1">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org1ea3180">1.5. Template for text read struct</a></li> <li><a href="#org433f4e2">1.5. Template for text read struct</a></li>
<li><a href="#org054fecf">1.6. Template for text flush struct</a></li> <li><a href="#orgccdfe23">1.6. Template for text flush struct</a></li>
<li><a href="#org46cea47">1.7. Template for text free memory</a></li> <li><a href="#org96f7ca7">1.7. Template for text free memory</a></li>
<li><a href="#orgaeb4038">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li> <li><a href="#org374af0c">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org8bb8d84">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li> <li><a href="#orga52bc26">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#orgef592a1">1.10. RDM struct (hard-coded)</a> <li><a href="#orgf18a518">1.10. RDM struct (hard-coded)</a>
<ul> <ul>
<li><a href="#orgb42c9a1">1.10.1. Read the complete struct</a></li> <li><a href="#orgff7bb92">1.10.1. Read the complete struct</a></li>
<li><a href="#orgda0b8fa">1.10.2. Flush the complete struct</a></li> <li><a href="#org2ab2591">1.10.2. Flush the complete struct</a></li>
<li><a href="#org68a2dcc">1.10.3. Free memory</a></li> <li><a href="#orgc62a2fd">1.10.3. Free memory</a></li>
<li><a href="#org6cbb682">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li> <li><a href="#org89e33d0">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org5657904">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li> <li><a href="#org9e3a648">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-org52ded83" class="outline-2"> <div id="outline-container-org3fd5ce3" class="outline-2">
<h2 id="org52ded83"><span class="section-number-2">1</span> TEXT back end</h2> <h2 id="org3fd5ce3"><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-org4c1cbbe" class="outline-3"> <div id="outline-container-org363a57e" class="outline-3">
<h3 id="org4c1cbbe"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3> <h3 id="org363a57e"><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-org3926d6c" class="outline-3"> <div id="outline-container-org0deec7e" class="outline-3">
<h3 id="org3926d6c"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3> <h3 id="org0deec7e"><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-org0c69e93" class="outline-3"> <div id="outline-container-org2fa4283" class="outline-3">
<h3 id="org0c69e93"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3> <h3 id="org2fa4283"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -511,8 +511,8 @@ The file is written when closed, or when the flush function is called.
</div> </div>
</div> </div>
<div id="outline-container-orgba7f5a7" class="outline-3"> <div id="outline-container-org1b846a1" class="outline-3">
<h3 id="orgba7f5a7"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3> <h3 id="org1b846a1"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -536,8 +536,8 @@ The file is written when closed, or when the flush function is called.
</div> </div>
</div> </div>
<div id="outline-container-org1ea3180" class="outline-3"> <div id="outline-container-org433f4e2" class="outline-3">
<h3 id="org1ea3180"><span class="section-number-3">1.5</span> Template for text read struct</h3> <h3 id="org433f4e2"><span class="section-number-3">1.5</span> Template for text read struct</h3>
<div class="outline-text-3" id="text-1-5"> <div class="outline-text-3" id="text-1-5">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">$group$_t* <pre class="src src-c">$group$_t*
@ -734,8 +734,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div> </div>
</div> </div>
<div id="outline-container-org054fecf" class="outline-3"> <div id="outline-container-orgccdfe23" class="outline-3">
<h3 id="org054fecf"><span class="section-number-3">1.6</span> Template for text flush struct</h3> <h3 id="orgccdfe23"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
<div class="outline-text-3" id="text-1-6"> <div class="outline-text-3" id="text-1-6">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -793,8 +793,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div> </div>
</div> </div>
<div id="outline-container-org46cea47" class="outline-3"> <div id="outline-container-org96f7ca7" class="outline-3">
<h3 id="org46cea47"><span class="section-number-3">1.7</span> Template for text free memory</h3> <h3 id="org96f7ca7"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div class="outline-text-3" id="text-1-7"> <div class="outline-text-3" id="text-1-7">
<p> <p>
Memory is allocated when reading. The following function frees memory. Memory is allocated when reading. The following function frees memory.
@ -835,8 +835,8 @@ Memory is allocated when reading. The following function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-orgaeb4038" class="outline-3"> <div id="outline-container-org374af0c" class="outline-3">
<h3 id="orgaeb4038"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3> <h3 id="org374af0c"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3>
<div class="outline-text-3" id="text-1-8"> <div class="outline-text-3" id="text-1-8">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -898,8 +898,8 @@ Memory is allocated when reading. The following function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-org8bb8d84" class="outline-3"> <div id="outline-container-orga52bc26" class="outline-3">
<h3 id="org8bb8d84"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3> <h3 id="orga52bc26"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3>
<div class="outline-text-3" id="text-1-9"> <div class="outline-text-3" id="text-1-9">
<p> <p>
The <code>group_dset</code> array is assumed allocated with the appropriate size. The <code>group_dset</code> array is assumed allocated with the appropriate size.
@ -996,12 +996,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
<div id="outline-container-orgef592a1" class="outline-3"> <div id="outline-container-orgf18a518" class="outline-3">
<h3 id="orgef592a1"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3> <h3 id="orgf18a518"><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-orgb42c9a1" class="outline-4"> <div id="outline-container-orgff7bb92" class="outline-4">
<h4 id="orgb42c9a1"><span class="section-number-4">1.10.1</span> Read the complete struct</h4> <h4 id="orgff7bb92"><span class="section-number-4">1.10.1</span> Read the complete struct</h4>
<div class="outline-text-4" id="text-1-10-1"> <div class="outline-text-4" id="text-1-10-1">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">rdm_t</span>* <span style="color: #0000ff;">trexio_text_read_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>); <pre class="src src-c"><span style="color: #228b22;">rdm_t</span>* <span style="color: #0000ff;">trexio_text_read_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>);
@ -1109,8 +1109,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
<div id="outline-container-orgda0b8fa" class="outline-4"> <div id="outline-container-org2ab2591" class="outline-4">
<h4 id="orgda0b8fa"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4> <h4 id="org2ab2591"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4>
<div class="outline-text-4" id="text-1-10-2"> <div class="outline-text-4" id="text-1-10-2">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_text_flush_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>); <pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_text_flush_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>);
@ -1153,8 +1153,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div> </div>
</div> </div>
<div id="outline-container-org68a2dcc" class="outline-4"> <div id="outline-container-orgc62a2fd" class="outline-4">
<h4 id="org68a2dcc"><span class="section-number-4">1.10.3</span> Free memory</h4> <h4 id="orgc62a2fd"><span class="section-number-4">1.10.3</span> Free memory</h4>
<div class="outline-text-4" id="text-1-10-3"> <div class="outline-text-4" id="text-1-10-3">
<p> <p>
Memory is allocated when reading. The followig function frees memory. Memory is allocated when reading. The followig function frees memory.
@ -1199,8 +1199,8 @@ Memory is allocated when reading. The followig function frees memory.
</div> </div>
</div> </div>
<div id="outline-container-org6cbb682" class="outline-4"> <div id="outline-container-org89e33d0" class="outline-4">
<h4 id="org6cbb682"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4> <h4 id="org89e33d0"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4>
<div class="outline-text-4" id="text-1-10-4"> <div class="outline-text-4" id="text-1-10-4">
<p> <p>
The <code>one_e</code> array is assumed allocated with the appropriate size. The <code>one_e</code> array is assumed allocated with the appropriate size.
@ -1266,8 +1266,8 @@ The <code>one_e</code> array is assumed allocated with the appropriate size.
</div> </div>
</div> </div>
<div id="outline-container-org5657904" class="outline-4"> <div id="outline-container-org9e3a648" class="outline-4">
<h4 id="org5657904"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4> <h4 id="org9e3a648"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4>
<div class="outline-text-4" id="text-1-10-5"> <div class="outline-text-4" id="text-1-10-5">
<p> <p>
<code>two_e</code> is a sparse data structure, which can be too large to fit <code>two_e</code> is a sparse data structure, which can be too large to fit
@ -1375,7 +1375,7 @@ file for each sparse float structure.
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p> <p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-05-04 Tue 18:30</p> <p class="date">Created: 2021-05-05 Wed 09:38</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>