mirror of
https://github.com/TREX-CoE/qmckl.git
synced 2024-08-24 22:21:46 +02:00
Deploying to gh-pages from @ TREX-CoE/qmckl@0fdaea77c9 🚀
This commit is contained in:
parent
a86d236cf8
commit
b8391b11c2
@ -3,7 +3,7 @@
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2021-05-12 Wed 11:34 -->
|
||||
<!-- 2021-05-12 Wed 11:36 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>QMCkl source code documentation</title>
|
||||
@ -349,7 +349,7 @@ and bug reports should be submitted at
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:34</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:36</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
102
qmckl.html
102
qmckl.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-05-12 Wed 11:34 -->
|
||||
<!-- 2021-05-12 Wed 11:36 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Introduction</title>
|
||||
@ -333,30 +333,30 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#orge57cbd0">1. Using QMCkl</a></li>
|
||||
<li><a href="#orgfedd3dd">2. Developing in QMCkl</a>
|
||||
<li><a href="#org8eccd0a">1. Using QMCkl</a></li>
|
||||
<li><a href="#org410d1a1">2. Developing in QMCkl</a>
|
||||
<ul>
|
||||
<li><a href="#org0ffab7f">2.1. Literate programming</a></li>
|
||||
<li><a href="#orgb55c8f6">2.2. Source code editing</a></li>
|
||||
<li><a href="#orge5e61b6">2.3. Choice of the programming language</a></li>
|
||||
<li><a href="#orgd85cd4d">2.4. Coding rules</a></li>
|
||||
<li><a href="#orgd1c6d26">2.5. Design of the library</a></li>
|
||||
<li><a href="#orgf10ff55">2.6. Naming conventions</a></li>
|
||||
<li><a href="#org149fc25">2.7. Application programming interface</a></li>
|
||||
<li><a href="#org91c7f76">2.8. Global state</a></li>
|
||||
<li><a href="#orgb575232">2.9. Headers</a></li>
|
||||
<li><a href="#org7e91d10">2.10. Low-level functions</a></li>
|
||||
<li><a href="#org2135a33">2.11. High-level functions</a></li>
|
||||
<li><a href="#org9247815">2.12. Numerical precision</a></li>
|
||||
<li><a href="#org92eb8c9">2.13. Algorithms</a></li>
|
||||
<li><a href="#orgac51fb3">2.1. Literate programming</a></li>
|
||||
<li><a href="#org56c3822">2.2. Source code editing</a></li>
|
||||
<li><a href="#orgdd42802">2.3. Choice of the programming language</a></li>
|
||||
<li><a href="#orgb14b210">2.4. Coding rules</a></li>
|
||||
<li><a href="#org081a9c4">2.5. Design of the library</a></li>
|
||||
<li><a href="#org9384ce3">2.6. Naming conventions</a></li>
|
||||
<li><a href="#org51e30f2">2.7. Application programming interface</a></li>
|
||||
<li><a href="#org711376d">2.8. Global state</a></li>
|
||||
<li><a href="#orgbd676e2">2.9. Headers</a></li>
|
||||
<li><a href="#org885606b">2.10. Low-level functions</a></li>
|
||||
<li><a href="#org203574d">2.11. High-level functions</a></li>
|
||||
<li><a href="#orgb8a051b">2.12. Numerical precision</a></li>
|
||||
<li><a href="#orgd688d1f">2.13. Algorithms</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orge57cbd0" class="outline-2">
|
||||
<h2 id="orge57cbd0"><span class="section-number-2">1</span> Using QMCkl</h2>
|
||||
<div id="outline-container-org8eccd0a" class="outline-2">
|
||||
<h2 id="org8eccd0a"><span class="section-number-2">1</span> Using QMCkl</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
<p>
|
||||
The <code>qmckl.h</code> header file installed in the <code>${prefix}/include</code> directory
|
||||
@ -385,12 +385,12 @@ Both files are located in the <code>include/</code> directory.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgfedd3dd" class="outline-2">
|
||||
<h2 id="orgfedd3dd"><span class="section-number-2">2</span> Developing in QMCkl</h2>
|
||||
<div id="outline-container-org410d1a1" class="outline-2">
|
||||
<h2 id="org410d1a1"><span class="section-number-2">2</span> Developing in QMCkl</h2>
|
||||
<div class="outline-text-2" id="text-2">
|
||||
</div>
|
||||
<div id="outline-container-org0ffab7f" class="outline-3">
|
||||
<h3 id="org0ffab7f"><span class="section-number-3">2.1</span> Literate programming</h3>
|
||||
<div id="outline-container-orgac51fb3" class="outline-3">
|
||||
<h3 id="orgac51fb3"><span class="section-number-3">2.1</span> Literate programming</h3>
|
||||
<div class="outline-text-3" id="text-2-1">
|
||||
<p>
|
||||
In a traditional source code, most of the lines of source files of a program
|
||||
@ -435,8 +435,8 @@ interactively, in the same spirit as Jupyter notebooks.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgb55c8f6" class="outline-3">
|
||||
<h3 id="orgb55c8f6"><span class="section-number-3">2.2</span> Source code editing</h3>
|
||||
<div id="outline-container-org56c3822" class="outline-3">
|
||||
<h3 id="org56c3822"><span class="section-number-3">2.2</span> Source code editing</h3>
|
||||
<div class="outline-text-3" id="text-2-2">
|
||||
<p>
|
||||
For a tutorial on literate programming with org-mode, follow <a href="http://www.howardism.org/Technical/Emacs/literate-programming-tutorial.html">this link</a>.
|
||||
@ -467,8 +467,8 @@ org-mode.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orge5e61b6" class="outline-3">
|
||||
<h3 id="orge5e61b6"><span class="section-number-3">2.3</span> Choice of the programming language</h3>
|
||||
<div id="outline-container-orgdd42802" class="outline-3">
|
||||
<h3 id="orgdd42802"><span class="section-number-3">2.3</span> Choice of the programming language</h3>
|
||||
<div class="outline-text-3" id="text-2-3">
|
||||
<p>
|
||||
Most of the codes of the <a href="https://trex-coe.eu">TREX CoE</a> are written in Fortran with some scripts in
|
||||
@ -516,8 +516,8 @@ For more guidelines on using Fortran to generate a C interface, see
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgd85cd4d" class="outline-3">
|
||||
<h3 id="orgd85cd4d"><span class="section-number-3">2.4</span> Coding rules</h3>
|
||||
<div id="outline-container-orgb14b210" class="outline-3">
|
||||
<h3 id="orgb14b210"><span class="section-number-3">2.4</span> Coding rules</h3>
|
||||
<div class="outline-text-3" id="text-2-4">
|
||||
<p>
|
||||
The authors should follow the recommendations of the C99
|
||||
@ -535,8 +535,8 @@ Compliance can be checked with <code>cppcheck</code> as:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgd1c6d26" class="outline-3">
|
||||
<h3 id="orgd1c6d26"><span class="section-number-3">2.5</span> Design of the library</h3>
|
||||
<div id="outline-container-org081a9c4" class="outline-3">
|
||||
<h3 id="org081a9c4"><span class="section-number-3">2.5</span> Design of the library</h3>
|
||||
<div class="outline-text-3" id="text-2-5">
|
||||
<p>
|
||||
The proposed API should allow the library to: deal with memory transfers
|
||||
@ -547,8 +547,8 @@ functions (see below).
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgf10ff55" class="outline-3">
|
||||
<h3 id="orgf10ff55"><span class="section-number-3">2.6</span> Naming conventions</h3>
|
||||
<div id="outline-container-org9384ce3" class="outline-3">
|
||||
<h3 id="org9384ce3"><span class="section-number-3">2.6</span> Naming conventions</h3>
|
||||
<div class="outline-text-3" id="text-2-6">
|
||||
<p>
|
||||
To avoid namespace collisions, we use <code>qmckl_</code> as a prefix for all exported
|
||||
@ -573,8 +573,8 @@ form is allowed.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org149fc25" class="outline-3">
|
||||
<h3 id="org149fc25"><span class="section-number-3">2.7</span> Application programming interface</h3>
|
||||
<div id="outline-container-org51e30f2" class="outline-3">
|
||||
<h3 id="org51e30f2"><span class="section-number-3">2.7</span> Application programming interface</h3>
|
||||
<div class="outline-text-3" id="text-2-7">
|
||||
<p>
|
||||
In the C language, the number of bits used by the integer types can change
|
||||
@ -606,15 +606,15 @@ bindings in other languages in other repositories.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org91c7f76" class="outline-3">
|
||||
<h3 id="org91c7f76"><span class="section-number-3">2.8</span> Global state</h3>
|
||||
<div id="outline-container-org711376d" class="outline-3">
|
||||
<h3 id="org711376d"><span class="section-number-3">2.8</span> Global state</h3>
|
||||
<div class="outline-text-3" id="text-2-8">
|
||||
<p>
|
||||
Global variables should be avoided in the library, because it is
|
||||
possible that one single program needs to use multiple instances
|
||||
of the library. To solve this problem we propose to use a pointer
|
||||
to a <a href="./qmckl_context.html"><code>context</code></a> variable, built by the library with the
|
||||
<code>qmckl_context_create</code> function. The <a id="org2e6e721">=context=</a> contains the global
|
||||
<code>qmckl_context_create</code> function. The <a id="org3978403">=context=</a> contains the global
|
||||
state of the library, and is used as the first argument of many
|
||||
QMCkl functions.
|
||||
</p>
|
||||
@ -628,8 +628,8 @@ the state is done by setters and getters, prefixed by
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgb575232" class="outline-3">
|
||||
<h3 id="orgb575232"><span class="section-number-3">2.9</span> Headers</h3>
|
||||
<div id="outline-container-orgbd676e2" class="outline-3">
|
||||
<h3 id="orgbd676e2"><span class="section-number-3">2.9</span> Headers</h3>
|
||||
<div class="outline-text-3" id="text-2-9">
|
||||
<p>
|
||||
A single <code>qmckl.h</code> header to be distributed by the library
|
||||
@ -717,8 +717,8 @@ and the types definitions should be written in the <code>*_f_type.f90</code> fil
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org7e91d10" class="outline-3">
|
||||
<h3 id="org7e91d10"><span class="section-number-3">2.10</span> Low-level functions</h3>
|
||||
<div id="outline-container-org885606b" class="outline-3">
|
||||
<h3 id="org885606b"><span class="section-number-3">2.10</span> Low-level functions</h3>
|
||||
<div class="outline-text-3" id="text-2-10">
|
||||
<p>
|
||||
Low-level functions are very simple functions which are leaves of
|
||||
@ -727,14 +727,14 @@ the function call tree (they don't call any other QMCkl function).
|
||||
|
||||
<p>
|
||||
These functions are <i>pure</i>, and unaware of the QMCkl
|
||||
<a href="#org2e6e721"><code>context</code></a>. They are not allowed to allocate/deallocate memory, and
|
||||
<a href="#org3978403"><code>context</code></a>. They are not allowed to allocate/deallocate memory, and
|
||||
if they need temporary memory it should be provided in input.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org2135a33" class="outline-3">
|
||||
<h3 id="org2135a33"><span class="section-number-3">2.11</span> High-level functions</h3>
|
||||
<div id="outline-container-org203574d" class="outline-3">
|
||||
<h3 id="org203574d"><span class="section-number-3">2.11</span> High-level functions</h3>
|
||||
<div class="outline-text-3" id="text-2-11">
|
||||
<p>
|
||||
High-level functions are at the top of the function call tree.
|
||||
@ -747,27 +747,27 @@ temporary storage, to simplify the use of accelerators.
|
||||
<p>
|
||||
The high-level functions should be pure, unless the introduction
|
||||
of non-purity is justified. All the side effects should be made in
|
||||
the <a href="#org2e6e721"><code>context</code></a> variable.
|
||||
the <a href="#org3978403"><code>context</code></a> variable.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org9247815" class="outline-3">
|
||||
<h3 id="org9247815"><span class="section-number-3">2.12</span> Numerical precision</h3>
|
||||
<div id="outline-container-orgb8a051b" class="outline-3">
|
||||
<h3 id="orgb8a051b"><span class="section-number-3">2.12</span> Numerical precision</h3>
|
||||
<div class="outline-text-3" id="text-2-12">
|
||||
<p>
|
||||
The number of bits of precision required for a function should be
|
||||
given as an input of low-level computational functions. This input
|
||||
will be used to define the values of the different thresholds that
|
||||
might be used to avoid computing unnecessary noise. High-level
|
||||
functions will use the precision specified in the <a href="#org2e6e721"><code>context</code></a>
|
||||
functions will use the precision specified in the <a href="#org3978403"><code>context</code></a>
|
||||
variable.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org92eb8c9" class="outline-3">
|
||||
<h3 id="org92eb8c9"><span class="section-number-3">2.13</span> Algorithms</h3>
|
||||
<div id="outline-container-orgd688d1f" class="outline-3">
|
||||
<h3 id="orgd688d1f"><span class="section-number-3">2.13</span> Algorithms</h3>
|
||||
<div class="outline-text-3" id="text-2-13">
|
||||
<p>
|
||||
Reducing the scaling of an algorithm usually implies also reducing
|
||||
@ -783,7 +783,7 @@ implemented adapted to different problem sizes.
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:34</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:36</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
|
158
qmckl_ao.html
158
qmckl_ao.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-05-12 Wed 11:34 -->
|
||||
<!-- 2021-05-12 Wed 11:36 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Atomic Orbitals</title>
|
||||
@ -333,52 +333,52 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#orgb2edaed">1. Context</a>
|
||||
<li><a href="#orgc435561">1. Context</a>
|
||||
<ul>
|
||||
<li><a href="#org921ef5c">1.1. Data structure</a></li>
|
||||
<li><a href="#orge5920ba">1.2. Access functions</a></li>
|
||||
<li><a href="#org9ed660f">1.3. Initialization functions</a></li>
|
||||
<li><a href="#org756b02d">1.4. <span class="todo TODO">TODO</span> Fortran interfaces</a></li>
|
||||
<li><a href="#orgd1ee43a">1.1. Data structure</a></li>
|
||||
<li><a href="#org328391a">1.2. Access functions</a></li>
|
||||
<li><a href="#org4af9a4f">1.3. Initialization functions</a></li>
|
||||
<li><a href="#orgc77e497">1.4. <span class="todo TODO">TODO</span> Fortran interfaces</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org6906822">2. Polynomial part</a>
|
||||
<li><a href="#orgbfacbc7">2. Polynomial part</a>
|
||||
<ul>
|
||||
<li><a href="#org2bc7c60">2.1. Powers of \(x-X_i\)</a>
|
||||
<li><a href="#org3cc2016">2.1. Powers of \(x-X_i\)</a>
|
||||
<ul>
|
||||
<li><a href="#org210cbff">2.1.1. Requirements</a></li>
|
||||
<li><a href="#org38b61ae">2.1.2. C Header</a></li>
|
||||
<li><a href="#org97df755">2.1.3. Source</a></li>
|
||||
<li><a href="#orgf5251da">2.1.4. C interface</a></li>
|
||||
<li><a href="#org2828065">2.1.5. Fortran interface</a></li>
|
||||
<li><a href="#org0941834">2.1.6. Test</a></li>
|
||||
<li><a href="#org07b94a9">2.1.1. Requirements</a></li>
|
||||
<li><a href="#org81f7169">2.1.2. C Header</a></li>
|
||||
<li><a href="#org4806167">2.1.3. Source</a></li>
|
||||
<li><a href="#orgbfe1d06">2.1.4. C interface</a></li>
|
||||
<li><a href="#orgdccb434">2.1.5. Fortran interface</a></li>
|
||||
<li><a href="#orge93d74b">2.1.6. Test</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org8c88edc">2.2. Value, Gradient and Laplacian of a polynomial</a>
|
||||
<li><a href="#orga6c97a8">2.2. Value, Gradient and Laplacian of a polynomial</a>
|
||||
<ul>
|
||||
<li><a href="#org2ad2400">2.2.1. Requirements</a></li>
|
||||
<li><a href="#org4b39792">2.2.2. C Header</a></li>
|
||||
<li><a href="#org9ae932b">2.2.3. Source</a></li>
|
||||
<li><a href="#orgb39630d">2.2.4. C interface</a></li>
|
||||
<li><a href="#org66e4184">2.2.5. Fortran interface</a></li>
|
||||
<li><a href="#org62766ac">2.2.6. Test</a></li>
|
||||
<li><a href="#orgf75e531">2.2.1. Requirements</a></li>
|
||||
<li><a href="#org179849c">2.2.2. C Header</a></li>
|
||||
<li><a href="#orga14bfe2">2.2.3. Source</a></li>
|
||||
<li><a href="#org6917b93">2.2.4. C interface</a></li>
|
||||
<li><a href="#org52590ec">2.2.5. Fortran interface</a></li>
|
||||
<li><a href="#orgf7c7f9d">2.2.6. Test</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org4db8815">3. Radial part</a>
|
||||
<li><a href="#org271a2d1">3. Radial part</a>
|
||||
<ul>
|
||||
<li><a href="#orgbffae1f">3.1. Gaussian basis functions</a></li>
|
||||
<li><a href="#org08e83b2">3.2. <span class="todo TODO">TODO</span> Slater basis functions</a></li>
|
||||
<li><a href="#org749337d">3.3. <span class="todo TODO">TODO</span> Radial functions on a grid</a></li>
|
||||
<li><a href="#org368ecd9">3.1. Gaussian basis functions</a></li>
|
||||
<li><a href="#org138390e">3.2. <span class="todo TODO">TODO</span> Slater basis functions</a></li>
|
||||
<li><a href="#org7b2449d">3.3. <span class="todo TODO">TODO</span> Radial functions on a grid</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org319d48a">4. Combining radial and polynomial parts</a></li>
|
||||
<li><a href="#org6c1ac5a">4. Combining radial and polynomial parts</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgb2edaed" class="outline-2">
|
||||
<h2 id="orgb2edaed"><span class="section-number-2">1</span> Context</h2>
|
||||
<div id="outline-container-orgc435561" class="outline-2">
|
||||
<h2 id="orgc435561"><span class="section-number-2">1</span> Context</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
<p>
|
||||
The following arrays are stored in the context:
|
||||
@ -503,8 +503,8 @@ coefficient = [ 0.006068, 0.045308, 0.202822, 0.503903, 0.383421,
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org921ef5c" class="outline-3">
|
||||
<h3 id="org921ef5c"><span class="section-number-3">1.1</span> Data structure</h3>
|
||||
<div id="outline-container-orgd1ee43a" class="outline-3">
|
||||
<h3 id="orgd1ee43a"><span class="section-number-3">1.1</span> Data structure</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> <span style="color: #228b22;">qmckl_ao_basis_struct</span> {
|
||||
@ -533,8 +533,8 @@ struct is then initialized and <code>provided == true</code>.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orge5920ba" class="outline-3">
|
||||
<h3 id="orge5920ba"><span class="section-number-3">1.2</span> Access functions</h3>
|
||||
<div id="outline-container-org328391a" class="outline-3">
|
||||
<h3 id="org328391a"><span class="section-number-3">1.2</span> Access functions</h3>
|
||||
<div class="outline-text-3" id="text-1-2">
|
||||
<p>
|
||||
When all the data for the AOs have been provided, the following
|
||||
@ -548,8 +548,8 @@ function returns <code>true</code>.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org9ed660f" class="outline-3">
|
||||
<h3 id="org9ed660f"><span class="section-number-3">1.3</span> Initialization functions</h3>
|
||||
<div id="outline-container-org4af9a4f" class="outline-3">
|
||||
<h3 id="org4af9a4f"><span class="section-number-3">1.3</span> Initialization functions</h3>
|
||||
<div class="outline-text-3" id="text-1-3">
|
||||
<p>
|
||||
To set the basis set, all the following functions need to be
|
||||
@ -572,17 +572,17 @@ called. When
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org756b02d" class="outline-3">
|
||||
<h3 id="org756b02d"><span class="section-number-3">1.4</span> <span class="todo TODO">TODO</span> Fortran interfaces</h3>
|
||||
<div id="outline-container-orgc77e497" class="outline-3">
|
||||
<h3 id="orgc77e497"><span class="section-number-3">1.4</span> <span class="todo TODO">TODO</span> Fortran interfaces</h3>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org6906822" class="outline-2">
|
||||
<h2 id="org6906822"><span class="section-number-2">2</span> Polynomial part</h2>
|
||||
<div id="outline-container-orgbfacbc7" class="outline-2">
|
||||
<h2 id="orgbfacbc7"><span class="section-number-2">2</span> Polynomial part</h2>
|
||||
<div class="outline-text-2" id="text-2">
|
||||
</div>
|
||||
<div id="outline-container-org2bc7c60" class="outline-3">
|
||||
<h3 id="org2bc7c60"><span class="section-number-3">2.1</span> Powers of \(x-X_i\)</h3>
|
||||
<div id="outline-container-org3cc2016" class="outline-3">
|
||||
<h3 id="org3cc2016"><span class="section-number-3">2.1</span> Powers of \(x-X_i\)</h3>
|
||||
<div class="outline-text-3" id="text-2-1">
|
||||
<p>
|
||||
The <code>qmckl_ao_power</code> function computes all the powers of the <code>n</code>
|
||||
@ -594,7 +594,7 @@ the \(n\) points:
|
||||
\[ P_{ik} = X_i^k \]
|
||||
</p>
|
||||
|
||||
<table id="org01b288f" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
<table id="org6ea2dfb" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
|
||||
|
||||
<colgroup>
|
||||
@ -652,8 +652,8 @@ the \(n\) points:
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org210cbff" class="outline-4">
|
||||
<h4 id="org210cbff"><span class="section-number-4">2.1.1</span> Requirements</h4>
|
||||
<div id="outline-container-org07b94a9" class="outline-4">
|
||||
<h4 id="org07b94a9"><span class="section-number-4">2.1.1</span> Requirements</h4>
|
||||
<div class="outline-text-4" id="text-2-1-1">
|
||||
<ul class="org-ul">
|
||||
<li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li>
|
||||
@ -666,8 +666,8 @@ the \(n\) points:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org38b61ae" class="outline-4">
|
||||
<h4 id="org38b61ae"><span class="section-number-4">2.1.2</span> C Header</h4>
|
||||
<div id="outline-container-org81f7169" class="outline-4">
|
||||
<h4 id="org81f7169"><span class="section-number-4">2.1.2</span> C Header</h4>
|
||||
<div class="outline-text-4" id="text-2-1-2">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_ao_power</span> (
|
||||
@ -682,8 +682,8 @@ the \(n\) points:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org97df755" class="outline-4">
|
||||
<h4 id="org97df755"><span class="section-number-4">2.1.3</span> Source</h4>
|
||||
<div id="outline-container-org4806167" class="outline-4">
|
||||
<h4 id="org4806167"><span class="section-number-4">2.1.3</span> Source</h4>
|
||||
<div class="outline-text-4" id="text-2-1-3">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-f90"><span style="color: #228b22;">integer </span><span style="color: #a020f0;">function</span><span style="color: #a0522d;"> </span><span style="color: #0000ff;">qmckl_ao_power_f</span><span style="color: #000000; background-color: #ffffff;">(context, n, X, LMAX, P, ldp) result(info)</span>
|
||||
@ -734,15 +734,15 @@ the \(n\) points:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgf5251da" class="outline-4">
|
||||
<h4 id="orgf5251da"><span class="section-number-4">2.1.4</span> C interface</h4>
|
||||
<div id="outline-container-orgbfe1d06" class="outline-4">
|
||||
<h4 id="orgbfe1d06"><span class="section-number-4">2.1.4</span> C interface</h4>
|
||||
</div>
|
||||
<div id="outline-container-org2828065" class="outline-4">
|
||||
<h4 id="org2828065"><span class="section-number-4">2.1.5</span> Fortran interface</h4>
|
||||
<div id="outline-container-orgdccb434" class="outline-4">
|
||||
<h4 id="orgdccb434"><span class="section-number-4">2.1.5</span> Fortran interface</h4>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org0941834" class="outline-4">
|
||||
<h4 id="org0941834"><span class="section-number-4">2.1.6</span> Test</h4>
|
||||
<div id="outline-container-orge93d74b" class="outline-4">
|
||||
<h4 id="orge93d74b"><span class="section-number-4">2.1.6</span> Test</h4>
|
||||
<div class="outline-text-4" id="text-2-1-6">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-f90"><span style="color: #228b22;">integer</span>(<span style="color: #008b8b;">c_int32_t</span>) <span style="color: #a020f0;">function</span> <span style="color: #0000ff;">test_qmckl_ao_power</span>(context) <span style="color: #a020f0;">bind</span>(C)
|
||||
@ -793,8 +793,8 @@ the \(n\) points:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org8c88edc" class="outline-3">
|
||||
<h3 id="org8c88edc"><span class="section-number-3">2.2</span> Value, Gradient and Laplacian of a polynomial</h3>
|
||||
<div id="outline-container-orga6c97a8" class="outline-3">
|
||||
<h3 id="orga6c97a8"><span class="section-number-3">2.2</span> Value, Gradient and Laplacian of a polynomial</h3>
|
||||
<div class="outline-text-3" id="text-2-2">
|
||||
<p>
|
||||
A polynomial is centered on a nucleus \(\mathbf{R}_i\)
|
||||
@ -839,7 +839,7 @@ Laplacians at a given point in space, of all polynomials with an
|
||||
angular momentum up to <code>lmax</code>.
|
||||
</p>
|
||||
|
||||
<table id="orge08d1fc" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
<table id="orgd18a481" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
|
||||
|
||||
<colgroup>
|
||||
@ -918,8 +918,8 @@ angular momentum up to <code>lmax</code>.
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org2ad2400" class="outline-4">
|
||||
<h4 id="org2ad2400"><span class="section-number-4">2.2.1</span> Requirements</h4>
|
||||
<div id="outline-container-orgf75e531" class="outline-4">
|
||||
<h4 id="orgf75e531"><span class="section-number-4">2.2.1</span> Requirements</h4>
|
||||
<div class="outline-text-4" id="text-2-2-1">
|
||||
<ul class="org-ul">
|
||||
<li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li>
|
||||
@ -944,8 +944,8 @@ For example, with a=0, b=2 and c=1 the string is "yyz"</li>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org4b39792" class="outline-4">
|
||||
<h4 id="org4b39792"><span class="section-number-4">2.2.2</span> C Header</h4>
|
||||
<div id="outline-container-org179849c" class="outline-4">
|
||||
<h4 id="org179849c"><span class="section-number-4">2.2.2</span> C Header</h4>
|
||||
<div class="outline-text-4" id="text-2-2-2">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_ao_polynomial_vgl</span> (
|
||||
@ -963,8 +963,8 @@ For example, with a=0, b=2 and c=1 the string is "yyz"</li>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org9ae932b" class="outline-4">
|
||||
<h4 id="org9ae932b"><span class="section-number-4">2.2.3</span> Source</h4>
|
||||
<div id="outline-container-orga14bfe2" class="outline-4">
|
||||
<h4 id="orga14bfe2"><span class="section-number-4">2.2.3</span> Source</h4>
|
||||
<div class="outline-text-4" id="text-2-2-3">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-f90"><span style="color: #228b22;">integer </span><span style="color: #a020f0;">function</span><span style="color: #a0522d;"> </span><span style="color: #0000ff;">qmckl_ao_polynomial_vgl_f</span><span style="color: #000000; background-color: #ffffff;">(context, X, R, lmax, n, L, ldl, VGL, ldv) result(info)</span>
|
||||
@ -1099,16 +1099,16 @@ For example, with a=0, b=2 and c=1 the string is "yyz"</li>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgb39630d" class="outline-4">
|
||||
<h4 id="orgb39630d"><span class="section-number-4">2.2.4</span> C interface</h4>
|
||||
<div id="outline-container-org6917b93" class="outline-4">
|
||||
<h4 id="org6917b93"><span class="section-number-4">2.2.4</span> C interface</h4>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org66e4184" class="outline-4">
|
||||
<h4 id="org66e4184"><span class="section-number-4">2.2.5</span> Fortran interface</h4>
|
||||
<div id="outline-container-org52590ec" class="outline-4">
|
||||
<h4 id="org52590ec"><span class="section-number-4">2.2.5</span> Fortran interface</h4>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org62766ac" class="outline-4">
|
||||
<h4 id="org62766ac"><span class="section-number-4">2.2.6</span> Test</h4>
|
||||
<div id="outline-container-orgf7c7f9d" class="outline-4">
|
||||
<h4 id="orgf7c7f9d"><span class="section-number-4">2.2.6</span> Test</h4>
|
||||
<div class="outline-text-4" id="text-2-2-6">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-f90"><span style="color: #228b22;">integer</span>(<span style="color: #008b8b;">c_int32_t</span>) <span style="color: #a020f0;">function</span> <span style="color: #0000ff;">test_qmckl_ao_polynomial_vgl</span>(context) <span style="color: #a020f0;">bind</span>(C)
|
||||
@ -1213,12 +1213,12 @@ assert(0 == test_qmckl_ao_polynomial_vgl(context));
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org4db8815" class="outline-2">
|
||||
<h2 id="org4db8815"><span class="section-number-2">3</span> Radial part</h2>
|
||||
<div id="outline-container-org271a2d1" class="outline-2">
|
||||
<h2 id="org271a2d1"><span class="section-number-2">3</span> Radial part</h2>
|
||||
<div class="outline-text-2" id="text-3">
|
||||
</div>
|
||||
<div id="outline-container-orgbffae1f" class="outline-3">
|
||||
<h3 id="orgbffae1f"><span class="section-number-3">3.1</span> Gaussian basis functions</h3>
|
||||
<div id="outline-container-org368ecd9" class="outline-3">
|
||||
<h3 id="org368ecd9"><span class="section-number-3">3.1</span> Gaussian basis functions</h3>
|
||||
<div class="outline-text-3" id="text-3-1">
|
||||
<p>
|
||||
<code>qmckl_ao_gaussian_vgl</code> computes the values, gradients and
|
||||
@ -1450,21 +1450,21 @@ Requirements
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org08e83b2" class="outline-3">
|
||||
<h3 id="org08e83b2"><span class="section-number-3">3.2</span> <span class="todo TODO">TODO</span> Slater basis functions</h3>
|
||||
<div id="outline-container-org138390e" class="outline-3">
|
||||
<h3 id="org138390e"><span class="section-number-3">3.2</span> <span class="todo TODO">TODO</span> Slater basis functions</h3>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org749337d" class="outline-3">
|
||||
<h3 id="org749337d"><span class="section-number-3">3.3</span> <span class="todo TODO">TODO</span> Radial functions on a grid</h3>
|
||||
<div id="outline-container-org7b2449d" class="outline-3">
|
||||
<h3 id="org7b2449d"><span class="section-number-3">3.3</span> <span class="todo TODO">TODO</span> Radial functions on a grid</h3>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org319d48a" class="outline-2">
|
||||
<h2 id="org319d48a"><span class="section-number-2">4</span> Combining radial and polynomial parts</h2>
|
||||
<div id="outline-container-org6c1ac5a" class="outline-2">
|
||||
<h2 id="org6c1ac5a"><span class="section-number-2">4</span> Combining radial and polynomial parts</h2>
|
||||
</div>
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:34</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:36</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-05-12 Wed 11:34 -->
|
||||
<!-- 2021-05-12 Wed 11:36 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Context</title>
|
||||
@ -311,21 +311,21 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#org3a86872">1. Context handling</a>
|
||||
<li><a href="#org45dd6f0">1. Context handling</a>
|
||||
<ul>
|
||||
<li><a href="#org21c34d0">1.1. Data structure</a></li>
|
||||
<li><a href="#orgeec0cf8">1.2. Creation</a></li>
|
||||
<li><a href="#orgcfdc2e0">1.3. Locking</a></li>
|
||||
<li><a href="#orgbf86b3e">1.4. <span class="todo TODO">TODO</span> Copy</a></li>
|
||||
<li><a href="#org515df34">1.5. Destroy</a></li>
|
||||
<li><a href="#org98d3650">1.1. Data structure</a></li>
|
||||
<li><a href="#orgb871a4d">1.2. Creation</a></li>
|
||||
<li><a href="#orgeab3960">1.3. Locking</a></li>
|
||||
<li><a href="#org9bd3c29">1.4. <span class="todo TODO">TODO</span> Copy</a></li>
|
||||
<li><a href="#org7a0a00c">1.5. Destroy</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org3a86872" class="outline-2">
|
||||
<h2 id="org3a86872"><span class="section-number-2">1</span> Context handling</h2>
|
||||
<div id="outline-container-org45dd6f0" class="outline-2">
|
||||
<h2 id="org45dd6f0"><span class="section-number-2">1</span> Context handling</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
<p>
|
||||
The context variable is a handle for the state of the library,
|
||||
@ -338,7 +338,7 @@ A value of <code>QMCKL_NULL_CONTEXT</code> for the context is equivalent to a
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c" id="orgf54c688"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int64_t</span> <span style="color: #228b22;">qmckl_context</span> ;
|
||||
<pre class="src src-c" id="org5866dac"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int64_t</span> <span style="color: #228b22;">qmckl_context</span> ;
|
||||
<span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">QMCKL_NULL_CONTEXT</span> (qmckl_context) 0
|
||||
</pre>
|
||||
</div>
|
||||
@ -356,8 +356,8 @@ and <code>ctx</code> is a <code>qmckl_context_struct*</code> pointer.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org21c34d0" class="outline-3">
|
||||
<h3 id="org21c34d0"><span class="section-number-3">1.1</span> Data structure</h3>
|
||||
<div id="outline-container-org98d3650" class="outline-3">
|
||||
<h3 id="org98d3650"><span class="section-number-3">1.1</span> Data structure</h3>
|
||||
<div class="outline-text-3" id="text-1-1">
|
||||
<p>
|
||||
The context keeps a ``date'' that allows to check which data needs
|
||||
@ -367,7 +367,7 @@ coordinates are updated.
|
||||
|
||||
<p>
|
||||
When a new element is added to the context, the functions
|
||||
<a href="#orgeec0cf8">qmckl<sub>context</sub><sub>create</sub></a>, <a href="#org515df34">qmckl<sub>context</sub><sub>destroy</sub></a> and <a href="#orgbf86b3e">qmckl<sub>context</sub><sub>copy</sub></a>
|
||||
<a href="#orgb871a4d">qmckl<sub>context</sub><sub>create</sub></a>, <a href="#org7a0a00c">qmckl<sub>context</sub><sub>destroy</sub></a> and <a href="#org9bd3c29">qmckl<sub>context</sub><sub>copy</sub></a>
|
||||
should be updated inorder to make deep copies.
|
||||
</p>
|
||||
|
||||
@ -416,8 +416,8 @@ if the context is valid, <code>QMCKL_NULL_CONTEXT</code> otherwise.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgeec0cf8" class="outline-3">
|
||||
<h3 id="orgeec0cf8"><span class="section-number-3">1.2</span> Creation</h3>
|
||||
<div id="outline-container-orgb871a4d" class="outline-3">
|
||||
<h3 id="orgb871a4d"><span class="section-number-3">1.2</span> Creation</h3>
|
||||
<div class="outline-text-3" id="text-1-2">
|
||||
<p>
|
||||
To create a new context, <code>qmckl_context_create()</code> should be used.
|
||||
@ -491,8 +491,8 @@ To create a new context, <code>qmckl_context_create()</code> should be used.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgcfdc2e0" class="outline-3">
|
||||
<h3 id="orgcfdc2e0"><span class="section-number-3">1.3</span> Locking</h3>
|
||||
<div id="outline-container-orgeab3960" class="outline-3">
|
||||
<h3 id="orgeab3960"><span class="section-number-3">1.3</span> Locking</h3>
|
||||
<div class="outline-text-3" id="text-1-3">
|
||||
<p>
|
||||
For thread safety, the context may be locked/unlocked. The lock is
|
||||
@ -537,8 +537,8 @@ number of times the thread has locked it is saved in the
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgbf86b3e" class="outline-3">
|
||||
<h3 id="orgbf86b3e"><span class="section-number-3">1.4</span> <span class="todo TODO">TODO</span> Copy</h3>
|
||||
<div id="outline-container-org9bd3c29" class="outline-3">
|
||||
<h3 id="org9bd3c29"><span class="section-number-3">1.4</span> <span class="todo TODO">TODO</span> Copy</h3>
|
||||
<div class="outline-text-3" id="text-1-4">
|
||||
<p>
|
||||
<code>qmckl_context_copy</code> makes a deep copy of a context. It returns
|
||||
@ -586,8 +586,8 @@ number of times the thread has locked it is saved in the
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org515df34" class="outline-3">
|
||||
<h3 id="org515df34"><span class="section-number-3">1.5</span> Destroy</h3>
|
||||
<div id="outline-container-org7a0a00c" class="outline-3">
|
||||
<h3 id="org7a0a00c"><span class="section-number-3">1.5</span> Destroy</h3>
|
||||
<div class="outline-text-3" id="text-1-5">
|
||||
<p>
|
||||
The context is destroyed with <code>qmckl_context_destroy</code>, leaving the ancestors untouched.
|
||||
@ -641,7 +641,7 @@ It frees the context, and returns the previous context.
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:34</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:36</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-05-12 Wed 11:34 -->
|
||||
<!-- 2021-05-12 Wed 11:36 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Inter-particle distances</title>
|
||||
@ -333,26 +333,26 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#orgfef530d">1. Squared distance</a>
|
||||
<li><a href="#org91fd63f">1. Squared distance</a>
|
||||
<ul>
|
||||
<li><a href="#orgefeed54">1.1. <code>qmckl_distance_sq</code></a>
|
||||
<li><a href="#org37097b4">1.1. <code>qmckl_distance_sq</code></a>
|
||||
<ul>
|
||||
<li><a href="#orgaa28e7f">1.1.1. Requirements</a></li>
|
||||
<li><a href="#orgffb0613">1.1.2. C header</a></li>
|
||||
<li><a href="#org064489a">1.1.3. Source</a></li>
|
||||
<li><a href="#orgcdff290">1.1.4. Performance</a></li>
|
||||
<li><a href="#org424d82e">1.1.1. Requirements</a></li>
|
||||
<li><a href="#orga108749">1.1.2. C header</a></li>
|
||||
<li><a href="#orgf753379">1.1.3. Source</a></li>
|
||||
<li><a href="#org07649f2">1.1.4. Performance</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org9d397b9">2. Distance</a>
|
||||
<li><a href="#orgc38e19d">2. Distance</a>
|
||||
<ul>
|
||||
<li><a href="#orgc395b93">2.1. <code>qmckl_distance</code></a>
|
||||
<li><a href="#orgda3d043">2.1. <code>qmckl_distance</code></a>
|
||||
<ul>
|
||||
<li><a href="#orgbbcfaac">2.1.1. Requirements</a></li>
|
||||
<li><a href="#org4d2cd7a">2.1.2. C header</a></li>
|
||||
<li><a href="#orgbb8f3d8">2.1.3. Source</a></li>
|
||||
<li><a href="#org88b4c99">2.1.4. Performance</a></li>
|
||||
<li><a href="#org15d5960">2.1.1. Requirements</a></li>
|
||||
<li><a href="#org7d200cd">2.1.2. C header</a></li>
|
||||
<li><a href="#org5c6205c">2.1.3. Source</a></li>
|
||||
<li><a href="#orgfc19386">2.1.4. Performance</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -361,12 +361,12 @@ for the JavaScript code in this tag.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgfef530d" class="outline-2">
|
||||
<h2 id="orgfef530d"><span class="section-number-2">1</span> Squared distance</h2>
|
||||
<div id="outline-container-org91fd63f" class="outline-2">
|
||||
<h2 id="org91fd63f"><span class="section-number-2">1</span> Squared distance</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
</div>
|
||||
<div id="outline-container-orgefeed54" class="outline-3">
|
||||
<h3 id="orgefeed54"><span class="section-number-3">1.1</span> <code>qmckl_distance_sq</code></h3>
|
||||
<div id="outline-container-org37097b4" class="outline-3">
|
||||
<h3 id="org37097b4"><span class="section-number-3">1.1</span> <code>qmckl_distance_sq</code></h3>
|
||||
<div class="outline-text-3" id="text-1-1">
|
||||
<p>
|
||||
<code>qmckl_distance_sq</code> computes the matrix of the squared distances
|
||||
@ -379,7 +379,7 @@ between all pairs of points in two sets, one point within each set:
|
||||
\]
|
||||
</p>
|
||||
|
||||
<table id="org4c2b24b" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
<table id="orgd7d7f59" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
|
||||
|
||||
<colgroup>
|
||||
@ -472,8 +472,8 @@ between all pairs of points in two sets, one point within each set:
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgaa28e7f" class="outline-4">
|
||||
<h4 id="orgaa28e7f"><span class="section-number-4">1.1.1</span> Requirements</h4>
|
||||
<div id="outline-container-org424d82e" class="outline-4">
|
||||
<h4 id="org424d82e"><span class="section-number-4">1.1.1</span> Requirements</h4>
|
||||
<div class="outline-text-4" id="text-1-1-1">
|
||||
<ul class="org-ul">
|
||||
<li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li>
|
||||
@ -491,8 +491,8 @@ between all pairs of points in two sets, one point within each set:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgffb0613" class="outline-4">
|
||||
<h4 id="orgffb0613"><span class="section-number-4">1.1.2</span> C header</h4>
|
||||
<div id="outline-container-orga108749" class="outline-4">
|
||||
<h4 id="orga108749"><span class="section-number-4">1.1.2</span> C header</h4>
|
||||
<div class="outline-text-4" id="text-1-1-2">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_distance</span> (
|
||||
@ -512,8 +512,8 @@ between all pairs of points in two sets, one point within each set:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org064489a" class="outline-4">
|
||||
<h4 id="org064489a"><span class="section-number-4">1.1.3</span> Source</h4>
|
||||
<div id="outline-container-orgf753379" class="outline-4">
|
||||
<h4 id="orgf753379"><span class="section-number-4">1.1.3</span> Source</h4>
|
||||
<div class="outline-text-4" id="text-1-1-3">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-f90"><span style="color: #228b22;">integer</span><span style="color: #a0522d;"> function qmckl_distance_sq_f(context, transa, transb, m, n, </span><span style="color: #a020f0;">&</span>
|
||||
@ -648,8 +648,8 @@ between all pairs of points in two sets, one point within each set:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgcdff290" class="outline-4">
|
||||
<h4 id="orgcdff290"><span class="section-number-4">1.1.4</span> Performance</h4>
|
||||
<div id="outline-container-org07649f2" class="outline-4">
|
||||
<h4 id="org07649f2"><span class="section-number-4">1.1.4</span> Performance</h4>
|
||||
<div class="outline-text-4" id="text-1-1-4">
|
||||
<p>
|
||||
This function might be more efficient when <code>A</code> and <code>B</code> are
|
||||
@ -659,12 +659,12 @@ transposed.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-org9d397b9" class="outline-2">
|
||||
<h2 id="org9d397b9"><span class="section-number-2">2</span> Distance</h2>
|
||||
<div id="outline-container-orgc38e19d" class="outline-2">
|
||||
<h2 id="orgc38e19d"><span class="section-number-2">2</span> Distance</h2>
|
||||
<div class="outline-text-2" id="text-2">
|
||||
</div>
|
||||
<div id="outline-container-orgc395b93" class="outline-3">
|
||||
<h3 id="orgc395b93"><span class="section-number-3">2.1</span> <code>qmckl_distance</code></h3>
|
||||
<div id="outline-container-orgda3d043" class="outline-3">
|
||||
<h3 id="orgda3d043"><span class="section-number-3">2.1</span> <code>qmckl_distance</code></h3>
|
||||
<div class="outline-text-3" id="text-2-1">
|
||||
<p>
|
||||
<code>qmckl_distance</code> computes the matrix of the distances between all
|
||||
@ -677,7 +677,7 @@ pairs of points in two sets, one point within each set:
|
||||
\]
|
||||
</p>
|
||||
|
||||
<table id="orge74f018" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
<table id="org8952ca9" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
|
||||
|
||||
<colgroup>
|
||||
@ -770,8 +770,8 @@ pairs of points in two sets, one point within each set:
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgbbcfaac" class="outline-4">
|
||||
<h4 id="orgbbcfaac"><span class="section-number-4">2.1.1</span> Requirements</h4>
|
||||
<div id="outline-container-org15d5960" class="outline-4">
|
||||
<h4 id="org15d5960"><span class="section-number-4">2.1.1</span> Requirements</h4>
|
||||
<div class="outline-text-4" id="text-2-1-1">
|
||||
<ul class="org-ul">
|
||||
<li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li>
|
||||
@ -789,8 +789,8 @@ pairs of points in two sets, one point within each set:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org4d2cd7a" class="outline-4">
|
||||
<h4 id="org4d2cd7a"><span class="section-number-4">2.1.2</span> C header</h4>
|
||||
<div id="outline-container-org7d200cd" class="outline-4">
|
||||
<h4 id="org7d200cd"><span class="section-number-4">2.1.2</span> C header</h4>
|
||||
<div class="outline-text-4" id="text-2-1-2">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_distance</span> (
|
||||
@ -810,8 +810,8 @@ pairs of points in two sets, one point within each set:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgbb8f3d8" class="outline-4">
|
||||
<h4 id="orgbb8f3d8"><span class="section-number-4">2.1.3</span> Source</h4>
|
||||
<div id="outline-container-org5c6205c" class="outline-4">
|
||||
<h4 id="org5c6205c"><span class="section-number-4">2.1.3</span> Source</h4>
|
||||
<div class="outline-text-4" id="text-2-1-3">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-f90"><span style="color: #228b22;">integer</span><span style="color: #a0522d;"> function qmckl_distance_f(context, transa, transb, m, n, </span><span style="color: #a020f0;">&</span>
|
||||
@ -950,8 +950,8 @@ pairs of points in two sets, one point within each set:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org88b4c99" class="outline-4">
|
||||
<h4 id="org88b4c99"><span class="section-number-4">2.1.4</span> Performance</h4>
|
||||
<div id="outline-container-orgfc19386" class="outline-4">
|
||||
<h4 id="orgfc19386"><span class="section-number-4">2.1.4</span> Performance</h4>
|
||||
<div class="outline-text-4" id="text-2-1-4">
|
||||
<p>
|
||||
This function might be more efficient when <code>A</code> and <code>B</code> are
|
||||
@ -964,7 +964,7 @@ transposed.
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:34</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:36</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-05-12 Wed 11:34 -->
|
||||
<!-- 2021-05-12 Wed 11:36 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Electrons</title>
|
||||
@ -311,21 +311,21 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#org798dd9f">1. Context</a>
|
||||
<li><a href="#orgbaa50bd">1. Context</a>
|
||||
<ul>
|
||||
<li><a href="#org843350f">1.1. Data structure</a></li>
|
||||
<li><a href="#orga788a23">1.2. Access functions</a></li>
|
||||
<li><a href="#org8b8b33a">1.3. Initialization functions</a></li>
|
||||
<li><a href="#org80e2260">1.4. Test</a></li>
|
||||
<li><a href="#org46990a2">1.1. Data structure</a></li>
|
||||
<li><a href="#org76eec9e">1.2. Access functions</a></li>
|
||||
<li><a href="#org061a196">1.3. Initialization functions</a></li>
|
||||
<li><a href="#orgf332b4e">1.4. Test</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#org463bf89">2. Computation</a>
|
||||
<li><a href="#orgeaad2fe">2. Computation</a>
|
||||
<ul>
|
||||
<li><a href="#org3fbcc48">2.1. Electron-electron distances</a>
|
||||
<li><a href="#org3b7ed02">2.1. Electron-electron distances</a>
|
||||
<ul>
|
||||
<li><a href="#org502bf94">2.1.1. Get</a></li>
|
||||
<li><a href="#orgf437932">2.1.2. Compute</a></li>
|
||||
<li><a href="#orgd47f48b">2.1.3. Test</a></li>
|
||||
<li><a href="#orgb46b687">2.1.1. Get</a></li>
|
||||
<li><a href="#org04737a1">2.1.2. Compute</a></li>
|
||||
<li><a href="#org6520f49">2.1.3. Test</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -334,8 +334,8 @@ for the JavaScript code in this tag.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org798dd9f" class="outline-2">
|
||||
<h2 id="org798dd9f"><span class="section-number-2">1</span> Context</h2>
|
||||
<div id="outline-container-orgbaa50bd" class="outline-2">
|
||||
<h2 id="orgbaa50bd"><span class="section-number-2">1</span> Context</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
<p>
|
||||
The following data stored in the context:
|
||||
@ -421,8 +421,8 @@ The following data stored in the context:
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org843350f" class="outline-3">
|
||||
<h3 id="org843350f"><span class="section-number-3">1.1</span> Data structure</h3>
|
||||
<div id="outline-container-org46990a2" class="outline-3">
|
||||
<h3 id="org46990a2"><span class="section-number-3">1.1</span> Data structure</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> <span style="color: #228b22;">qmckl_electron_struct</span> {
|
||||
@ -450,8 +450,8 @@ struct is then initialized and <code>provided == true</code>.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orga788a23" class="outline-3">
|
||||
<h3 id="orga788a23"><span class="section-number-3">1.2</span> Access functions</h3>
|
||||
<div id="outline-container-org76eec9e" class="outline-3">
|
||||
<h3 id="org76eec9e"><span class="section-number-3">1.2</span> Access functions</h3>
|
||||
<div class="outline-text-3" id="text-1-2">
|
||||
<p>
|
||||
When all the data relative to electrons have been set, the
|
||||
@ -465,8 +465,8 @@ following function returns <code>true</code>.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org8b8b33a" class="outline-3">
|
||||
<h3 id="org8b8b33a"><span class="section-number-3">1.3</span> Initialization functions</h3>
|
||||
<div id="outline-container-org061a196" class="outline-3">
|
||||
<h3 id="org061a196"><span class="section-number-3">1.3</span> Initialization functions</h3>
|
||||
<div class="outline-text-3" id="text-1-3">
|
||||
<p>
|
||||
To set the data relative to the electrons in the context, the
|
||||
@ -496,8 +496,8 @@ electrons have been set.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org80e2260" class="outline-3">
|
||||
<h3 id="org80e2260"><span class="section-number-3">1.4</span> Test</h3>
|
||||
<div id="outline-container-orgf332b4e" class="outline-3">
|
||||
<h3 id="orgf332b4e"><span class="section-number-3">1.4</span> Test</h3>
|
||||
<div class="outline-text-3" id="text-1-4">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c">/* <span style="color: #b22222;">Reference input data </span>*/
|
||||
@ -542,8 +542,8 @@ rc = qmckl_set_electron_coord (context, coord);
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org463bf89" class="outline-2">
|
||||
<h2 id="org463bf89"><span class="section-number-2">2</span> Computation</h2>
|
||||
<div id="outline-container-orgeaad2fe" class="outline-2">
|
||||
<h2 id="orgeaad2fe"><span class="section-number-2">2</span> Computation</h2>
|
||||
<div class="outline-text-2" id="text-2">
|
||||
<p>
|
||||
The computed data is stored in the context so that it can be reused
|
||||
@ -556,12 +556,12 @@ current date is stored.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org3fbcc48" class="outline-3">
|
||||
<h3 id="org3fbcc48"><span class="section-number-3">2.1</span> Electron-electron distances</h3>
|
||||
<div id="outline-container-org3b7ed02" class="outline-3">
|
||||
<h3 id="org3b7ed02"><span class="section-number-3">2.1</span> Electron-electron distances</h3>
|
||||
<div class="outline-text-3" id="text-2-1">
|
||||
</div>
|
||||
<div id="outline-container-org502bf94" class="outline-4">
|
||||
<h4 id="org502bf94"><span class="section-number-4">2.1.1</span> Get</h4>
|
||||
<div id="outline-container-orgb46b687" class="outline-4">
|
||||
<h4 id="orgb46b687"><span class="section-number-4">2.1.1</span> Get</h4>
|
||||
<div class="outline-text-4" id="text-2-1-1">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c"><span style="color: #228b22;">qmckl_exit_code</span> <span style="color: #0000ff;">qmckl_get_electron_ee_distance</span>(<span style="color: #228b22;">qmckl_context</span> <span style="color: #a0522d;">context</span>, <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">distance</span>);
|
||||
@ -570,10 +570,10 @@ current date is stored.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgf437932" class="outline-4">
|
||||
<h4 id="orgf437932"><span class="section-number-4">2.1.2</span> Compute</h4>
|
||||
<div id="outline-container-org04737a1" class="outline-4">
|
||||
<h4 id="org04737a1"><span class="section-number-4">2.1.2</span> Compute</h4>
|
||||
<div class="outline-text-4" id="text-2-1-2">
|
||||
<table id="orgc25d793" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
<table id="org0bc40f3" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
|
||||
|
||||
<colgroup>
|
||||
@ -670,8 +670,8 @@ current date is stored.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgd47f48b" class="outline-4">
|
||||
<h4 id="orgd47f48b"><span class="section-number-4">2.1.3</span> Test</h4>
|
||||
<div id="outline-container-org6520f49" class="outline-4">
|
||||
<h4 id="org6520f49"><span class="section-number-4">2.1.3</span> Test</h4>
|
||||
<div class="outline-text-4" id="text-2-1-3">
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-c">/* <span style="color: #b22222;">Reference input data </span>*/
|
||||
@ -694,7 +694,7 @@ rc = qmckl_get_electron_ee_distance(context, distance);
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:34</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:36</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-05-12 Wed 11:34 -->
|
||||
<!-- 2021-05-12 Wed 11:36 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Error handling</title>
|
||||
@ -311,16 +311,16 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#org39537fd">1. Decoding errors</a></li>
|
||||
<li><a href="#org479e512">2. Data structure in context</a></li>
|
||||
<li><a href="#orgc0642a0">3. Updating errors in the context</a></li>
|
||||
<li><a href="#org7fcc076">4. Failing</a></li>
|
||||
<li><a href="#org9111d0c">1. Decoding errors</a></li>
|
||||
<li><a href="#org00938c7">2. Data structure in context</a></li>
|
||||
<li><a href="#org3e45d56">3. Updating errors in the context</a></li>
|
||||
<li><a href="#org9270ca3">4. Failing</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org39537fd" class="outline-2">
|
||||
<h2 id="org39537fd"><span class="section-number-2">1</span> Decoding errors</h2>
|
||||
<div id="outline-container-org9111d0c" class="outline-2">
|
||||
<h2 id="org9111d0c"><span class="section-number-2">1</span> Decoding errors</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
<p>
|
||||
To decode the error messages, <code>qmckl_string_of_error</code> converts an
|
||||
@ -414,8 +414,8 @@ The text strings are extracted from the previous table.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org479e512" class="outline-2">
|
||||
<h2 id="org479e512"><span class="section-number-2">2</span> Data structure in context</h2>
|
||||
<div id="outline-container-org00938c7" class="outline-2">
|
||||
<h2 id="org00938c7"><span class="section-number-2">2</span> Data structure in context</h2>
|
||||
<div class="outline-text-2" id="text-2">
|
||||
<p>
|
||||
The strings are declared with a maximum fixed size to avoid
|
||||
@ -438,8 +438,8 @@ dynamic memory allocation.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgc0642a0" class="outline-2">
|
||||
<h2 id="orgc0642a0"><span class="section-number-2">3</span> Updating errors in the context</h2>
|
||||
<div id="outline-container-org3e45d56" class="outline-2">
|
||||
<h2 id="org3e45d56"><span class="section-number-2">3</span> Updating errors in the context</h2>
|
||||
<div class="outline-text-2" id="text-3">
|
||||
<p>
|
||||
The error is updated in the context using <code>qmckl_set_error</code>.
|
||||
@ -485,8 +485,8 @@ explaining the error. The exit code can't be <code>QMCKL_SUCCESS</code>.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org7fcc076" class="outline-2">
|
||||
<h2 id="org7fcc076"><span class="section-number-2">4</span> Failing</h2>
|
||||
<div id="outline-container-org9270ca3" class="outline-2">
|
||||
<h2 id="org9270ca3"><span class="section-number-2">4</span> Failing</h2>
|
||||
<div class="outline-text-2" id="text-4">
|
||||
<p>
|
||||
To make a function fail, the <code>qmckl_failwith</code> function should be
|
||||
@ -549,7 +549,7 @@ For example, this function can be used as
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:34</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:36</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-05-12 Wed 11:34 -->
|
||||
<!-- 2021-05-12 Wed 11:36 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Memory management</title>
|
||||
@ -311,15 +311,15 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#orgb3b9eec">1. Memory data structure for the context</a></li>
|
||||
<li><a href="#orgd3df0df">2. Passing info to allocation routines</a></li>
|
||||
<li><a href="#org28dbdc5">3. Allocation/deallocation functions</a></li>
|
||||
<li><a href="#orgc07bdcc">1. Memory data structure for the context</a></li>
|
||||
<li><a href="#org90112fb">2. Passing info to allocation routines</a></li>
|
||||
<li><a href="#org38e1990">3. Allocation/deallocation functions</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgb3b9eec" class="outline-2">
|
||||
<h2 id="orgb3b9eec"><span class="section-number-2">1</span> Memory data structure for the context</h2>
|
||||
<div id="outline-container-orgc07bdcc" class="outline-2">
|
||||
<h2 id="orgc07bdcc"><span class="section-number-2">1</span> Memory data structure for the context</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
<p>
|
||||
Every time a new block of memory is allocated, the information
|
||||
@ -361,8 +361,8 @@ array, and the number of allocated blocks.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-orgd3df0df" class="outline-2">
|
||||
<h2 id="orgd3df0df"><span class="section-number-2">2</span> Passing info to allocation routines</h2>
|
||||
<div id="outline-container-org90112fb" class="outline-2">
|
||||
<h2 id="org90112fb"><span class="section-number-2">2</span> Passing info to allocation routines</h2>
|
||||
<div class="outline-text-2" id="text-2">
|
||||
<p>
|
||||
Passing information to the allocation routine should be done by
|
||||
@ -371,8 +371,8 @@ passing an instance of a <code>qmckl_memory_info_struct</code>.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org28dbdc5" class="outline-2">
|
||||
<h2 id="org28dbdc5"><span class="section-number-2">3</span> Allocation/deallocation functions</h2>
|
||||
<div id="outline-container-org38e1990" class="outline-2">
|
||||
<h2 id="org38e1990"><span class="section-number-2">3</span> Allocation/deallocation functions</h2>
|
||||
<div class="outline-text-2" id="text-3">
|
||||
<p>
|
||||
Memory allocation inside the library should be done with
|
||||
@ -535,7 +535,7 @@ allocation and needs to be updated.
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:34</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:36</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-05-12 Wed 11:34 -->
|
||||
<!-- 2021-05-12 Wed 11:36 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Numerical precision</title>
|
||||
@ -333,16 +333,16 @@ for the JavaScript code in this tag.
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#org7b0ae4b">1. Control of the numerical precision</a></li>
|
||||
<li><a href="#org945fb24">2. Precision</a></li>
|
||||
<li><a href="#org95f01f4">3. Range</a></li>
|
||||
<li><a href="#orgdd6b8d5">4. Helper functions</a></li>
|
||||
<li><a href="#org0468a8f">1. Control of the numerical precision</a></li>
|
||||
<li><a href="#org2683922">2. Precision</a></li>
|
||||
<li><a href="#org2ea288a">3. Range</a></li>
|
||||
<li><a href="#org6613bbe">4. Helper functions</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org7b0ae4b" class="outline-2">
|
||||
<h2 id="org7b0ae4b"><span class="section-number-2">1</span> Control of the numerical precision</h2>
|
||||
<div id="outline-container-org0468a8f" class="outline-2">
|
||||
<h2 id="org0468a8f"><span class="section-number-2">1</span> Control of the numerical precision</h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
<p>
|
||||
Controlling numerical precision enables optimizations. Here, the
|
||||
@ -353,7 +353,7 @@ Arithmetic (IEEE 754),
|
||||
refers to the number of exponent bits.
|
||||
</p>
|
||||
|
||||
<table id="orgef7badb" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
<table id="orgc807fa0" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
|
||||
|
||||
<colgroup>
|
||||
@ -397,8 +397,8 @@ integer. The update functions return <code>QMCKL_SUCCESS</code> or
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org945fb24" class="outline-2">
|
||||
<h2 id="org945fb24"><span class="section-number-2">2</span> Precision</h2>
|
||||
<div id="outline-container-org2683922" class="outline-2">
|
||||
<h2 id="org2683922"><span class="section-number-2">2</span> Precision</h2>
|
||||
<div class="outline-text-2" id="text-2">
|
||||
<p>
|
||||
<code>qmckl_context_set_numprec_precision</code> modifies the parameter for the
|
||||
@ -485,8 +485,8 @@ numerical precision in the context.
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-org95f01f4" class="outline-2">
|
||||
<h2 id="org95f01f4"><span class="section-number-2">3</span> Range</h2>
|
||||
<div id="outline-container-org2ea288a" class="outline-2">
|
||||
<h2 id="org2ea288a"><span class="section-number-2">3</span> Range</h2>
|
||||
<div class="outline-text-2" id="text-3">
|
||||
<p>
|
||||
<code>qmckl_set_numprec_range</code> modifies the parameter for the numerical
|
||||
@ -561,8 +561,8 @@ range in a given context.
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgdd6b8d5" class="outline-2">
|
||||
<h2 id="orgdd6b8d5"><span class="section-number-2">4</span> Helper functions</h2>
|
||||
<div id="outline-container-org6613bbe" class="outline-2">
|
||||
<h2 id="org6613bbe"><span class="section-number-2">4</span> Helper functions</h2>
|
||||
<div class="outline-text-2" id="text-4">
|
||||
<p>
|
||||
<code>qmckl_get_numprec_epsilon</code> returns \(\epsilon = 2^{1-n}\) where <code>n</code> is the precision.
|
||||
@ -581,7 +581,7 @@ We need to remove the sign bit from the precision.
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="author">Author: TREX CoE</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:34</p>
|
||||
<p class="date">Created: 2021-05-12 Wed 11:36</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