mirror of
https://github.com/TREX-CoE/trexio.git
synced 2024-12-25 13:53:55 +01:00
Deploying to gh-pages from @ TREX-CoE/trexio@ec0db01f0c 🚀
This commit is contained in:
scemama
parent
cc0a43e591
commit
77f166528d
@ -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-06-17 Thu 18:22 -->
|
||||
<!-- 2021-06-18 Fri 10:05 -->
|
||||
<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>
|
||||
@ -310,6 +310,7 @@ for the JavaScript code in this tag.
|
||||
<hr />
|
||||
|
||||
<ul class="org-ul">
|
||||
<li><a href="./trex.html">Data stored with TREXIO</a></li>
|
||||
<li><a href="./templator_front.html">Front end API</a></li>
|
||||
<li><a href="./templator_hdf5.html">HDF5 back end</a></li>
|
||||
<li><a href="./templator_text.html">TEXT back end</a></li>
|
||||
@ -341,7 +342,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-06-17 Thu 18:22</p>
|
||||
<p class="date">Created: 2021-06-18 Fri 10:05</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
285
Sparse.html
Normal file
285
Sparse.html
Normal file
@ -0,0 +1,285 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"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-06-18 Fri 10:05 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>‎</title>
|
||||
<meta name="generator" content="Org mode" />
|
||||
<style type="text/css">
|
||||
<!--/*--><![CDATA[/*><!--*/
|
||||
.title { text-align: center;
|
||||
margin-bottom: .2em; }
|
||||
.subtitle { text-align: center;
|
||||
font-size: medium;
|
||||
font-weight: bold;
|
||||
margin-top:0; }
|
||||
.todo { font-family: monospace; color: red; }
|
||||
.done { font-family: monospace; color: green; }
|
||||
.priority { font-family: monospace; color: orange; }
|
||||
.tag { background-color: #eee; font-family: monospace;
|
||||
padding: 2px; font-size: 80%; font-weight: normal; }
|
||||
.timestamp { color: #bebebe; }
|
||||
.timestamp-kwd { color: #5f9ea0; }
|
||||
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
|
||||
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
|
||||
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
|
||||
.underline { text-decoration: underline; }
|
||||
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
|
||||
p.verse { margin-left: 3%; }
|
||||
pre {
|
||||
border: 1px solid #ccc;
|
||||
box-shadow: 3px 3px 3px #eee;
|
||||
padding: 8pt;
|
||||
font-family: monospace;
|
||||
overflow: auto;
|
||||
margin: 1.2em;
|
||||
}
|
||||
pre.src {
|
||||
position: relative;
|
||||
overflow: visible;
|
||||
padding-top: 1.2em;
|
||||
}
|
||||
pre.src:before {
|
||||
display: none;
|
||||
position: absolute;
|
||||
background-color: white;
|
||||
top: -10px;
|
||||
right: 10px;
|
||||
padding: 3px;
|
||||
border: 1px solid black;
|
||||
}
|
||||
pre.src:hover:before { display: inline;}
|
||||
/* Languages per Org manual */
|
||||
pre.src-asymptote:before { content: 'Asymptote'; }
|
||||
pre.src-awk:before { content: 'Awk'; }
|
||||
pre.src-C:before { content: 'C'; }
|
||||
/* pre.src-C++ doesn't work in CSS */
|
||||
pre.src-clojure:before { content: 'Clojure'; }
|
||||
pre.src-css:before { content: 'CSS'; }
|
||||
pre.src-D:before { content: 'D'; }
|
||||
pre.src-ditaa:before { content: 'ditaa'; }
|
||||
pre.src-dot:before { content: 'Graphviz'; }
|
||||
pre.src-calc:before { content: 'Emacs Calc'; }
|
||||
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
|
||||
pre.src-fortran:before { content: 'Fortran'; }
|
||||
pre.src-gnuplot:before { content: 'gnuplot'; }
|
||||
pre.src-haskell:before { content: 'Haskell'; }
|
||||
pre.src-hledger:before { content: 'hledger'; }
|
||||
pre.src-java:before { content: 'Java'; }
|
||||
pre.src-js:before { content: 'Javascript'; }
|
||||
pre.src-latex:before { content: 'LaTeX'; }
|
||||
pre.src-ledger:before { content: 'Ledger'; }
|
||||
pre.src-lisp:before { content: 'Lisp'; }
|
||||
pre.src-lilypond:before { content: 'Lilypond'; }
|
||||
pre.src-lua:before { content: 'Lua'; }
|
||||
pre.src-matlab:before { content: 'MATLAB'; }
|
||||
pre.src-mscgen:before { content: 'Mscgen'; }
|
||||
pre.src-ocaml:before { content: 'Objective Caml'; }
|
||||
pre.src-octave:before { content: 'Octave'; }
|
||||
pre.src-org:before { content: 'Org mode'; }
|
||||
pre.src-oz:before { content: 'OZ'; }
|
||||
pre.src-plantuml:before { content: 'Plantuml'; }
|
||||
pre.src-processing:before { content: 'Processing.js'; }
|
||||
pre.src-python:before { content: 'Python'; }
|
||||
pre.src-R:before { content: 'R'; }
|
||||
pre.src-ruby:before { content: 'Ruby'; }
|
||||
pre.src-sass:before { content: 'Sass'; }
|
||||
pre.src-scheme:before { content: 'Scheme'; }
|
||||
pre.src-screen:before { content: 'Gnu Screen'; }
|
||||
pre.src-sed:before { content: 'Sed'; }
|
||||
pre.src-sh:before { content: 'shell'; }
|
||||
pre.src-sql:before { content: 'SQL'; }
|
||||
pre.src-sqlite:before { content: 'SQLite'; }
|
||||
/* additional languages in org.el's org-babel-load-languages alist */
|
||||
pre.src-forth:before { content: 'Forth'; }
|
||||
pre.src-io:before { content: 'IO'; }
|
||||
pre.src-J:before { content: 'J'; }
|
||||
pre.src-makefile:before { content: 'Makefile'; }
|
||||
pre.src-maxima:before { content: 'Maxima'; }
|
||||
pre.src-perl:before { content: 'Perl'; }
|
||||
pre.src-picolisp:before { content: 'Pico Lisp'; }
|
||||
pre.src-scala:before { content: 'Scala'; }
|
||||
pre.src-shell:before { content: 'Shell Script'; }
|
||||
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
|
||||
/* additional language identifiers per "defun org-babel-execute"
|
||||
in ob-*.el */
|
||||
pre.src-cpp:before { content: 'C++'; }
|
||||
pre.src-abc:before { content: 'ABC'; }
|
||||
pre.src-coq:before { content: 'Coq'; }
|
||||
pre.src-groovy:before { content: 'Groovy'; }
|
||||
/* additional language identifiers from org-babel-shell-names in
|
||||
ob-shell.el: ob-shell is the only babel language using a lambda to put
|
||||
the execution function name together. */
|
||||
pre.src-bash:before { content: 'bash'; }
|
||||
pre.src-csh:before { content: 'csh'; }
|
||||
pre.src-ash:before { content: 'ash'; }
|
||||
pre.src-dash:before { content: 'dash'; }
|
||||
pre.src-ksh:before { content: 'ksh'; }
|
||||
pre.src-mksh:before { content: 'mksh'; }
|
||||
pre.src-posh:before { content: 'posh'; }
|
||||
/* Additional Emacs modes also supported by the LaTeX listings package */
|
||||
pre.src-ada:before { content: 'Ada'; }
|
||||
pre.src-asm:before { content: 'Assembler'; }
|
||||
pre.src-caml:before { content: 'Caml'; }
|
||||
pre.src-delphi:before { content: 'Delphi'; }
|
||||
pre.src-html:before { content: 'HTML'; }
|
||||
pre.src-idl:before { content: 'IDL'; }
|
||||
pre.src-mercury:before { content: 'Mercury'; }
|
||||
pre.src-metapost:before { content: 'MetaPost'; }
|
||||
pre.src-modula-2:before { content: 'Modula-2'; }
|
||||
pre.src-pascal:before { content: 'Pascal'; }
|
||||
pre.src-ps:before { content: 'PostScript'; }
|
||||
pre.src-prolog:before { content: 'Prolog'; }
|
||||
pre.src-simula:before { content: 'Simula'; }
|
||||
pre.src-tcl:before { content: 'tcl'; }
|
||||
pre.src-tex:before { content: 'TeX'; }
|
||||
pre.src-plain-tex:before { content: 'Plain TeX'; }
|
||||
pre.src-verilog:before { content: 'Verilog'; }
|
||||
pre.src-vhdl:before { content: 'VHDL'; }
|
||||
pre.src-xml:before { content: 'XML'; }
|
||||
pre.src-nxml:before { content: 'XML'; }
|
||||
/* add a generic configuration mode; LaTeX export needs an additional
|
||||
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
|
||||
pre.src-conf:before { content: 'Configuration File'; }
|
||||
|
||||
table { border-collapse:collapse; }
|
||||
caption.t-above { caption-side: top; }
|
||||
caption.t-bottom { caption-side: bottom; }
|
||||
td, th { vertical-align:top; }
|
||||
th.org-right { text-align: center; }
|
||||
th.org-left { text-align: center; }
|
||||
th.org-center { text-align: center; }
|
||||
td.org-right { text-align: right; }
|
||||
td.org-left { text-align: left; }
|
||||
td.org-center { text-align: center; }
|
||||
dt { font-weight: bold; }
|
||||
.footpara { display: inline; }
|
||||
.footdef { margin-bottom: 1em; }
|
||||
.figure { padding: 1em; }
|
||||
.figure p { text-align: center; }
|
||||
.inlinetask {
|
||||
padding: 10px;
|
||||
border: 2px solid gray;
|
||||
margin: 10px;
|
||||
background: #ffffcc;
|
||||
}
|
||||
#org-div-home-and-up
|
||||
{ text-align: right; font-size: 70%; white-space: nowrap; }
|
||||
textarea { overflow-x: auto; }
|
||||
.linenr { font-size: smaller }
|
||||
.code-highlighted { background-color: #ffff00; }
|
||||
.org-info-js_info-navigation { border-style: none; }
|
||||
#org-info-js_console-label
|
||||
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
|
||||
.org-info-js_search-highlight
|
||||
{ background-color: #ffff00; color: #000000; font-weight: bold; }
|
||||
.org-svg { width: 90%; }
|
||||
/*]]>*/-->
|
||||
</style>
|
||||
<script type="text/javascript">
|
||||
/*
|
||||
@licstart The following is the entire license notice for the
|
||||
JavaScript code in this tag.
|
||||
|
||||
Copyright (C) 2012-2019 Free Software Foundation, Inc.
|
||||
|
||||
The JavaScript code in this tag is free software: you can
|
||||
redistribute it and/or modify it under the terms of the GNU
|
||||
General Public License (GNU GPL) as published by the Free Software
|
||||
Foundation, either version 3 of the License, or (at your option)
|
||||
any later version. The code is distributed WITHOUT ANY WARRANTY;
|
||||
without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
|
||||
|
||||
As additional permission under GNU GPL version 3 section 7, you
|
||||
may distribute non-source (e.g., minimized or compacted) forms of
|
||||
that code without the copy of the GNU GPL normally required by
|
||||
section 4, provided you include this license notice and a URL
|
||||
through which recipients can access the Corresponding Source.
|
||||
|
||||
|
||||
@licend The above is the entire license notice
|
||||
for the JavaScript code in this tag.
|
||||
*/
|
||||
<!--/*--><![CDATA[/*><!--*/
|
||||
function CodeHighlightOn(elem, id)
|
||||
{
|
||||
var target = document.getElementById(id);
|
||||
if(null != target) {
|
||||
elem.cacheClassElem = elem.className;
|
||||
elem.cacheClassTarget = target.className;
|
||||
target.className = "code-highlighted";
|
||||
elem.className = "code-highlighted";
|
||||
}
|
||||
}
|
||||
function CodeHighlightOff(elem, id)
|
||||
{
|
||||
var target = document.getElementById(id);
|
||||
if(elem.cacheClassElem)
|
||||
elem.className = elem.cacheClassElem;
|
||||
if(elem.cacheClassTarget)
|
||||
target.className = elem.cacheClassTarget;
|
||||
}
|
||||
/*]]>*///-->
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="content">
|
||||
<div id="table-of-contents">
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#org2e23bc7">1. Text back end</a></li>
|
||||
<li><a href="#org1c4e22a">2. HDF5 Back end</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<p>
|
||||
See templator<sub>front.org</sub>
|
||||
</p>
|
||||
|
||||
<div id="outline-container-org2e23bc7" class="outline-2">
|
||||
<h2 id="org2e23bc7"><span class="section-number-2">1</span> Text back end</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
<p>
|
||||
As the size of the dataset should be extensible, the simplest
|
||||
solution is to use one file for each sparse data set, and store a
|
||||
the name of this file in the group.
|
||||
Each integral can be a line in the file:
|
||||
i j k l x
|
||||
which can be read with "%10ld %10ld %10ld %10ld %24.16e".
|
||||
The offset can be used with <code>fseek(69L*offset, SEEK_SET)</code>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org1c4e22a" class="outline-2">
|
||||
<h2 id="org1c4e22a"><span class="section-number-2">2</span> HDF5 Back end</h2>
|
||||
<div class="outline-text-2" id="text-2">
|
||||
<p>
|
||||
We need to declare the number of rows of the dataset as
|
||||
<code>UNLIMITED</code>. This requires to use the <code>Chunked</code> storage, and the
|
||||
chunks should absolutely not be larger than 1MB.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
To extend the storage, see :
|
||||
<a href="https://support.hdfgroup.org/HDF5/doc1.6/UG/10_Datasets.html">https://support.hdfgroup.org/HDF5/doc1.6/UG/10_Datasets.html</a>
|
||||
(figure 17)
|
||||
</p>
|
||||
|
||||
<p>
|
||||
If the offset+num > nmax, we need to extend the dataset.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="date">Created: 2021-06-18 Fri 10:05</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@ -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-06-17 Thu 18:22 -->
|
||||
<!-- 2021-06-18 Fri 10:05 -->
|
||||
<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>
|
||||
@ -310,6 +310,7 @@ for the JavaScript code in this tag.
|
||||
<hr />
|
||||
|
||||
<ul class="org-ul">
|
||||
<li><a href="./trex.html">Data stored with TREXIO</a></li>
|
||||
<li><a href="./templator_front.html">Front end API</a></li>
|
||||
<li><a href="./templator_hdf5.html">HDF5 back end</a></li>
|
||||
<li><a href="./templator_text.html">TEXT back end</a></li>
|
||||
@ -341,7 +342,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-06-17 Thu 18:22</p>
|
||||
<p class="date">Created: 2021-06-18 Fri 10:05</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-06-17 Thu 18:22 -->
|
||||
<!-- 2021-06-18 Fri 10:04 -->
|
||||
<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>
|
||||
@ -333,61 +333,61 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#org9221b68">1. Coding conventions</a>
|
||||
<li><a href="#orgd372491">1. Coding conventions</a>
|
||||
<ul>
|
||||
<li><a href="#org1203fa6">1.1. Memory allocation</a></li>
|
||||
<li><a href="#orgeb0be24">1.1. Memory allocation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#orge54fa96">2. Front end</a>
|
||||
<li><a href="#org10c2596">2. Front end</a>
|
||||
<ul>
|
||||
<li><a href="#org18547c6">2.1. Error handling</a></li>
|
||||
<li><a href="#orgb67d8fa">2.2. Back ends</a></li>
|
||||
<li><a href="#org0d5127f">2.3. Read/write behavior</a></li>
|
||||
<li><a href="#org9e964cd">2.4. TREXIO file type</a></li>
|
||||
<li><a href="#org5fbaee5">2.5. Polymorphism of the file handle</a></li>
|
||||
<li><a href="#org1dcea90">2.6. File opening</a></li>
|
||||
<li><a href="#orga5a4e1f">2.7. File closing</a></li>
|
||||
<li><a href="#orgf8000e7">2.1. Error handling</a></li>
|
||||
<li><a href="#org3a2297b">2.2. Back ends</a></li>
|
||||
<li><a href="#org3822302">2.3. Read/write behavior</a></li>
|
||||
<li><a href="#org6351435">2.4. TREXIO file type</a></li>
|
||||
<li><a href="#org9825bc0">2.5. Polymorphism of the file handle</a></li>
|
||||
<li><a href="#org801cdf7">2.6. File opening</a></li>
|
||||
<li><a href="#orgf6b1755">2.7. File closing</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org6c51f26">3. Templates for front end</a>
|
||||
<li><a href="#orgf1b8a43">3. Templates for front end</a>
|
||||
<ul>
|
||||
<li><a href="#org52bc7b3">3.1. Description</a></li>
|
||||
<li><a href="#org681a3c3">3.2. Templates for front end has/read/write a single dimensioning variable</a>
|
||||
<li><a href="#org8ca4314">3.1. Description</a></li>
|
||||
<li><a href="#org0a858a4">3.2. Templates for front end has/read/write a single dimensioning variable</a>
|
||||
<ul>
|
||||
<li><a href="#org5027f93">3.2.1. C templates for front end</a></li>
|
||||
<li><a href="#orgf3dcbb2">3.2.2. Fortran templates for front end</a></li>
|
||||
<li><a href="#org6c45cc8">3.2.1. C templates for front end</a></li>
|
||||
<li><a href="#org3de94c3">3.2.2. Fortran templates for front end</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#orgbbfaaf5">3.3. Templates for front end has/read/write a dataset of numerical data</a>
|
||||
<li><a href="#org3159753">3.3. Templates for front end has/read/write a dataset of numerical data</a>
|
||||
<ul>
|
||||
<li><a href="#orgbf9ee71">3.3.1. C templates for front end</a></li>
|
||||
<li><a href="#org4df451d">3.3.2. Fortran templates for front end</a></li>
|
||||
<li><a href="#org323de15">3.3.1. C templates for front end</a></li>
|
||||
<li><a href="#orgf704e07">3.3.2. Fortran templates for front end</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org4514b6b">3.4. Sparse data structures</a></li>
|
||||
<li><a href="#orgb3d5357">3.5. Templates for front end has/read/write a dataset of strings</a>
|
||||
<li><a href="#org8d62996">3.4. Sparse data structures</a></li>
|
||||
<li><a href="#org830963a">3.5. Templates for front end has/read/write a dataset of strings</a>
|
||||
<ul>
|
||||
<li><a href="#org33162ff">3.5.1. Introduction</a></li>
|
||||
<li><a href="#orgbb52ee9">3.5.2. C templates for front end</a></li>
|
||||
<li><a href="#orga35d58c">3.5.3. Fortran templates for front end</a></li>
|
||||
<li><a href="#org124e041">3.5.1. Introduction</a></li>
|
||||
<li><a href="#org8f0c674">3.5.2. C templates for front end</a></li>
|
||||
<li><a href="#org802b1d0">3.5.3. Fortran templates for front end</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org769408d">3.6. Templates for front end has/read/write a single string attribute</a>
|
||||
<li><a href="#org4c0b439">3.6. Templates for front end has/read/write a single string attribute</a>
|
||||
<ul>
|
||||
<li><a href="#org4529784">3.6.1. Introduction</a></li>
|
||||
<li><a href="#org25a72a6">3.6.2. C templates for front end</a></li>
|
||||
<li><a href="#orgcf7769a">3.6.3. Fortran templates for front end</a></li>
|
||||
<li><a href="#org70c0913">3.6.1. Introduction</a></li>
|
||||
<li><a href="#org4f1d779">3.6.2. C templates for front end</a></li>
|
||||
<li><a href="#orga4f1e9a">3.6.3. Fortran templates for front end</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#orgaf1b95c">4. Fortran helper/wrapper functions</a></li>
|
||||
<li><a href="#org1f166fd">4. Fortran helper/wrapper functions</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org9221b68" class="outline-2">
|
||||
<h2 id="org9221b68"><span class="section-number-2">1</span> Coding conventions</h2>
|
||||
<div id="outline-container-orgd372491" class="outline-2">
|
||||
<h2 id="orgd372491"><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>
|
||||
@ -402,8 +402,8 @@ for the JavaScript code in this tag.
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org1203fa6" class="outline-3">
|
||||
<h3 id="org1203fa6"><span class="section-number-3">1.1</span> Memory allocation</h3>
|
||||
<div id="outline-container-orgeb0be24" class="outline-3">
|
||||
<h3 id="orgeb0be24"><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
|
||||
@ -438,8 +438,8 @@ The maximum string size for the filenames is 4096 characters.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orge54fa96" class="outline-2">
|
||||
<h2 id="orge54fa96"><span class="section-number-2">2</span> Front end</h2>
|
||||
<div id="outline-container-org10c2596" class="outline-2">
|
||||
<h2 id="org10c2596"><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.
|
||||
@ -447,10 +447,10 @@ TREXIO front end is modular, which simplifies implementation of new back ends.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org18547c6" class="outline-3">
|
||||
<h3 id="org18547c6"><span class="section-number-3">2.1</span> Error handling</h3>
|
||||
<div id="outline-container-orgf8000e7" class="outline-3">
|
||||
<h3 id="orgf8000e7"><span class="section-number-3">2.1</span> Error handling</h3>
|
||||
<div class="outline-text-3" id="text-2-1">
|
||||
<table id="orga4d3089" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
<table id="orgd7873fe" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
|
||||
|
||||
<colgroup>
|
||||
@ -750,8 +750,8 @@ The text strings are extracted from the previous table.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgb67d8fa" class="outline-3">
|
||||
<h3 id="orgb67d8fa"><span class="section-number-3">2.2</span> Back ends</h3>
|
||||
<div id="outline-container-org3a2297b" class="outline-3">
|
||||
<h3 id="org3a2297b"><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:
|
||||
@ -783,8 +783,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org0d5127f" class="outline-3">
|
||||
<h3 id="org0d5127f"><span class="section-number-3">2.3</span> Read/write behavior</h3>
|
||||
<div id="outline-container-org3822302" class="outline-3">
|
||||
<h3 id="org3822302"><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
|
||||
@ -812,8 +812,8 @@ concurrent programs, the behavior is not specified.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org9e964cd" class="outline-3">
|
||||
<h3 id="org9e964cd"><span class="section-number-3">2.4</span> TREXIO file type</h3>
|
||||
<div id="outline-container-org6351435" class="outline-3">
|
||||
<h3 id="org6351435"><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
|
||||
@ -846,8 +846,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org5fbaee5" class="outline-3">
|
||||
<h3 id="org5fbaee5"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
|
||||
<div id="outline-container-org9825bc0" class="outline-3">
|
||||
<h3 id="org9825bc0"><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
|
||||
@ -866,8 +866,8 @@ corresponding types for all back ends can be safely casted to
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org1dcea90" class="outline-3">
|
||||
<h3 id="org1dcea90"><span class="section-number-3">2.6</span> File opening</h3>
|
||||
<div id="outline-container-org801cdf7" class="outline-3">
|
||||
<h3 id="org801cdf7"><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.
|
||||
@ -1058,8 +1058,8 @@ know if we need to shift by 1 arrays of indices.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orga5a4e1f" class="outline-3">
|
||||
<h3 id="orga5a4e1f"><span class="section-number-3">2.7</span> File closing</h3>
|
||||
<div id="outline-container-orgf6b1755" class="outline-3">
|
||||
<h3 id="orgf6b1755"><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.
|
||||
@ -1155,12 +1155,12 @@ output:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org6c51f26" class="outline-2">
|
||||
<h2 id="org6c51f26"><span class="section-number-2">3</span> Templates for front end</h2>
|
||||
<div id="outline-container-orgf1b8a43" class="outline-2">
|
||||
<h2 id="orgf1b8a43"><span class="section-number-2">3</span> Templates for front end</h2>
|
||||
<div class="outline-text-2" id="text-3">
|
||||
</div>
|
||||
<div id="outline-container-org52bc7b3" class="outline-3">
|
||||
<h3 id="org52bc7b3"><span class="section-number-3">3.1</span> Description</h3>
|
||||
<div id="outline-container-org8ca4314" class="outline-3">
|
||||
<h3 id="org8ca4314"><span class="section-number-3">3.1</span> Description</h3>
|
||||
<div class="outline-text-3" id="text-3-1">
|
||||
<p>
|
||||
Consider the following block of <code>trex.json</code>:
|
||||
@ -1350,8 +1350,8 @@ or double precision for integer and floating point numbers.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org681a3c3" class="outline-3">
|
||||
<h3 id="org681a3c3"><span class="section-number-3">3.2</span> Templates for front end has/read/write a single dimensioning variable</h3>
|
||||
<div id="outline-container-org0a858a4" class="outline-3">
|
||||
<h3 id="org0a858a4"><span class="section-number-3">3.2</span> Templates for front end has/read/write a single dimensioning variable</h3>
|
||||
<div class="outline-text-3" id="text-3-2">
|
||||
<p>
|
||||
This section concerns API calls related to dimensioning variables.
|
||||
@ -1420,8 +1420,8 @@ This section concerns API calls related to dimensioning variables.
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org5027f93" class="outline-4">
|
||||
<h4 id="org5027f93"><span class="section-number-4">3.2.1</span> C templates for front end</h4>
|
||||
<div id="outline-container-org6c45cc8" class="outline-4">
|
||||
<h4 id="org6c45cc8"><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 <code>C</code> templates that correspond to each of the abovementioned
|
||||
@ -1610,8 +1610,8 @@ precision (see Table above).
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgf3dcbb2" class="outline-4">
|
||||
<h4 id="orgf3dcbb2"><span class="section-number-4">3.2.2</span> Fortran templates for front end</h4>
|
||||
<div id="outline-container-org3de94c3" class="outline-4">
|
||||
<h4 id="org3de94c3"><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 Fortran.
|
||||
@ -1697,8 +1697,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgbbfaaf5" class="outline-3">
|
||||
<h3 id="orgbbfaaf5"><span class="section-number-3">3.3</span> Templates for front end has/read/write a dataset of numerical data</h3>
|
||||
<div id="outline-container-org3159753" class="outline-3">
|
||||
<h3 id="org3159753"><span class="section-number-3">3.3</span> Templates for front end has/read/write a dataset of numerical data</h3>
|
||||
<div class="outline-text-3" id="text-3-3">
|
||||
<p>
|
||||
This section concerns API calls related to datasets.
|
||||
@ -1767,8 +1767,8 @@ This section concerns API calls related to datasets.
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgbf9ee71" class="outline-4">
|
||||
<h4 id="orgbf9ee71"><span class="section-number-4">3.3.1</span> C templates for front end</h4>
|
||||
<div id="outline-container-org323de15" class="outline-4">
|
||||
<h4 id="org323de15"><span class="section-number-4">3.3.1</span> C templates for front end</h4>
|
||||
<div class="outline-text-4" id="text-3-3-1">
|
||||
<p>
|
||||
The C templates that correspond to each of the abovementioned functions can be found below.
|
||||
@ -2087,8 +2087,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org4df451d" class="outline-4">
|
||||
<h4 id="org4df451d"><span class="section-number-4">3.3.2</span> Fortran templates for front end</h4>
|
||||
<div id="outline-container-orgf704e07" class="outline-4">
|
||||
<h4 id="orgf704e07"><span class="section-number-4">3.3.2</span> Fortran templates for front end</h4>
|
||||
<div class="outline-text-4" id="text-3-3-2">
|
||||
<p>
|
||||
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
|
||||
@ -2174,8 +2174,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org4514b6b" class="outline-3">
|
||||
<h3 id="org4514b6b"><span class="section-number-3">3.4</span> Sparse data structures</h3>
|
||||
<div id="outline-container-org8d62996" class="outline-3">
|
||||
<h3 id="org8d62996"><span class="section-number-3">3.4</span> Sparse data structures</h3>
|
||||
<div class="outline-text-3" id="text-3-4">
|
||||
<p>
|
||||
Sparse data structures are used typically for large tensors such as
|
||||
@ -2316,12 +2316,12 @@ For the values,
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgb3d5357" class="outline-3">
|
||||
<h3 id="orgb3d5357"><span class="section-number-3">3.5</span> Templates for front end has/read/write a dataset of strings</h3>
|
||||
<div id="outline-container-org830963a" class="outline-3">
|
||||
<h3 id="org830963a"><span class="section-number-3">3.5</span> Templates for front end has/read/write a dataset of strings</h3>
|
||||
<div class="outline-text-3" id="text-3-5">
|
||||
</div>
|
||||
<div id="outline-container-org33162ff" class="outline-4">
|
||||
<h4 id="org33162ff"><span class="section-number-4">3.5.1</span> Introduction</h4>
|
||||
<div id="outline-container-org124e041" class="outline-4">
|
||||
<h4 id="org124e041"><span class="section-number-4">3.5.1</span> Introduction</h4>
|
||||
<div class="outline-text-4" id="text-3-5-1">
|
||||
<p>
|
||||
This section concerns API calls related to datasets of strings.
|
||||
@ -2361,8 +2361,8 @@ This section concerns API calls related to datasets of strings.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgbb52ee9" class="outline-4">
|
||||
<h4 id="orgbb52ee9"><span class="section-number-4">3.5.2</span> C templates for front end</h4>
|
||||
<div id="outline-container-org8f0c674" class="outline-4">
|
||||
<h4 id="org8f0c674"><span class="section-number-4">3.5.2</span> C templates for front end</h4>
|
||||
<div class="outline-text-4" id="text-3-5-2">
|
||||
<p>
|
||||
First parameter is the <code>TREXIO</code> file handle. Second parameter is the variable to be written/read
|
||||
@ -2605,8 +2605,8 @@ to/from the <code>TREXIO</code> file (except for <code>trexio_has_</code> functi
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orga35d58c" class="outline-4">
|
||||
<h4 id="orga35d58c"><span class="section-number-4">3.5.3</span> Fortran templates for front end</h4>
|
||||
<div id="outline-container-org802b1d0" class="outline-4">
|
||||
<h4 id="org802b1d0"><span class="section-number-4">3.5.3</span> Fortran templates for front end</h4>
|
||||
<div class="outline-text-4" id="text-3-5-3">
|
||||
<p>
|
||||
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
|
||||
@ -2703,12 +2703,12 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org769408d" class="outline-3">
|
||||
<h3 id="org769408d"><span class="section-number-3">3.6</span> Templates for front end has/read/write a single string attribute</h3>
|
||||
<div id="outline-container-org4c0b439" class="outline-3">
|
||||
<h3 id="org4c0b439"><span class="section-number-3">3.6</span> Templates for front end has/read/write a single string attribute</h3>
|
||||
<div class="outline-text-3" id="text-3-6">
|
||||
</div>
|
||||
<div id="outline-container-org4529784" class="outline-4">
|
||||
<h4 id="org4529784"><span class="section-number-4">3.6.1</span> Introduction</h4>
|
||||
<div id="outline-container-org70c0913" class="outline-4">
|
||||
<h4 id="org70c0913"><span class="section-number-4">3.6.1</span> Introduction</h4>
|
||||
<div class="outline-text-4" id="text-3-6-1">
|
||||
<p>
|
||||
This section concerns API calls related to string attributes.
|
||||
@ -2748,8 +2748,8 @@ This section concerns API calls related to string attributes.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org25a72a6" class="outline-4">
|
||||
<h4 id="org25a72a6"><span class="section-number-4">3.6.2</span> C templates for front end</h4>
|
||||
<div id="outline-container-org4f1d779" class="outline-4">
|
||||
<h4 id="org4f1d779"><span class="section-number-4">3.6.2</span> C templates for front end</h4>
|
||||
<div class="outline-text-4" id="text-3-6-2">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||
@ -2849,8 +2849,8 @@ This section concerns API calls related to string attributes.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgcf7769a" class="outline-4">
|
||||
<h4 id="orgcf7769a"><span class="section-number-4">3.6.3</span> Fortran templates for front end</h4>
|
||||
<div id="outline-container-orga4f1e9a" class="outline-4">
|
||||
<h4 id="orga4f1e9a"><span class="section-number-4">3.6.3</span> Fortran templates for front end</h4>
|
||||
<div class="outline-text-4" id="text-3-6-3">
|
||||
<p>
|
||||
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
|
||||
@ -2929,8 +2929,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgaf1b95c" class="outline-2">
|
||||
<h2 id="orgaf1b95c"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
|
||||
<div id="outline-container-org1f166fd" class="outline-2">
|
||||
<h2 id="org1f166fd"><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.
|
||||
@ -3064,7 +3064,7 @@ two code are identical, i.e. if the <code>assert</code> statement pass.
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX-CoE</p>
|
||||
<p class="date">Created: 2021-06-17 Thu 18:22</p>
|
||||
<p class="date">Created: 2021-06-18 Fri 10:04</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-06-17 Thu 18:22 -->
|
||||
<!-- 2021-06-18 Fri 10:04 -->
|
||||
<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,27 +311,27 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#org3a7523b">1. HDF5 back end</a>
|
||||
<li><a href="#org58b2a19">1. HDF5 back end</a>
|
||||
<ul>
|
||||
<li><a href="#org0eb0b29">1.1. Template for HDF5 definitions</a></li>
|
||||
<li><a href="#org95194a5">1.2. Template for HDF5 structures</a></li>
|
||||
<li><a href="#orgd014710">1.3. Template for HDF5 init/deinit</a></li>
|
||||
<li><a href="#org636cda6">1.4. Template for HDF5 has/read/write a single dimensioning variable</a></li>
|
||||
<li><a href="#org3209b69">1.5. Template for HDF5 has/read/write a dataset of numerical data</a></li>
|
||||
<li><a href="#org5bce6dc">1.6. Template for HDF5 has/read/write a dataset of strings</a></li>
|
||||
<li><a href="#orga2b3e61">1.7. Template for HDF5 has/read/write a single string attribute</a></li>
|
||||
<li><a href="#org301730b">1.1. Template for HDF5 definitions</a></li>
|
||||
<li><a href="#org59abb7b">1.2. Template for HDF5 structures</a></li>
|
||||
<li><a href="#org6f3ebe3">1.3. Template for HDF5 init/deinit</a></li>
|
||||
<li><a href="#org98fc37b">1.4. Template for HDF5 has/read/write a single dimensioning variable</a></li>
|
||||
<li><a href="#org75fb682">1.5. Template for HDF5 has/read/write a dataset of numerical data</a></li>
|
||||
<li><a href="#org487efb2">1.6. Template for HDF5 has/read/write a dataset of strings</a></li>
|
||||
<li><a href="#org32dc3e9">1.7. Template for HDF5 has/read/write a single string attribute</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org3a7523b" class="outline-2">
|
||||
<h2 id="org3a7523b"><span class="section-number-2">1</span> HDF5 back end</h2>
|
||||
<div id="outline-container-org58b2a19" class="outline-2">
|
||||
<h2 id="org58b2a19"><span class="section-number-2">1</span> HDF5 back end</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
</div>
|
||||
<div id="outline-container-org0eb0b29" class="outline-3">
|
||||
<h3 id="org0eb0b29"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
|
||||
<div id="outline-container-org301730b" class="outline-3">
|
||||
<h3 id="org301730b"><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>
|
||||
@ -343,8 +343,8 @@ for the JavaScript code in this tag.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org95194a5" class="outline-3">
|
||||
<h3 id="org95194a5"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
|
||||
<div id="outline-container-org59abb7b" class="outline-3">
|
||||
<h3 id="org59abb7b"><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> {
|
||||
@ -359,8 +359,8 @@ for the JavaScript code in this tag.
|
||||
</div>
|
||||
|
||||
|
||||
<div id="outline-container-orgd014710" class="outline-3">
|
||||
<h3 id="orgd014710"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
|
||||
<div id="outline-container-org6f3ebe3" class="outline-3">
|
||||
<h3 id="org6f3ebe3"><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-org636cda6" class="outline-3">
|
||||
<h3 id="org636cda6"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a single dimensioning variable</h3>
|
||||
<div id="outline-container-org98fc37b" class="outline-3">
|
||||
<h3 id="org98fc37b"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write a single dimensioning variable</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>
|
||||
@ -566,8 +566,8 @@ for the JavaScript code in this tag.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org3209b69" class="outline-3">
|
||||
<h3 id="org3209b69"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset of numerical data</h3>
|
||||
<div id="outline-container-org75fb682" class="outline-3">
|
||||
<h3 id="org75fb682"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write a dataset of numerical data</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,8 +696,8 @@ for the JavaScript code in this tag.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org5bce6dc" class="outline-3">
|
||||
<h3 id="org5bce6dc"><span class="section-number-3">1.6</span> Template for HDF5 has/read/write a dataset of strings</h3>
|
||||
<div id="outline-container-org487efb2" class="outline-3">
|
||||
<h3 id="org487efb2"><span class="section-number-3">1.6</span> Template for HDF5 has/read/write a dataset of strings</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>
|
||||
@ -901,8 +901,8 @@ for the JavaScript code in this tag.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orga2b3e61" class="outline-3">
|
||||
<h3 id="orga2b3e61"><span class="section-number-3">1.7</span> Template for HDF5 has/read/write a single string attribute</h3>
|
||||
<div id="outline-container-org32dc3e9" class="outline-3">
|
||||
<h3 id="org32dc3e9"><span class="section-number-3">1.7</span> Template for HDF5 has/read/write a single string attribute</h3>
|
||||
<div class="outline-text-3" id="text-1-7">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||
@ -1029,7 +1029,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-06-17 Thu 18:22</p>
|
||||
<p class="date">Created: 2021-06-18 Fri 10:04</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-06-17 Thu 18:22 -->
|
||||
<!-- 2021-06-18 Fri 10:05 -->
|
||||
<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,26 +311,26 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#org87b11f3">1. TEXT back end</a>
|
||||
<li><a href="#orgdf79856">1. TEXT back end</a>
|
||||
<ul>
|
||||
<li><a href="#org86c30de">1.1. Template for group-related structures in text back end</a></li>
|
||||
<li><a href="#org6411735">1.2. Template for general structure in text back end</a></li>
|
||||
<li><a href="#orgd9177b4">1.3. Initialize function (constant part)</a></li>
|
||||
<li><a href="#org4621877">1.4. Deinitialize function (templated part)</a></li>
|
||||
<li><a href="#org8a1cc92">1.5. Template for text read struct</a></li>
|
||||
<li><a href="#orgfe96112">1.6. Template for text flush struct</a></li>
|
||||
<li><a href="#orgc286c62">1.7. Template for text free memory</a></li>
|
||||
<li><a href="#org9eefc4d">1.8. Template for has/read/write the num attribute</a></li>
|
||||
<li><a href="#org0d6bbe5">1.9. Template for has/read/write the dataset of numerical data</a></li>
|
||||
<li><a href="#orgecfdcfb">1.10. Template for has/read/write the dataset of strings</a></li>
|
||||
<li><a href="#org16d48f9">1.11. Template for has/read/write the string attribute</a></li>
|
||||
<li><a href="#org60d63e1">1.12. RDM struct (hard-coded)</a>
|
||||
<li><a href="#org38975b9">1.1. Template for group-related structures in text back end</a></li>
|
||||
<li><a href="#org0dc01fc">1.2. Template for general structure in text back end</a></li>
|
||||
<li><a href="#orgd16dd13">1.3. Initialize function (constant part)</a></li>
|
||||
<li><a href="#org31b7171">1.4. Deinitialize function (templated part)</a></li>
|
||||
<li><a href="#org29bac34">1.5. Template for text read struct</a></li>
|
||||
<li><a href="#orgd2f9f6c">1.6. Template for text flush struct</a></li>
|
||||
<li><a href="#org2ce5b90">1.7. Template for text free memory</a></li>
|
||||
<li><a href="#orga1fd5df">1.8. Template for has/read/write the num attribute</a></li>
|
||||
<li><a href="#orga0a720b">1.9. Template for has/read/write the dataset of numerical data</a></li>
|
||||
<li><a href="#org097178e">1.10. Template for has/read/write the dataset of strings</a></li>
|
||||
<li><a href="#org2f6e53c">1.11. Template for has/read/write the string attribute</a></li>
|
||||
<li><a href="#org9ad8a6c">1.12. RDM struct (hard-coded)</a>
|
||||
<ul>
|
||||
<li><a href="#org52d30d3">1.12.1. Read the complete struct</a></li>
|
||||
<li><a href="#org13f16e0">1.12.2. Flush the complete struct</a></li>
|
||||
<li><a href="#orge552ee7">1.12.3. Free memory</a></li>
|
||||
<li><a href="#org9d5477a">1.12.4. Read/Write the one<sub>e</sub> attribute</a></li>
|
||||
<li><a href="#org02372f0">1.12.5. Read/Write the two<sub>e</sub> attribute</a></li>
|
||||
<li><a href="#org430cee5">1.12.1. Read the complete struct</a></li>
|
||||
<li><a href="#org8f15c39">1.12.2. Flush the complete struct</a></li>
|
||||
<li><a href="#org934750d">1.12.3. Free memory</a></li>
|
||||
<li><a href="#orgfb7bc52">1.12.4. Read/Write the one<sub>e</sub> attribute</a></li>
|
||||
<li><a href="#orgb095233">1.12.5. Read/Write the two<sub>e</sub> attribute</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -339,8 +339,8 @@ for the JavaScript code in this tag.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org87b11f3" class="outline-2">
|
||||
<h2 id="org87b11f3"><span class="section-number-2">1</span> TEXT back end</h2>
|
||||
<div id="outline-container-orgdf79856" class="outline-2">
|
||||
<h2 id="orgdf79856"><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
|
||||
@ -361,8 +361,8 @@ The file is written when closed, or when the flush function is called.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org86c30de" class="outline-3">
|
||||
<h3 id="org86c30de"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
|
||||
<div id="outline-container-org38975b9" class="outline-3">
|
||||
<h3 id="org38975b9"><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 {
|
||||
@ -380,8 +380,8 @@ The file is written when closed, or when the flush function is called.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org6411735" class="outline-3">
|
||||
<h3 id="org6411735"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
|
||||
<div id="outline-container-org0dc01fc" class="outline-3">
|
||||
<h3 id="org0dc01fc"><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> {
|
||||
@ -407,8 +407,8 @@ The file is written when closed, or when the flush function is called.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgd9177b4" class="outline-3">
|
||||
<h3 id="orgd9177b4"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
|
||||
<div id="outline-container-orgd16dd13" class="outline-3">
|
||||
<h3 id="orgd16dd13"><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-org4621877" class="outline-3">
|
||||
<h3 id="org4621877"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
|
||||
<div id="outline-container-org31b7171" class="outline-3">
|
||||
<h3 id="org31b7171"><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>
|
||||
@ -535,8 +535,8 @@ The file is written when closed, or when the flush function is called.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org8a1cc92" class="outline-3">
|
||||
<h3 id="org8a1cc92"><span class="section-number-3">1.5</span> Template for text read struct</h3>
|
||||
<div id="outline-container-org29bac34" class="outline-3">
|
||||
<h3 id="org29bac34"><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*
|
||||
@ -807,8 +807,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgfe96112" class="outline-3">
|
||||
<h3 id="orgfe96112"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
|
||||
<div id="outline-container-orgd2f9f6c" class="outline-3">
|
||||
<h3 id="orgd2f9f6c"><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>
|
||||
@ -872,8 +872,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgc286c62" class="outline-3">
|
||||
<h3 id="orgc286c62"><span class="section-number-3">1.7</span> Template for text free memory</h3>
|
||||
<div id="outline-container-org2ce5b90" class="outline-3">
|
||||
<h3 id="org2ce5b90"><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.
|
||||
@ -918,8 +918,8 @@ Memory is allocated when reading. The following function frees memory.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org9eefc4d" class="outline-3">
|
||||
<h3 id="org9eefc4d"><span class="section-number-3">1.8</span> Template for has/read/write the num attribute</h3>
|
||||
<div id="outline-container-orga1fd5df" class="outline-3">
|
||||
<h3 id="orga1fd5df"><span class="section-number-3">1.8</span> Template for has/read/write the num 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>
|
||||
@ -981,8 +981,8 @@ Memory is allocated when reading. The following function frees memory.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org0d6bbe5" class="outline-3">
|
||||
<h3 id="org0d6bbe5"><span class="section-number-3">1.9</span> Template for has/read/write the dataset of numerical data</h3>
|
||||
<div id="outline-container-orga0a720b" class="outline-3">
|
||||
<h3 id="orga0a720b"><span class="section-number-3">1.9</span> Template for has/read/write the dataset of numerical data</h3>
|
||||
<div class="outline-text-3" id="text-1-9">
|
||||
<p>
|
||||
The <code>group_dset</code> array is assumed allocated with the appropriate size.
|
||||
@ -1078,8 +1078,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgecfdcfb" class="outline-3">
|
||||
<h3 id="orgecfdcfb"><span class="section-number-3">1.10</span> Template for has/read/write the dataset of strings</h3>
|
||||
<div id="outline-container-org097178e" class="outline-3">
|
||||
<h3 id="org097178e"><span class="section-number-3">1.10</span> Template for has/read/write the dataset of strings</h3>
|
||||
<div class="outline-text-3" id="text-1-10">
|
||||
<p>
|
||||
The <code>group_dset</code> array is assumed allocated with the appropriate size.
|
||||
@ -1181,8 +1181,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org16d48f9" class="outline-3">
|
||||
<h3 id="org16d48f9"><span class="section-number-3">1.11</span> Template for has/read/write the string attribute</h3>
|
||||
<div id="outline-container-org2f6e53c" class="outline-3">
|
||||
<h3 id="org2f6e53c"><span class="section-number-3">1.11</span> Template for has/read/write the string attribute</h3>
|
||||
<div class="outline-text-3" id="text-1-11">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||
@ -1256,12 +1256,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org60d63e1" class="outline-3">
|
||||
<h3 id="org60d63e1"><span class="section-number-3">1.12</span> RDM struct (hard-coded)</h3>
|
||||
<div id="outline-container-org9ad8a6c" class="outline-3">
|
||||
<h3 id="org9ad8a6c"><span class="section-number-3">1.12</span> RDM struct (hard-coded)</h3>
|
||||
<div class="outline-text-3" id="text-1-12">
|
||||
</div>
|
||||
<div id="outline-container-org52d30d3" class="outline-4">
|
||||
<h4 id="org52d30d3"><span class="section-number-4">1.12.1</span> Read the complete struct</h4>
|
||||
<div id="outline-container-org430cee5" class="outline-4">
|
||||
<h4 id="org430cee5"><span class="section-number-4">1.12.1</span> Read the complete struct</h4>
|
||||
<div class="outline-text-4" id="text-1-12-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>);
|
||||
@ -1356,8 +1356,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org13f16e0" class="outline-4">
|
||||
<h4 id="org13f16e0"><span class="section-number-4">1.12.2</span> Flush the complete struct</h4>
|
||||
<div id="outline-container-org8f15c39" class="outline-4">
|
||||
<h4 id="org8f15c39"><span class="section-number-4">1.12.2</span> Flush the complete struct</h4>
|
||||
<div class="outline-text-4" id="text-1-12-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>);
|
||||
@ -1399,8 +1399,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orge552ee7" class="outline-4">
|
||||
<h4 id="orge552ee7"><span class="section-number-4">1.12.3</span> Free memory</h4>
|
||||
<div id="outline-container-org934750d" class="outline-4">
|
||||
<h4 id="org934750d"><span class="section-number-4">1.12.3</span> Free memory</h4>
|
||||
<div class="outline-text-4" id="text-1-12-3">
|
||||
<p>
|
||||
Memory is allocated when reading. The followig function frees memory.
|
||||
@ -1436,8 +1436,8 @@ Memory is allocated when reading. The followig function frees memory.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org9d5477a" class="outline-4">
|
||||
<h4 id="org9d5477a"><span class="section-number-4">1.12.4</span> Read/Write the one<sub>e</sub> attribute</h4>
|
||||
<div id="outline-container-orgfb7bc52" class="outline-4">
|
||||
<h4 id="orgfb7bc52"><span class="section-number-4">1.12.4</span> Read/Write the one<sub>e</sub> attribute</h4>
|
||||
<div class="outline-text-4" id="text-1-12-4">
|
||||
<p>
|
||||
The <code>one_e</code> array is assumed allocated with the appropriate size.
|
||||
@ -1503,8 +1503,8 @@ The <code>one_e</code> array is assumed allocated with the appropriate size.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org02372f0" class="outline-4">
|
||||
<h4 id="org02372f0"><span class="section-number-4">1.12.5</span> Read/Write the two<sub>e</sub> attribute</h4>
|
||||
<div id="outline-container-orgb095233" class="outline-4">
|
||||
<h4 id="orgb095233"><span class="section-number-4">1.12.5</span> Read/Write the two<sub>e</sub> attribute</h4>
|
||||
<div class="outline-text-4" id="text-1-12-5">
|
||||
<p>
|
||||
<code>two_e</code> is a sparse data structure, which can be too large to fit
|
||||
@ -1612,7 +1612,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-06-17 Thu 18:22</p>
|
||||
<p class="date">Created: 2021-06-18 Fri 10:05</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