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@87bb6fcb6e 🚀

Browse Source
This commit is contained in:
scemama 2021-05-06 17:57:56 +00:00
parent d0c04f3919
commit 6c616977f7
5 changed files with 135 additions and 135 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-06 Thu 17:41 -->
<!-- 2021-05-06 Thu 17:57 -->
<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-06 Thu 17:41</p>
<p class="date">Created: 2021-05-06 Thu 17:57</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-06 Thu 17:41 -->
<!-- 2021-05-06 Thu 17:57 -->
<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-06 Thu 17:41</p>
<p class="date">Created: 2021-05-06 Thu 17:57</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>

122
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-06 Thu 17:41 -->
<!-- 2021-05-06 Thu 17:57 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>&lrm;</title>
@ -310,39 +310,39 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org4a88dff">1. Coding conventions</a>
<li><a href="#org0d90fca">1. Coding conventions</a>
<ul>
<li><a href="#orgabed1be">1.1. Memory allocation</a></li>
<li><a href="#org8a9328a">1.1. Memory allocation</a></li>
</ul>
</li>
<li><a href="#org6648938">2. Front end</a>
<li><a href="#orge8f4017">2. Front end</a>
<ul>
<li><a href="#orgf87104a">2.1. Error handling</a></li>
<li><a href="#orgf17e3b5">2.2. Back ends</a></li>
<li><a href="#orgb3d94df">2.3. Read/write behavior</a></li>
<li><a href="#orgb228279">2.4. TREXIO file type</a></li>
<li><a href="#orgaa0546c">2.5. Polymorphism of the file handle</a></li>
<li><a href="#orga001112">2.6. File opening</a></li>
<li><a href="#org01b5c32">2.7. File closing</a></li>
<li><a href="#org0e27a2c">2.1. Error handling</a></li>
<li><a href="#orgfce1641">2.2. Back ends</a></li>
<li><a href="#org188ffcc">2.3. Read/write behavior</a></li>
<li><a href="#org6aca689">2.4. TREXIO file type</a></li>
<li><a href="#org78e8f11">2.5. Polymorphism of the file handle</a></li>
<li><a href="#orgfa1538e">2.6. File opening</a></li>
<li><a href="#orga7e8ded">2.7. File closing</a></li>
</ul>
</li>
<li><a href="#orgf9e2fe3">3. Templates for front end</a>
<li><a href="#orgfe75aed">3. Templates for front end</a>
<ul>
<li><a href="#org7271aba">3.1. Templates for front end has/read/write a dimension</a>
<li><a href="#org8646f98">3.1. Templates for front end has/read/write a dimension</a>
<ul>
<li><a href="#orgcd5b4e4">3.1.1. C templates for front end</a></li>
<li><a href="#org641fc0d">3.1.2. Fortran templates for front end</a></li>
<li><a href="#org539cf33">3.1.1. C templates for front end</a></li>
<li><a href="#org848405a">3.1.2. Fortran templates for front end</a></li>
</ul>
</li>
<li><a href="#org955c4d8">3.2. Templates for front end has/read/write a dataset</a>
<li><a href="#orgc4b9aba">3.2. Templates for front end has/read/write a dataset</a>
<ul>
<li><a href="#org3b5a4ce">3.2.1. C templates for front end</a></li>
<li><a href="#orgef0ec92">3.2.2. Fortran templates for front end</a></li>
<li><a href="#orgd184039">3.2.1. C templates for front end</a></li>
<li><a href="#org495555b">3.2.2. Fortran templates for front end</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#orgc9905c2">4. Fortran helper/wrapper functions</a></li>
<li><a href="#org7640efc">4. Fortran helper/wrapper functions</a></li>
</ul>
</div>
</div>
@ -350,8 +350,8 @@ for the JavaScript code in this tag.
d+TITLE: Front end API
</p>
<div id="outline-container-org4a88dff" class="outline-2">
<h2 id="org4a88dff"><span class="section-number-2">1</span> Coding conventions</h2>
<div id="outline-container-org0d90fca" class="outline-2">
<h2 id="org0d90fca"><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>
@ -366,8 +366,8 @@ d+TITLE: Front end API
</ul>
</div>
<div id="outline-container-orgabed1be" class="outline-3">
<h3 id="orgabed1be"><span class="section-number-3">1.1</span> Memory allocation</h3>
<div id="outline-container-org8a9328a" class="outline-3">
<h3 id="org8a9328a"><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>
<div id="outline-container-org6648938" class="outline-2">
<h2 id="org6648938"><span class="section-number-2">2</span> Front end</h2>
<div id="outline-container-orge8f4017" class="outline-2">
<h2 id="orge8f4017"><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-orgf87104a" class="outline-3">
<h3 id="orgf87104a"><span class="section-number-3">2.1</span> Error handling</h3>
<div id="outline-container-org0e27a2c" class="outline-3">
<h3 id="org0e27a2c"><span class="section-number-3">2.1</span> Error handling</h3>
<div class="outline-text-3" id="text-2-1">
<table id="orga0099d6" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<table id="orgb8652d8" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
@ -512,13 +512,13 @@ TREXIO front end is modular, which simplifies implementation of new back ends.
<tr>
<td class="org-left"><code>TREXIO_INVALID_NUM</code></td>
<td class="org-right">12</td>
<td class="org-left">'Invalid exit code'</td>
<td class="org-left">'Invalid dimensions'</td>
</tr>
<tr>
<td class="org-left"><code>TREXIO_NUM_ALREADY_EXISTS</code></td>
<td class="org-right">13</td>
<td class="org-left">'This variable already exists'</td>
<td class="org-left">'Variable already exists'</td>
</tr>
<tr>
@ -640,10 +640,10 @@ The text strings are extracted from the previous table.
<span style="color: #a020f0;">return</span> <span style="color: #8b2252;">"Element absent"</span>;
<span style="color: #a020f0;">break</span>;
<span style="color: #a020f0;">case</span> TREXIO_INVALID_NUM:
<span style="color: #a020f0;">return</span> <span style="color: #8b2252;">"Invalid exit code"</span>;
<span style="color: #a020f0;">return</span> <span style="color: #8b2252;">"Invalid dimensions"</span>;
<span style="color: #a020f0;">break</span>;
<span style="color: #a020f0;">case</span> TREXIO_NUM_ALREADY_EXISTS:
<span style="color: #a020f0;">return</span> <span style="color: #8b2252;">"This variable already exists"</span>;
<span style="color: #a020f0;">return</span> <span style="color: #8b2252;">"Variable already exists"</span>;
<span style="color: #a020f0;">break</span>;
<span style="color: #a020f0;">case</span> TREXIO_OPEN_ERROR:
<span style="color: #a020f0;">return</span> <span style="color: #8b2252;">"Error opening file"</span>;
@ -695,8 +695,8 @@ The text strings are extracted from the previous table.
</div>
</div>
<div id="outline-container-orgf17e3b5" class="outline-3">
<h3 id="orgf17e3b5"><span class="section-number-3">2.2</span> Back ends</h3>
<div id="outline-container-orgfce1641" class="outline-3">
<h3 id="orgfce1641"><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-orgb3d94df" class="outline-3">
<h3 id="orgb3d94df"><span class="section-number-3">2.3</span> Read/write behavior</h3>
<div id="outline-container-org188ffcc" class="outline-3">
<h3 id="org188ffcc"><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-orgb228279" class="outline-3">
<h3 id="orgb228279"><span class="section-number-3">2.4</span> TREXIO file type</h3>
<div id="outline-container-org6aca689" class="outline-3">
<h3 id="org6aca689"><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-orgaa0546c" class="outline-3">
<h3 id="orgaa0546c"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
<div id="outline-container-org78e8f11" class="outline-3">
<h3 id="org78e8f11"><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-orga001112" class="outline-3">
<h3 id="orga001112"><span class="section-number-3">2.6</span> File opening</h3>
<div id="outline-container-orgfa1538e" class="outline-3">
<h3 id="orgfa1538e"><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.
@ -971,8 +971,8 @@ should tend to avoid renaming the <code>.txt</code> data files.
</div>
</div>
<div id="outline-container-org01b5c32" class="outline-3">
<h3 id="org01b5c32"><span class="section-number-3">2.7</span> File closing</h3>
<div id="outline-container-orga7e8ded" class="outline-3">
<h3 id="orga7e8ded"><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.
@ -1071,8 +1071,8 @@ output:
</div>
</div>
<div id="outline-container-orgf9e2fe3" class="outline-2">
<h2 id="orgf9e2fe3"><span class="section-number-2">3</span> Templates for front end</h2>
<div id="outline-container-orgfe75aed" class="outline-2">
<h2 id="orgfe75aed"><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>:
@ -1233,8 +1233,8 @@ TREXIO supports I/O with single or double precision for integer and floating poi
</div>
<div id="outline-container-org7271aba" class="outline-3">
<h3 id="org7271aba"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3>
<div id="outline-container-org8646f98" class="outline-3">
<h3 id="org8646f98"><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.
@ -1303,8 +1303,8 @@ This section concerns API calls related to dimensioning variables.
</table>
</div>
<div id="outline-container-orgcd5b4e4" class="outline-4">
<h4 id="orgcd5b4e4"><span class="section-number-4">3.1.1</span> C templates for front end</h4>
<div id="outline-container-org539cf33" class="outline-4">
<h4 id="org539cf33"><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 functions can be found below.
@ -1493,8 +1493,8 @@ The basic (non-suffixed) API call on dimensioning variables deals with single pr
</div>
</div>
<div id="outline-container-org641fc0d" class="outline-4">
<h4 id="org641fc0d"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4>
<div id="outline-container-org848405a" class="outline-4">
<h4 id="org848405a"><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.
@ -1580,8 +1580,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-org955c4d8" class="outline-3">
<h3 id="org955c4d8"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3>
<div id="outline-container-orgc4b9aba" class="outline-3">
<h3 id="orgc4b9aba"><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.
@ -1650,8 +1650,8 @@ This section concerns API calls related to datasets.
</table>
</div>
<div id="outline-container-org3b5a4ce" class="outline-4">
<h4 id="org3b5a4ce"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
<div id="outline-container-orgd184039" class="outline-4">
<h4 id="orgd184039"><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.
@ -1909,8 +1909,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
</div>
</div>
<div id="outline-container-orgef0ec92" class="outline-4">
<h4 id="orgef0ec92"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
<div id="outline-container-org495555b" class="outline-4">
<h4 id="org495555b"><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>.
@ -1997,8 +1997,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
</div>
</div>
<div id="outline-container-orgc9905c2" class="outline-2">
<h2 id="orgc9905c2"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
<div id="outline-container-org7640efc" class="outline-2">
<h2 id="org7640efc"><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.
@ -2027,7 +2027,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-06 Thu 17:41</p>
<p class="date">Created: 2021-05-06 Thu 17:57</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-06 Thu 17:41 -->
<!-- 2021-05-06 Thu 17:57 -->
<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="#org43f9252">1. HDF5 back end</a>
<li><a href="#org58ef299">1. HDF5 back end</a>
<ul>
<li><a href="#orgc4a9c42">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org8096adc">1.2. Template for HDF5 structures</a></li>
<li><a href="#org46d0465">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org07bfe36">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org1e623e7">1.5. Template for HDF5 has/read/write a dataset</a></li>
<li><a href="#orge1dee5b">1.1. Template for HDF5 definitions</a></li>
<li><a href="#org674684e">1.2. Template for HDF5 structures</a></li>
<li><a href="#org005db21">1.3. Template for HDF5 init/deinit</a></li>
<li><a href="#org7450812">1.4. Template for HDF5 has/read/write a number</a></li>
<li><a href="#org213bd49">1.5. Template for HDF5 has/read/write a dataset</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-org43f9252" class="outline-2">
<h2 id="org43f9252"><span class="section-number-2">1</span> HDF5 back end</h2>
<div id="outline-container-org58ef299" class="outline-2">
<h2 id="org58ef299"><span class="section-number-2">1</span> HDF5 back end</h2>
<div class="outline-text-2" id="text-1">
</div>
<div id="outline-container-orgc4a9c42" class="outline-3">
<h3 id="orgc4a9c42"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
<div id="outline-container-orge1dee5b" class="outline-3">
<h3 id="orge1dee5b"><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-org8096adc" class="outline-3">
<h3 id="org8096adc"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
<div id="outline-container-org674684e" class="outline-3">
<h3 id="org674684e"><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-org46d0465" class="outline-3">
<h3 id="org46d0465"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
<div id="outline-container-org005db21" class="outline-3">
<h3 id="org005db21"><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-org07bfe36" class="outline-3">
<h3 id="org07bfe36"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3>
<div id="outline-container-org7450812" class="outline-3">
<h3 id="org7450812"><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-org1e623e7" class="outline-3">
<h3 id="org1e623e7"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3>
<div id="outline-container-org213bd49" class="outline-3">
<h3 id="org213bd49"><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-06 Thu 17:41</p>
<p class="date">Created: 2021-05-06 Thu 17:57</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-06 Thu 17:41 -->
<!-- 2021-05-06 Thu 17:57 -->
<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="#org9c21119">1. TEXT back end</a>
<li><a href="#orgc72aa79">1. TEXT back end</a>
<ul>
<li><a href="#org352572e">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org8d63d6a">1.2. Template for general structure in text back end</a></li>
<li><a href="#org935c427">1.3. Initialize function (constant part)</a></li>
<li><a href="#org6bf8241">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#org2a7e1be">1.5. Template for text read struct</a></li>
<li><a href="#org2ba6d7e">1.6. Template for text flush struct</a></li>
<li><a href="#orgd32905c">1.7. Template for text free memory</a></li>
<li><a href="#org95b2121">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org76a5763">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#org87c40fa">1.10. RDM struct (hard-coded)</a>
<li><a href="#org5966547">1.1. Template for group-related structures in text back end</a></li>
<li><a href="#org593dbdf">1.2. Template for general structure in text back end</a></li>
<li><a href="#orga295b88">1.3. Initialize function (constant part)</a></li>
<li><a href="#org857666c">1.4. Deinitialize function (templated part)</a></li>
<li><a href="#orgdcea87b">1.5. Template for text read struct</a></li>
<li><a href="#orgb8d7c17">1.6. Template for text flush struct</a></li>
<li><a href="#orgd378d85">1.7. Template for text free memory</a></li>
<li><a href="#orgd7de6b1">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
<li><a href="#org02da8e5">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
<li><a href="#orgb9f5cd8">1.10. RDM struct (hard-coded)</a>
<ul>
<li><a href="#orga859f9a">1.10.1. Read the complete struct</a></li>
<li><a href="#orgf6b99b1">1.10.2. Flush the complete struct</a></li>
<li><a href="#org23f30e9">1.10.3. Free memory</a></li>
<li><a href="#orgaee8746">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org5da0194">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li>
<li><a href="#org77ebc42">1.10.1. Read the complete struct</a></li>
<li><a href="#org1c4343a">1.10.2. Flush the complete struct</a></li>
<li><a href="#orge4d4880">1.10.3. Free memory</a></li>
<li><a href="#orgc80ae44">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
<li><a href="#org3b50d7b">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-org9c21119" class="outline-2">
<h2 id="org9c21119"><span class="section-number-2">1</span> TEXT back end</h2>
<div id="outline-container-orgc72aa79" class="outline-2">
<h2 id="orgc72aa79"><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-org352572e" class="outline-3">
<h3 id="org352572e"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
<div id="outline-container-org5966547" class="outline-3">
<h3 id="org5966547"><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-org8d63d6a" class="outline-3">
<h3 id="org8d63d6a"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
<div id="outline-container-org593dbdf" class="outline-3">
<h3 id="org593dbdf"><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-org935c427" class="outline-3">
<h3 id="org935c427"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
<div id="outline-container-orga295b88" class="outline-3">
<h3 id="orga295b88"><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>
@ -509,8 +509,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org6bf8241" class="outline-3">
<h3 id="org6bf8241"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
<div id="outline-container-org857666c" class="outline-3">
<h3 id="org857666c"><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>
@ -534,8 +534,8 @@ The file is written when closed, or when the flush function is called.
</div>
</div>
<div id="outline-container-org2a7e1be" class="outline-3">
<h3 id="org2a7e1be"><span class="section-number-3">1.5</span> Template for text read struct</h3>
<div id="outline-container-orgdcea87b" class="outline-3">
<h3 id="orgdcea87b"><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*
@ -706,8 +706,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-org2ba6d7e" class="outline-3">
<h3 id="org2ba6d7e"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
<div id="outline-container-orgb8d7c17" class="outline-3">
<h3 id="orgb8d7c17"><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>
@ -766,8 +766,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
</div>
</div>
<div id="outline-container-orgd32905c" class="outline-3">
<h3 id="orgd32905c"><span class="section-number-3">1.7</span> Template for text free memory</h3>
<div id="outline-container-orgd378d85" class="outline-3">
<h3 id="orgd378d85"><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.
@ -803,8 +803,8 @@ Memory is allocated when reading. The following function frees memory.
</div>
</div>
<div id="outline-container-org95b2121" class="outline-3">
<h3 id="org95b2121"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3>
<div id="outline-container-orgd7de6b1" class="outline-3">
<h3 id="orgd7de6b1"><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>
@ -866,8 +866,8 @@ Memory is allocated when reading. The following function frees memory.
</div>
</div>
<div id="outline-container-org76a5763" class="outline-3">
<h3 id="org76a5763"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3>
<div id="outline-container-org02da8e5" class="outline-3">
<h3 id="org02da8e5"><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.
@ -964,12 +964,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-org87c40fa" class="outline-3">
<h3 id="org87c40fa"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3>
<div id="outline-container-orgb9f5cd8" class="outline-3">
<h3 id="orgb9f5cd8"><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-orga859f9a" class="outline-4">
<h4 id="orga859f9a"><span class="section-number-4">1.10.1</span> Read the complete struct</h4>
<div id="outline-container-org77ebc42" class="outline-4">
<h4 id="org77ebc42"><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>);
@ -1064,8 +1064,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-orgf6b99b1" class="outline-4">
<h4 id="orgf6b99b1"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4>
<div id="outline-container-org1c4343a" class="outline-4">
<h4 id="org1c4343a"><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>);
@ -1108,8 +1108,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
</div>
</div>
<div id="outline-container-org23f30e9" class="outline-4">
<h4 id="org23f30e9"><span class="section-number-4">1.10.3</span> Free memory</h4>
<div id="outline-container-orge4d4880" class="outline-4">
<h4 id="orge4d4880"><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.
@ -1145,8 +1145,8 @@ Memory is allocated when reading. The followig function frees memory.
</div>
</div>
<div id="outline-container-orgaee8746" class="outline-4">
<h4 id="orgaee8746"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4>
<div id="outline-container-orgc80ae44" class="outline-4">
<h4 id="orgc80ae44"><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.
@ -1212,8 +1212,8 @@ The <code>one_e</code> array is assumed allocated with the appropriate size.
</div>
</div>
<div id="outline-container-org5da0194" class="outline-4">
<h4 id="org5da0194"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4>
<div id="outline-container-org3b50d7b" class="outline-4">
<h4 id="org3b50d7b"><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
@ -1321,7 +1321,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-06 Thu 17:41</p>
<p class="date">Created: 2021-05-06 Thu 17:57</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>