mirror of
https://github.com/TREX-CoE/trexio.git
synced 2024-10-02 22:41:07 +02:00
Deploying to gh-pages from @ TREX-CoE/trexio@818d66d4d3 🚀
This commit is contained in:
q-posev
parent
f35ad25067
commit
5a0e209ad2
@ -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-04-26 Mon 20:47 -->
|
||||
<!-- 2021-04-28 Wed 13:31 -->
|
||||
<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-04-26 Mon 20:47</p>
|
||||
<p class="date">Created: 2021-04-28 Wed 13:31</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -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-04-26 Mon 20:47 -->
|
||||
<!-- 2021-04-28 Wed 13:31 -->
|
||||
<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-04-26 Mon 20:47</p>
|
||||
<p class="date">Created: 2021-04-28 Wed 13:31</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -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-04-26 Mon 20:47 -->
|
||||
<!-- 2021-04-28 Wed 13:31 -->
|
||||
<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,45 +311,45 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#org1634d24">1. Coding conventions</a>
|
||||
<li><a href="#org23d90c6">1. Coding conventions</a>
|
||||
<ul>
|
||||
<li><a href="#org5c49b17">1.1. Memory allocation</a></li>
|
||||
<li><a href="#org1b4e234">1.1. Memory allocation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#orgb63f357">2. Front end</a>
|
||||
<li><a href="#org8a0f2e9">2. Front end</a>
|
||||
<ul>
|
||||
<li><a href="#orgdc00232">2.1. Error handling</a></li>
|
||||
<li><a href="#orga6d5f6e">2.2. Back ends</a></li>
|
||||
<li><a href="#org73ae5e0">2.3. Read/write behavior</a></li>
|
||||
<li><a href="#org9033baf">2.4. TREXIO file type</a></li>
|
||||
<li><a href="#orgfec417a">2.5. Polymorphism of the file handle</a></li>
|
||||
<li><a href="#org273128a">2.6. File opening</a></li>
|
||||
<li><a href="#orgc8bc570">2.7. File closing</a></li>
|
||||
<li><a href="#orgda18db2">2.1. Error handling</a></li>
|
||||
<li><a href="#org066912e">2.2. Back ends</a></li>
|
||||
<li><a href="#org12bcb82">2.3. Read/write behavior</a></li>
|
||||
<li><a href="#org36c8338">2.4. TREXIO file type</a></li>
|
||||
<li><a href="#org93a81e3">2.5. Polymorphism of the file handle</a></li>
|
||||
<li><a href="#org5f7cbbe">2.6. File opening</a></li>
|
||||
<li><a href="#orgae66c0b">2.7. File closing</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org16e4afb">3. Templates for front end</a>
|
||||
<li><a href="#org2952b34">3. Templates for front end</a>
|
||||
<ul>
|
||||
<li><a href="#org51583e1">3.1. Templates for front end has/read/write a dimension</a>
|
||||
<li><a href="#orgbc3053f">3.1. Templates for front end has/read/write a dimension</a>
|
||||
<ul>
|
||||
<li><a href="#org3b0f71e">3.1.1. C templates for front end</a></li>
|
||||
<li><a href="#org7f34841">3.1.2. Fortran templates for front end</a></li>
|
||||
<li><a href="#orgcfc13d8">3.1.1. C templates for front end</a></li>
|
||||
<li><a href="#orgb19e26e">3.1.2. Fortran templates for front end</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org7ea2576">3.2. Templates for front end has/read/write a dataset</a>
|
||||
<li><a href="#org5db198e">3.2. Templates for front end has/read/write a dataset</a>
|
||||
<ul>
|
||||
<li><a href="#org487a8dc">3.2.1. C templates for front end</a></li>
|
||||
<li><a href="#orgeef3c88">3.2.2. Fortran templates for front end</a></li>
|
||||
<li><a href="#org00f8cf1">3.2.1. C templates for front end</a></li>
|
||||
<li><a href="#org695c886">3.2.2. Fortran templates for front end</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org71764ae">4. Fortran helper/wrapper functions</a></li>
|
||||
<li><a href="#org5098291">4. Fortran helper/wrapper functions</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org1634d24" class="outline-2">
|
||||
<h2 id="org1634d24"><span class="section-number-2">1</span> Coding conventions</h2>
|
||||
<div id="outline-container-org23d90c6" class="outline-2">
|
||||
<h2 id="org23d90c6"><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>
|
||||
@ -364,8 +364,8 @@ for the JavaScript code in this tag.
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org5c49b17" class="outline-3">
|
||||
<h3 id="org5c49b17"><span class="section-number-3">1.1</span> Memory allocation</h3>
|
||||
<div id="outline-container-org1b4e234" class="outline-3">
|
||||
<h3 id="org1b4e234"><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
|
||||
@ -392,8 +392,8 @@ This can be facilitated by the use of the following macro:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgb63f357" class="outline-2">
|
||||
<h2 id="orgb63f357"><span class="section-number-2">2</span> Front end</h2>
|
||||
<div id="outline-container-org8a0f2e9" class="outline-2">
|
||||
<h2 id="org8a0f2e9"><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.
|
||||
@ -401,10 +401,10 @@ TREXIO front end is modular, which simplifies impelementation of new back ends.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgdc00232" class="outline-3">
|
||||
<h3 id="orgdc00232"><span class="section-number-3">2.1</span> Error handling</h3>
|
||||
<div id="outline-container-orgda18db2" class="outline-3">
|
||||
<h3 id="orgda18db2"><span class="section-number-3">2.1</span> Error handling</h3>
|
||||
<div class="outline-text-3" id="text-2-1">
|
||||
<table id="org99e4cee" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
<table id="orgba28bcf" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
|
||||
|
||||
<colgroup>
|
||||
@ -605,8 +605,8 @@ The text strings are extracted from the previous table.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orga6d5f6e" class="outline-3">
|
||||
<h3 id="orga6d5f6e"><span class="section-number-3">2.2</span> Back ends</h3>
|
||||
<div id="outline-container-org066912e" class="outline-3">
|
||||
<h3 id="org066912e"><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:
|
||||
@ -636,8 +636,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org73ae5e0" class="outline-3">
|
||||
<h3 id="org73ae5e0"><span class="section-number-3">2.3</span> Read/write behavior</h3>
|
||||
<div id="outline-container-org12bcb82" class="outline-3">
|
||||
<h3 id="org12bcb82"><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
|
||||
@ -665,8 +665,8 @@ concurrent programs, the behavior is not specified.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org9033baf" class="outline-3">
|
||||
<h3 id="org9033baf"><span class="section-number-3">2.4</span> TREXIO file type</h3>
|
||||
<div id="outline-container-org36c8338" class="outline-3">
|
||||
<h3 id="org36c8338"><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
|
||||
@ -698,8 +698,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgfec417a" class="outline-3">
|
||||
<h3 id="orgfec417a"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
|
||||
<div id="outline-container-org93a81e3" class="outline-3">
|
||||
<h3 id="org93a81e3"><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
|
||||
@ -718,8 +718,8 @@ corresponding types for all back ends can be safely casted to
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org273128a" class="outline-3">
|
||||
<h3 id="org273128a"><span class="section-number-3">2.6</span> File opening</h3>
|
||||
<div id="outline-container-org5f7cbbe" class="outline-3">
|
||||
<h3 id="org5f7cbbe"><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.
|
||||
@ -756,11 +756,6 @@ These names are populated by the generator.py (i.e. they are hard-coded), which
|
||||
should tend to avoid renaming the <code>.txt</code> data files.
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">trexio_t</span>* <span style="color: #0000ff;">trexio_open</span>(<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>* <span style="color: #a0522d;">file_name</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span> <span style="color: #a0522d;">mode</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">back_end_t</span> <span style="color: #a0522d;">back_end</span>);
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">trexio_t</span>*
|
||||
<span style="color: #0000ff;">trexio_open</span>(<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>* <span style="color: #a0522d;">file_name</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span> <span style="color: #a0522d;">mode</span>,
|
||||
@ -879,8 +874,8 @@ should tend to avoid renaming the <code>.txt</code> data files.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgc8bc570" class="outline-3">
|
||||
<h3 id="orgc8bc570"><span class="section-number-3">2.7</span> File closing</h3>
|
||||
<div id="outline-container-orgae66c0b" class="outline-3">
|
||||
<h3 id="orgae66c0b"><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.
|
||||
@ -896,11 +891,6 @@ output:
|
||||
<code>trexio_exit_code</code> exit code.
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_close</span>(<span style="color: #228b22;">trexio_t</span>* <span style="color: #a0522d;">file</span>);
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||
<span style="color: #0000ff;">trexio_close</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a0522d;">file</span>)
|
||||
@ -985,8 +975,8 @@ output:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org16e4afb" class="outline-2">
|
||||
<h2 id="org16e4afb"><span class="section-number-2">3</span> Templates for front end</h2>
|
||||
<div id="outline-container-org2952b34" class="outline-2">
|
||||
<h2 id="org2952b34"><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>:
|
||||
@ -1147,8 +1137,8 @@ TREXIO supports I/O with single or double precision for integer and floating poi
|
||||
</div>
|
||||
|
||||
|
||||
<div id="outline-container-org51583e1" class="outline-3">
|
||||
<h3 id="org51583e1"><span class="section-number-3">3.1</span> Templates for front end has/read/write a dimension</h3>
|
||||
<div id="outline-container-orgbc3053f" class="outline-3">
|
||||
<h3 id="orgbc3053f"><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.
|
||||
@ -1217,8 +1207,8 @@ This section concerns API calls related to dimensioning variables.
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org3b0f71e" class="outline-4">
|
||||
<h4 id="org3b0f71e"><span class="section-number-4">3.1.1</span> C templates for front end</h4>
|
||||
<div id="outline-container-orgcfc13d8" class="outline-4">
|
||||
<h4 id="orgcfc13d8"><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.
|
||||
@ -1407,8 +1397,8 @@ The basic (non-suffixed) API call on dimensioning variables deals with single pr
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org7f34841" class="outline-4">
|
||||
<h4 id="org7f34841"><span class="section-number-4">3.1.2</span> Fortran templates for front end</h4>
|
||||
<div id="outline-container-orgb19e26e" class="outline-4">
|
||||
<h4 id="orgb19e26e"><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.
|
||||
@ -1495,8 +1485,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
||||
</div>
|
||||
|
||||
|
||||
<div id="outline-container-org7ea2576" class="outline-3">
|
||||
<h3 id="org7ea2576"><span class="section-number-3">3.2</span> Templates for front end has/read/write a dataset</h3>
|
||||
<div id="outline-container-org5db198e" class="outline-3">
|
||||
<h3 id="org5db198e"><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.
|
||||
@ -1565,8 +1555,8 @@ This section concerns API calls related to datasets.
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org487a8dc" class="outline-4">
|
||||
<h4 id="org487a8dc"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
|
||||
<div id="outline-container-org00f8cf1" class="outline-4">
|
||||
<h4 id="org00f8cf1"><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.
|
||||
@ -1824,8 +1814,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgeef3c88" class="outline-4">
|
||||
<h4 id="orgeef3c88"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
|
||||
<div id="outline-container-org695c886" class="outline-4">
|
||||
<h4 id="org695c886"><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>.
|
||||
@ -1912,8 +1902,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org71764ae" class="outline-2">
|
||||
<h2 id="org71764ae"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
|
||||
<div id="outline-container-org5098291" class="outline-2">
|
||||
<h2 id="org5098291"><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.
|
||||
@ -1942,7 +1932,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-04-26 Mon 20:47</p>
|
||||
<p class="date">Created: 2021-04-28 Wed 13:31</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -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-04-26 Mon 20:47 -->
|
||||
<!-- 2021-04-28 Wed 13:31 -->
|
||||
<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="#orgf5610c8">1. HDF5 back end</a>
|
||||
<li><a href="#org74d5a7a">1. HDF5 back end</a>
|
||||
<ul>
|
||||
<li><a href="#org75abadd">1.1. Template for HDF5 definitions</a></li>
|
||||
<li><a href="#org25443c8">1.2. Template for HDF5 structures</a></li>
|
||||
<li><a href="#org9b75c9e">1.3. Template for HDF5 init/deinit</a></li>
|
||||
<li><a href="#orge9acdda">1.4. Template for HDF5 has/read/write a number</a></li>
|
||||
<li><a href="#orgdbb2ddb">1.5. Template for HDF5 has/read/write a dataset</a></li>
|
||||
<li><a href="#orgd2cb048">1.1. Template for HDF5 definitions</a></li>
|
||||
<li><a href="#orgdbef80e">1.2. Template for HDF5 structures</a></li>
|
||||
<li><a href="#org13821db">1.3. Template for HDF5 init/deinit</a></li>
|
||||
<li><a href="#orgd5e7d11">1.4. Template for HDF5 has/read/write a number</a></li>
|
||||
<li><a href="#orgf2080d6">1.5. Template for HDF5 has/read/write a dataset</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgf5610c8" class="outline-2">
|
||||
<h2 id="orgf5610c8"><span class="section-number-2">1</span> HDF5 back end</h2>
|
||||
<div id="outline-container-org74d5a7a" class="outline-2">
|
||||
<h2 id="org74d5a7a"><span class="section-number-2">1</span> HDF5 back end</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
</div>
|
||||
<div id="outline-container-org75abadd" class="outline-3">
|
||||
<h3 id="org75abadd"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
|
||||
<div id="outline-container-orgd2cb048" class="outline-3">
|
||||
<h3 id="orgd2cb048"><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-org25443c8" class="outline-3">
|
||||
<h3 id="org25443c8"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
|
||||
<div id="outline-container-orgdbef80e" class="outline-3">
|
||||
<h3 id="orgdbef80e"><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-org9b75c9e" class="outline-3">
|
||||
<h3 id="org9b75c9e"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
|
||||
<div id="outline-container-org13821db" class="outline-3">
|
||||
<h3 id="org13821db"><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-orge9acdda" class="outline-3">
|
||||
<h3 id="orge9acdda"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a number</h3>
|
||||
<div id="outline-container-orgd5e7d11" class="outline-3">
|
||||
<h3 id="orgd5e7d11"><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>
|
||||
@ -564,8 +564,8 @@ for the JavaScript code in this tag.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgdbb2ddb" class="outline-3">
|
||||
<h3 id="orgdbb2ddb"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset</h3>
|
||||
<div id="outline-container-orgf2080d6" class="outline-3">
|
||||
<h3 id="orgf2080d6"><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>
|
||||
@ -696,7 +696,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-04-26 Mon 20:47</p>
|
||||
<p class="date">Created: 2021-04-28 Wed 13:31</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
@ -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-04-26 Mon 20:47 -->
|
||||
<!-- 2021-04-28 Wed 13:31 -->
|
||||
<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="#org72ef86d">1. TEXT back end</a>
|
||||
<li><a href="#orga7edac1">1. TEXT back end</a>
|
||||
<ul>
|
||||
<li><a href="#org7ac4105">1.1. Template for group-related structures in text back end</a></li>
|
||||
<li><a href="#orgad2693e">1.2. Template for general structure in text back end</a></li>
|
||||
<li><a href="#org67028fc">1.3. Initialize function (constant part)</a></li>
|
||||
<li><a href="#org03e99a4">1.4. Deinitialize function (templated part)</a></li>
|
||||
<li><a href="#org966c771">1.5. Template for text read struct</a></li>
|
||||
<li><a href="#org6baee96">1.6. Template for text flush struct</a></li>
|
||||
<li><a href="#org9e35658">1.7. Template for text free memory</a></li>
|
||||
<li><a href="#org11f1e58">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
|
||||
<li><a href="#orge114c88">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
|
||||
<li><a href="#org4055399">1.10. RDM struct (hard-coded)</a>
|
||||
<li><a href="#org700464a">1.1. Template for group-related structures in text back end</a></li>
|
||||
<li><a href="#org8830f14">1.2. Template for general structure in text back end</a></li>
|
||||
<li><a href="#orga5d9585">1.3. Initialize function (constant part)</a></li>
|
||||
<li><a href="#org9a28438">1.4. Deinitialize function (templated part)</a></li>
|
||||
<li><a href="#orgc837d1b">1.5. Template for text read struct</a></li>
|
||||
<li><a href="#org4bbf248">1.6. Template for text flush struct</a></li>
|
||||
<li><a href="#org5ec0d72">1.7. Template for text free memory</a></li>
|
||||
<li><a href="#org74f50af">1.8. Template for has/read/write the <code>$group_num$</code> attribute</a></li>
|
||||
<li><a href="#orgd173f96">1.9. Template for has/read/write the <code>$group_dset$</code> dataset</a></li>
|
||||
<li><a href="#org8da3442">1.10. RDM struct (hard-coded)</a>
|
||||
<ul>
|
||||
<li><a href="#orgadb91c5">1.10.1. Read the complete struct</a></li>
|
||||
<li><a href="#org70249b9">1.10.2. Flush the complete struct</a></li>
|
||||
<li><a href="#orge6cc922">1.10.3. Free memory</a></li>
|
||||
<li><a href="#org31cd815">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
|
||||
<li><a href="#org57fee2d">1.10.5. Read/Write the two<sub>e</sub> attribute</a></li>
|
||||
<li><a href="#org06ca143">1.10.1. Read the complete struct</a></li>
|
||||
<li><a href="#orgf164a03">1.10.2. Flush the complete struct</a></li>
|
||||
<li><a href="#org0282d86">1.10.3. Free memory</a></li>
|
||||
<li><a href="#org863001f">1.10.4. Read/Write the one<sub>e</sub> attribute</a></li>
|
||||
<li><a href="#org2e44326">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-org72ef86d" class="outline-2">
|
||||
<h2 id="org72ef86d"><span class="section-number-2">1</span> TEXT back end</h2>
|
||||
<div id="outline-container-orga7edac1" class="outline-2">
|
||||
<h2 id="orga7edac1"><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-org7ac4105" class="outline-3">
|
||||
<h3 id="org7ac4105"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
|
||||
<div id="outline-container-org700464a" class="outline-3">
|
||||
<h3 id="org700464a"><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-orgad2693e" class="outline-3">
|
||||
<h3 id="orgad2693e"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
|
||||
<div id="outline-container-org8830f14" class="outline-3">
|
||||
<h3 id="org8830f14"><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-org67028fc" class="outline-3">
|
||||
<h3 id="org67028fc"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
|
||||
<div id="outline-container-orga5d9585" class="outline-3">
|
||||
<h3 id="orga5d9585"><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>
|
||||
@ -507,8 +507,8 @@ The file is written when closed, or when the flush function is called.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org03e99a4" class="outline-3">
|
||||
<h3 id="org03e99a4"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
|
||||
<div id="outline-container-org9a28438" class="outline-3">
|
||||
<h3 id="org9a28438"><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>
|
||||
@ -532,8 +532,8 @@ The file is written when closed, or when the flush function is called.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org966c771" class="outline-3">
|
||||
<h3 id="org966c771"><span class="section-number-3">1.5</span> Template for text read struct</h3>
|
||||
<div id="outline-container-orgc837d1b" class="outline-3">
|
||||
<h3 id="orgc837d1b"><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*
|
||||
@ -724,8 +724,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org6baee96" class="outline-3">
|
||||
<h3 id="org6baee96"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
|
||||
<div id="outline-container-org4bbf248" class="outline-3">
|
||||
<h3 id="org4bbf248"><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>
|
||||
@ -783,8 +783,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org9e35658" class="outline-3">
|
||||
<h3 id="org9e35658"><span class="section-number-3">1.7</span> Template for text free memory</h3>
|
||||
<div id="outline-container-org5ec0d72" class="outline-3">
|
||||
<h3 id="org5ec0d72"><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.
|
||||
@ -825,8 +825,8 @@ Memory is allocated when reading. The following function frees memory.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org11f1e58" class="outline-3">
|
||||
<h3 id="org11f1e58"><span class="section-number-3">1.8</span> Template for has/read/write the <code>$group_num$</code> attribute</h3>
|
||||
<div id="outline-container-org74f50af" class="outline-3">
|
||||
<h3 id="org74f50af"><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>
|
||||
@ -888,8 +888,8 @@ Memory is allocated when reading. The following function frees memory.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orge114c88" class="outline-3">
|
||||
<h3 id="orge114c88"><span class="section-number-3">1.9</span> Template for has/read/write the <code>$group_dset$</code> dataset</h3>
|
||||
<div id="outline-container-orgd173f96" class="outline-3">
|
||||
<h3 id="orgd173f96"><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.
|
||||
@ -986,12 +986,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org4055399" class="outline-3">
|
||||
<h3 id="org4055399"><span class="section-number-3">1.10</span> RDM struct (hard-coded)</h3>
|
||||
<div id="outline-container-org8da3442" class="outline-3">
|
||||
<h3 id="org8da3442"><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-orgadb91c5" class="outline-4">
|
||||
<h4 id="orgadb91c5"><span class="section-number-4">1.10.1</span> Read the complete struct</h4>
|
||||
<div id="outline-container-org06ca143" class="outline-4">
|
||||
<h4 id="org06ca143"><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>);
|
||||
@ -1085,8 +1085,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org70249b9" class="outline-4">
|
||||
<h4 id="org70249b9"><span class="section-number-4">1.10.2</span> Flush the complete struct</h4>
|
||||
<div id="outline-container-orgf164a03" class="outline-4">
|
||||
<h4 id="orgf164a03"><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>);
|
||||
@ -1129,8 +1129,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orge6cc922" class="outline-4">
|
||||
<h4 id="orge6cc922"><span class="section-number-4">1.10.3</span> Free memory</h4>
|
||||
<div id="outline-container-org0282d86" class="outline-4">
|
||||
<h4 id="org0282d86"><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.
|
||||
@ -1175,8 +1175,8 @@ Memory is allocated when reading. The followig function frees memory.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org31cd815" class="outline-4">
|
||||
<h4 id="org31cd815"><span class="section-number-4">1.10.4</span> Read/Write the one<sub>e</sub> attribute</h4>
|
||||
<div id="outline-container-org863001f" class="outline-4">
|
||||
<h4 id="org863001f"><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.
|
||||
@ -1242,8 +1242,8 @@ The <code>one_e</code> array is assumed allocated with the appropriate size.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org57fee2d" class="outline-4">
|
||||
<h4 id="org57fee2d"><span class="section-number-4">1.10.5</span> Read/Write the two<sub>e</sub> attribute</h4>
|
||||
<div id="outline-container-org2e44326" class="outline-4">
|
||||
<h4 id="org2e44326"><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
|
||||
@ -1351,7 +1351,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-04-26 Mon 20:47</p>
|
||||
<p class="date">Created: 2021-04-28 Wed 13:31</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user