TREX/trexio
1
0
Fork 0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-12-25 13:53:55 +01:00
Code Issues Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
scemama 2021-05-28 09:44:35 +00:00
parent 9d63bf0b4a
commit d21797e13e
5 changed files with 134 additions and 134 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">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-05-26 Wed 17:12 -->
<!-- 2021-05-28 Fri 09:44 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TREXIO source code documentation</title>
@ -341,7 +341,7 @@ and bug reports should be submitted at
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-05-26 Wed 17:12</p>
<p class="date">Created: 2021-05-28 Fri 09:44</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

4
index.html
View File

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

120
templator_front.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-05-26 Wed 17:12 -->
<!-- 2021-05-28 Fri 09:44 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Front end API</title>
@ -311,46 +311,46 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org8a2c28e">1. Coding conventions</a>
<li><a href="#org3ab3f57">1. Coding conventions</a>
<ul>
<li><a href="#org37fca10">1.1. Memory allocation</a></li>
<li><a href="#org0da8cfb">1.1. Memory allocation</a></li>
</ul>
</li>
<li><a href="#org342f653">2. Front end</a>
<li><a href="#orgfa170af">2. Front end</a>
<ul>
<li><a href="#org86b9726">2.1. Error handling</a></li>
<li><a href="#org6b58c83">2.2. Back ends</a></li>
<li><a href="#orgb9835fe">2.3. Read/write behavior</a></li>
<li><a href="#org92e8610">2.4. TREXIO file type</a></li>
<li><a href="#orgcf84634">2.5. Polymorphism of the file handle</a></li>
<li><a href="#org508a851">2.6. File opening</a></li>
<li><a href="#orgda2849f">2.7. File closing</a></li>
<li><a href="#org79e8197">2.8. C helper functions</a></li>
<li><a href="#orgd8ffdea">2.1. Error handling</a></li>
<li><a href="#org9d3c49c">2.2. Back ends</a></li>
<li><a href="#orgc64c5db">2.3. Read/write behavior</a></li>
<li><a href="#org56c6876">2.4. TREXIO file type</a></li>
<li><a href="#org94dff8e">2.5. Polymorphism of the file handle</a></li>
<li><a href="#orgdac81c2">2.6. File opening</a></li>
<li><a href="#org0ceba4a">2.7. File closing</a></li>
<li><a href="#orgfd7287a">2.8. C helper functions</a></li>
</ul>
</li>
<li><a href="#org44efb7b">3. Templates for front end</a>
<li><a href="#org99ef8e3">3. Templates for front end</a>
<ul>
<li><a href="#orgb07b302">3.1. Templates for front end has/read/write a dimension</a>
<li><a href="#org041e3f2">3.1. Templates for front end has/read/write a dimension</a>
<ul>
<li><a href="#org13c9072">3.1.1. C templates for front end</a></li>
<li><a href="#org8fb7625">3.1.2. Fortran templates for front end</a></li>
<li><a href="#org34b6f59">3.1.1. C templates for front end</a></li>
<li><a href="#org5011030">3.1.2. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#org6e25739">3.2. Templates for front end has/read/write a dataset</a>
<li><a href="#orgca083a9">3.2. Templates for front end has/read/write a dataset</a>
<ul>
<li><a href="#org56fe54e">3.2.1. C templates for front end</a></li>
<li><a href="#orgb9009d8">3.2.2. Fortran templates for front end</a></li>
<li><a href="#org98e0a8c">3.2.1. C templates for front end</a></li>
<li><a href="#orgc23dd98">3.2.2. Fortran templates for front end</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#orga6032e2">4. Fortran helper/wrapper functions</a></li>
<li><a href="#orgf667736">4. Fortran helper/wrapper functions</a></li>
</ul>
</div>
</div>
<div id="outline-container-org8a2c28e" class="outline-2">
<h2 id="org8a2c28e"><span class="section-number-2">1</span> Coding conventions</h2>
<div id="outline-container-org3ab3f57" class="outline-2">
<h2 id="org3ab3f57"><span class="section-number-2">1</span> Coding conventions</h2>
<div class="outline-text-2" id="text-1">
<ul class="org-ul">
<li>integer types will be defined using types given in <code>stdint.h</code></li>
@ -365,8 +365,8 @@ for the JavaScript code in this tag.
</ul>
</div>
<div id="outline-container-org37fca10" class="outline-3">
<h3 id="org37fca10"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div id="outline-container-org0da8cfb" class="outline-3">
<h3 id="org0da8cfb"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div class="outline-text-3" id="text-1-1">
<p>
Memory allocation of structures can be facilitated by using the
@ -401,8 +401,8 @@ The maximum string size for the filenames is 4096 characters.
</div>
</div>
<div id="outline-container-org342f653" class="outline-2">
<h2 id="org342f653"><span class="section-number-2">2</span> Front end</h2>
<div id="outline-container-orgfa170af" class="outline-2">
<h2 id="orgfa170af"><span class="section-number-2">2</span> Front end</h2>
<div class="outline-text-2" id="text-2">
<p>
All calls to TREXIO are thread-safe.
@ -410,10 +410,10 @@ TREXIO front end is modular, which simplifies implementation of new back ends.
</p>
</div>
<div id="outline-container-org86b9726" class="outline-3">
<h3 id="org86b9726"><span class="section-number-3">2.1</span> Error handling</h3>
<div id="outline-container-orgd8ffdea" class="outline-3">
<h3 id="orgd8ffdea"><span class="section-number-3">2.1</span> Error handling</h3>
<div class="outline-text-3" id="text-2-1">
<table id="org2b4df6d" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orgec8de22" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -695,8 +695,8 @@ The text strings are extracted from the previous table.
</div>
</div>
<div id="outline-container-org6b58c83" class="outline-3">
<h3 id="org6b58c83"><span class="section-number-3">2.2</span> Back ends</h3>
<div id="outline-container-org9d3c49c" class="outline-3">
<h3 id="org9d3c49c"><span class="section-number-3">2.2</span> Back ends</h3>
<div class="outline-text-3" id="text-2-2">
<p>
TREXIO has several back ends:
@ -726,8 +726,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
</div>
</div>
</div>
<div id="outline-container-orgb9835fe" class="outline-3">
<h3 id="orgb9835fe"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div id="outline-container-orgc64c5db" class="outline-3">
<h3 id="orgc64c5db"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div class="outline-text-3" id="text-2-3">
<p>
Every time a reading function is called, the data is read from the
@ -755,8 +755,8 @@ concurrent programs, the behavior is not specified.
</p>
</div>
</div>
<div id="outline-container-org92e8610" class="outline-3">
<h3 id="org92e8610"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div id="outline-container-org56c6876" class="outline-3">
<h3 id="org56c6876"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div class="outline-text-3" id="text-2-4">
<p>
<code>trexio_s</code> is the the main type for TREXIO files, visible to the users
@ -788,8 +788,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
</div>
</div>
</div>
<div id="outline-container-orgcf84634" class="outline-3">
<h3 id="orgcf84634"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div id="outline-container-org94dff8e" class="outline-3">
<h3 id="org94dff8e"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div class="outline-text-3" id="text-2-5">
<p>
Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the
@ -808,8 +808,8 @@ corresponding types for all back ends can be safely casted to
</div>
</div>
<div id="outline-container-org508a851" class="outline-3">
<h3 id="org508a851"><span class="section-number-3">2.6</span> File opening</h3>
<div id="outline-container-orgdac81c2" class="outline-3">
<h3 id="orgdac81c2"><span class="section-number-3">2.6</span> File opening</h3>
<div class="outline-text-3" id="text-2-6">
<p>
<code>trexio_open</code> creates a new TREXIO file or opens existing one.
@ -973,8 +973,8 @@ should tend to avoid renaming the <code>.txt</code> data files.
</div>
</div>
<div id="outline-container-orgda2849f" class="outline-3">
<h3 id="orgda2849f"><span class="section-number-3">2.7</span> File closing</h3>
<div id="outline-container-org0ceba4a" class="outline-3">
<h3 id="org0ceba4a"><span class="section-number-3">2.7</span> File closing</h3>
<div class="outline-text-3" id="text-2-7">
<p>
<code>trexio_close</code> closes an existing <code>trexio_t</code> file.
@ -1072,8 +1072,8 @@ output:
</div>
</div>
<div id="outline-container-org79e8197" class="outline-3">
<h3 id="org79e8197"><span class="section-number-3">2.8</span> C helper functions</h3>
<div id="outline-container-orgfd7287a" class="outline-3">
<h3 id="orgfd7287a"><span class="section-number-3">2.8</span> C helper functions</h3>
<div class="outline-text-3" id="text-2-8">
<p>
#+begin<sub>src</sub> c :tangle prefix<sub>front.c</sub>
@ -1111,8 +1111,8 @@ for (int i=0; i&lt;str<sub>max</sub><sub>num</sub>; i++){
</div>
</div>
<div id="outline-container-org44efb7b" class="outline-2">
<h2 id="org44efb7b"><span class="section-number-2">3</span> Templates for front end</h2>
<div id="outline-container-org99ef8e3" class="outline-2">
<h2 id="org99ef8e3"><span class="section-number-2">3</span> Templates for front end</h2>
<div class="outline-text-2" id="text-3">
<p>
Consider the following block of <code>trex.json</code>:
@ -1302,8 +1302,8 @@ or double precision for integer and floating point numbers.
</p>
</div>
<div id="outline-container-orgb07b302" class="outline-3">
<h3 id="orgb07b302"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3>
<div id="outline-container-org041e3f2" class="outline-3">
<h3 id="org041e3f2"><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">
<p>
This section concerns API calls related to dimensioning variables.
@ -1372,8 +1372,8 @@ This section concerns API calls related to dimensioning variables.
</table>
</div>
<div id="outline-container-org13c9072" class="outline-4">
<h4 id="org13c9072"><span class="section-number-4">3.1.1</span> C templates for front end</h4>
<div id="outline-container-org34b6f59" class="outline-4">
<h4 id="org34b6f59"><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">
<p>
The <code>C</code> templates that correspond to each of the abovementioned
@ -1566,8 +1566,8 @@ precision (see Table above).
</div>
</div>
<div id="outline-container-org8fb7625" class="outline-4">
<h4 id="org8fb7625"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4>
<div id="outline-container-org5011030" class="outline-4">
<h4 id="org5011030"><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">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
@ -1653,8 +1653,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-org6e25739" class="outline-3">
<h3 id="org6e25739"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3>
<div id="outline-container-orgca083a9" class="outline-3">
<h3 id="orgca083a9"><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">
<p>
This section concerns API calls related to datasets.
@ -1723,8 +1723,8 @@ This section concerns API calls related to datasets.
</table>
</div>
<div id="outline-container-org56fe54e" class="outline-4">
<h4 id="org56fe54e"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
<div id="outline-container-org98e0a8c" class="outline-4">
<h4 id="org98e0a8c"><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">
<p>
The C templates that correspond to each of the abovementioned functions can be found below.
@ -1988,8 +1988,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
</div>
</div>
<div id="outline-container-orgb9009d8" class="outline-4">
<h4 id="orgb9009d8"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
<div id="outline-container-orgc23dd98" class="outline-4">
<h4 id="orgc23dd98"><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">
<p>
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
@ -2076,8 +2076,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-orga6032e2" class="outline-2">
<h2 id="orga6032e2"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div id="outline-container-orgf667736" class="outline-2">
<h2 id="orgf667736"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div class="outline-text-2" id="text-4">
<p>
The function below adapts the original C-based <code>trexio_open</code> for Fortran.
@ -2106,7 +2106,7 @@ Note, that Fortran interface calls the main <code>TREXIO</code> API, which is wr
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-05-26 Wed 17:12</p>
<p class="date">Created: 2021-05-28 Fri 09:44</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

40
templator_hdf5.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-05-26 Wed 17:12 -->
<!-- 2021-05-28 Fri 09:44 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>HDF5 back end</title>
@ -311,25 +311,25 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgdc4d015">1. HDF5 back end</a>
<li><a href="#org37e3705">1. HDF5 back end</a>
<ul>
<li><a href="#org9452876">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org81f4b6d">1.2. Template for HDF5 structures</a></li>
<li><a href="#org26a5b56">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org74e8eee">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#orgac32969">1.5. Template for HDF5 has/read/write a dataset</a></li>
<li><a href="#orgcbe3dbb">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org0a4591d">1.2. Template for HDF5 structures</a></li>
<li><a href="#org78a8ba3">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#orgd149b37">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org765f5c3">1.5. Template for HDF5 has/read/write a dataset</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-orgdc4d015" class="outline-2">
<h2 id="orgdc4d015"><span class="section-number-2">1</span> HDF5 back end</h2>
<div id="outline-container-org37e3705" class="outline-2">
<h2 id="org37e3705"><span class="section-number-2">1</span> HDF5 back end</h2>
<div class="outline-text-2" id="text-1">
</div>
<div id="outline-container-org9452876" class="outline-3">
<h3 id="org9452876"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div id="outline-container-orgcbe3dbb" class="outline-3">
<h3 id="orgcbe3dbb"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div class="outline-text-3" id="text-1-1">
<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>
@ -340,8 +340,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org81f4b6d" class="outline-3">
<h3 id="org81f4b6d"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div id="outline-container-org0a4591d" class="outline-3">
<h3 id="org0a4591d"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div class="outline-text-3" id="text-1-2">
<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> {
@ -356,8 +356,8 @@ for the JavaScript code in this tag.
</div>
<div id="outline-container-org26a5b56" class="outline-3">
<h3 id="org26a5b56"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
<div id="outline-container-org78a8ba3" class="outline-3">
<h3 id="org78a8ba3"><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="org-src-container">
<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 id="outline-container-org74e8eee" class="outline-3">
<h3 id="org74e8eee"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3>
<div id="outline-container-orgd149b37" class="outline-3">
<h3 id="orgd149b37"><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="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -563,8 +563,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-orgac32969" class="outline-3">
<h3 id="orgac32969"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3>
<div id="outline-container-org765f5c3" class="outline-3">
<h3 id="org765f5c3"><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="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -698,7 +698,7 @@ for the JavaScript code in this tag.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-05-26 Wed 17:12</p>
<p class="date">Created: 2021-05-28 Fri 09:44</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

100
templator_text.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2021-05-26 Wed 17:12 -->
<!-- 2021-05-28 Fri 09:44 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TEXT back end</title>
@ -311,24 +311,24 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org0039b92">1. TEXT back end</a>
<li><a href="#orgf44ce42">1. TEXT back end</a>
<ul>
<li><a href="#org94d2cbd">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#orgb535277">1.2. Template for general structure in text back end</a></li>
<li><a href="#org3bd4317">1.3. Initialize function (constant part)</a></li>
<li><a href="#orga4a0240">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org4352d21">1.5. Template for text read struct</a></li>
<li><a href="#org0e60e24">1.6. Template for text flush struct</a></li>
<li><a href="#org4c5c754">1.7. Template for text free memory</a></li>
<li><a href="#org434846f">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org4d5c063">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#org31d4dc3">1.10. RDM struct (hard-coded)</a>
<li><a href="#orgb746635">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org5228542">1.2. Template for general structure in text back end</a></li>
<li><a href="#orgbc4b2cf">1.3. Initialize function (constant part)</a></li>
<li><a href="#org1293c97">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org2c192de">1.5. Template for text read struct</a></li>
<li><a href="#orge00db06">1.6. Template for text flush struct</a></li>
<li><a href="#org06545b7">1.7. Template for text free memory</a></li>
<li><a href="#org02f8d88">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org4dccfb4">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#org67b2e37">1.10. RDM struct (hard-coded)</a>
<ul>
<li><a href="#orgfebac61">1.10.1. Read the complete struct</a></li>
<li><a href="#orgb8d1e0d">1.10.2. Flush the complete struct</a></li>
<li><a href="#org45ac446">1.10.3. Free memory</a></li>
<li><a href="#orgabfff13">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org5cf5e93">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li>
<li><a href="#org7c77e6f">1.10.1. Read the complete struct</a></li>
<li><a href="#org49fb2cc">1.10.2. Flush the complete struct</a></li>
<li><a href="#org9d77d6f">1.10.3. Free memory</a></li>
<li><a href="#orgbbcfdcf">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#orga272123">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li>
</ul>
</li>
</ul>
@ -337,8 +337,8 @@ for the JavaScript code in this tag.
</div>
</div>
<div id="outline-container-org0039b92" class="outline-2">
<h2 id="org0039b92"><span class="section-number-2">1</span> TEXT back end</h2>
<div id="outline-container-orgf44ce42" class="outline-2">
<h2 id="orgf44ce42"><span class="section-number-2">1</span> TEXT back end</h2>
<div class="outline-text-2" id="text-1">
<p>
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>
</div>
<div id="outline-container-org94d2cbd" class="outline-3">
<h3 id="org94d2cbd"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
<div id="outline-container-orgb746635" class="outline-3">
<h3 id="orgb746635"><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="org-src-container">
<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 id="outline-container-orgb535277" class="outline-3">
<h3 id="orgb535277"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
<div id="outline-container-org5228542" class="outline-3">
<h3 id="org5228542"><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="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> {
@ -403,8 +403,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org3bd4317" class="outline-3">
<h3 id="org3bd4317"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div id="outline-container-orgbc4b2cf" class="outline-3">
<h3 id="orgbc4b2cf"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div class="outline-text-3" id="text-1-3">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -505,8 +505,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-orga4a0240" class="outline-3">
<h3 id="orga4a0240"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div id="outline-container-org1293c97" class="outline-3">
<h3 id="org1293c97"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div class="outline-text-3" id="text-1-4">
<div class="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -531,8 +531,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org4352d21" class="outline-3">
<h3 id="org4352d21"><span class="section-number-3">1.5</span> Template for text read struct</h3>
<div id="outline-container-org2c192de" class="outline-3">
<h3 id="org2c192de"><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="org-src-container">
<pre class="src src-c">$group$_t*
@ -698,8 +698,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-org0e60e24" class="outline-3">
<h3 id="org0e60e24"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
<div id="outline-container-orge00db06" class="outline-3">
<h3 id="orge00db06"><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="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -758,8 +758,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-org4c5c754" class="outline-3">
<h3 id="org4c5c754"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div id="outline-container-org06545b7" class="outline-3">
<h3 id="org06545b7"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div class="outline-text-3" id="text-1-7">
<p>
Memory is allocated when reading. The following function frees memory.
@ -795,8 +795,8 @@ Memory is allocated when reading. The following function frees memory.
</div>
</div>
<div id="outline-container-org434846f" class="outline-3">
<h3 id="org434846f"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3>
<div id="outline-container-org02f8d88" class="outline-3">
<h3 id="org02f8d88"><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="org-src-container">
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
@ -858,8 +858,8 @@ Memory is allocated when reading. The following function frees memory.
</div>
</div>
<div id="outline-container-org4d5c063" class="outline-3">
<h3 id="org4d5c063"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3>
<div id="outline-container-org4dccfb4" class="outline-3">
<h3 id="org4dccfb4"><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">
<p>
The <code>group_dset</code> array is assumed allocated with the appropriate size.
@ -956,12 +956,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-org31d4dc3" class="outline-3">
<h3 id="org31d4dc3"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3>
<div id="outline-container-org67b2e37" class="outline-3">
<h3 id="org67b2e37"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3>
<div class="outline-text-3" id="text-1-10">
</div>
<div id="outline-container-orgfebac61" class="outline-4">
<h4 id="orgfebac61"><span class="section-number-4">1.10.1</span> Read the complete struct</h4>
<div id="outline-container-org7c77e6f" class="outline-4">
<h4 id="org7c77e6f"><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="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>);
@ -1056,8 +1056,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-orgb8d1e0d" class="outline-4">
<h4 id="orgb8d1e0d"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4>
<div id="outline-container-org49fb2cc" class="outline-4">
<h4 id="org49fb2cc"><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="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>);
@ -1099,8 +1099,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-org45ac446" class="outline-4">
<h4 id="org45ac446"><span class="section-number-4">1.10.3</span> Free memory</h4>
<div id="outline-container-org9d77d6f" class="outline-4">
<h4 id="org9d77d6f"><span class="section-number-4">1.10.3</span> Free memory</h4>
<div class="outline-text-4" id="text-1-10-3">
<p>
Memory is allocated when reading. The followig function frees memory.
@ -1136,8 +1136,8 @@ Memory is allocated when reading. The followig function frees memory.
</div>
</div>
<div id="outline-container-orgabfff13" class="outline-4">
<h4 id="orgabfff13"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4>
<div id="outline-container-orgbbcfdcf" class="outline-4">
<h4 id="orgbbcfdcf"><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">
<p>
The <code>one_e</code> array is assumed allocated with the appropriate size.
@ -1203,8 +1203,8 @@ The <code>one_e</code> array is assumed allocated with the appropriate size.
</div>
</div>
<div id="outline-container-org5cf5e93" class="outline-4">
<h4 id="org5cf5e93"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4>
<div id="outline-container-orga272123" class="outline-4">
<h4 id="orga272123"><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">
<p>
<code>two_e</code> is a sparse data structure, which can be too large to fit
@ -1312,7 +1312,7 @@ file for each sparse float structure.
</div>
<div id="postamble" class="status">
<p class="author">Author: TREX-CoE</p>
<p class="date">Created: 2021-05-26 Wed 17:12</p>
<p class="date">Created: 2021-05-28 Fri 09:44</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>