TREX/qmckl
1
0
Fork 0
mirror of https://github.com/TREX-CoE/qmckl.git synced 2024-11-03 20:54:09 +01:00
Code Issues Projects Releases Wiki Activity

Deploying to gh-pages from @ TREX-CoE/qmckl@79c9651021 🚀

Browse Source
This commit is contained in:
scemama 2021-04-28 11:31:10 +00:00
parent d6cdba390b
commit c938ea2855
11 changed files with 277 additions and 277 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.html
View File

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

4
index.html
View File

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

102
qmckl.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-04-28 Wed 10:09 --> <!-- 2021-04-28 Wed 11:30 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Introduction</title> <title>Introduction</title>
@ -333,30 +333,30 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orga58e27b">1. Using QMCkl</a></li> <li><a href="#orgb4425b2">1. Using QMCkl</a></li>
<li><a href="#org7c81d63">2. Developing in QMCkl</a> <li><a href="#org1737381">2. Developing in QMCkl</a>
<ul> <ul>
<li><a href="#org7b640a2">2.1. Literate programming</a></li> <li><a href="#org5b75e12">2.1. Literate programming</a></li>
<li><a href="#org40b0427">2.2. Source code editing</a></li> <li><a href="#org5838277">2.2. Source code editing</a></li>
<li><a href="#org3b80d53">2.3. Choice of the programming language</a></li> <li><a href="#org9bed5f7">2.3. Choice of the programming language</a></li>
<li><a href="#orgc8abe9c">2.4. Coding rules</a></li> <li><a href="#org7a97eb2">2.4. Coding rules</a></li>
<li><a href="#orgf07d9ea">2.5. Design of the library</a></li> <li><a href="#org9e047bf">2.5. Design of the library</a></li>
<li><a href="#org9097f30">2.6. Naming conventions</a></li> <li><a href="#orgd922e9c">2.6. Naming conventions</a></li>
<li><a href="#org6f73afd">2.7. Application programming interface</a></li> <li><a href="#orgdd4de4b">2.7. Application programming interface</a></li>
<li><a href="#orgb598e6b">2.8. Global state</a></li> <li><a href="#orgc4e27dc">2.8. Global state</a></li>
<li><a href="#orgf4a3994">2.9. Headers</a></li> <li><a href="#org21cbcd0">2.9. Headers</a></li>
<li><a href="#org4bca58d">2.10. Low-level functions</a></li> <li><a href="#orgfab3614">2.10. Low-level functions</a></li>
<li><a href="#org3ef5653">2.11. High-level functions</a></li> <li><a href="#org92b2c80">2.11. High-level functions</a></li>
<li><a href="#org2b8a6bd">2.12. Numerical precision</a></li> <li><a href="#org539099d">2.12. Numerical precision</a></li>
<li><a href="#orgfcb2fea">2.13. Algorithms</a></li> <li><a href="#org86e4cd8">2.13. Algorithms</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-orga58e27b" class="outline-2"> <div id="outline-container-orgb4425b2" class="outline-2">
<h2 id="orga58e27b"><span class="section-number-2">1</span> Using QMCkl</h2> <h2 id="orgb4425b2"><span class="section-number-2">1</span> Using QMCkl</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The <code>qmckl.h</code> header file installed in the <code>${prefix}/include</code> directory 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> </div>
<div id="outline-container-org7c81d63" class="outline-2"> <div id="outline-container-org1737381" class="outline-2">
<h2 id="org7c81d63"><span class="section-number-2">2</span> Developing in QMCkl</h2> <h2 id="org1737381"><span class="section-number-2">2</span> Developing in QMCkl</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
</div> </div>
<div id="outline-container-org7b640a2" class="outline-3"> <div id="outline-container-org5b75e12" class="outline-3">
<h3 id="org7b640a2"><span class="section-number-3">2.1</span> Literate programming</h3> <h3 id="org5b75e12"><span class="section-number-3">2.1</span> Literate programming</h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
<p> <p>
In a traditional source code, most of the lines of source files of a program 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> </div>
<div id="outline-container-org40b0427" class="outline-3"> <div id="outline-container-org5838277" class="outline-3">
<h3 id="org40b0427"><span class="section-number-3">2.2</span> Source code editing</h3> <h3 id="org5838277"><span class="section-number-3">2.2</span> Source code editing</h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
<p> <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>. 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> </div>
<div id="outline-container-org3b80d53" class="outline-3"> <div id="outline-container-org9bed5f7" class="outline-3">
<h3 id="org3b80d53"><span class="section-number-3">2.3</span> Choice of the programming language</h3> <h3 id="org9bed5f7"><span class="section-number-3">2.3</span> Choice of the programming language</h3>
<div class="outline-text-3" id="text-2-3"> <div class="outline-text-3" id="text-2-3">
<p> <p>
Most of the codes of the <a href="https://trex-coe.eu">TREX CoE</a> are written in Fortran with some scripts in 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> </div>
<div id="outline-container-orgc8abe9c" class="outline-3"> <div id="outline-container-org7a97eb2" class="outline-3">
<h3 id="orgc8abe9c"><span class="section-number-3">2.4</span> Coding rules</h3> <h3 id="org7a97eb2"><span class="section-number-3">2.4</span> Coding rules</h3>
<div class="outline-text-3" id="text-2-4"> <div class="outline-text-3" id="text-2-4">
<p> <p>
The authors should follow the recommendations of the C99 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> </div>
<div id="outline-container-orgf07d9ea" class="outline-3"> <div id="outline-container-org9e047bf" class="outline-3">
<h3 id="orgf07d9ea"><span class="section-number-3">2.5</span> Design of the library</h3> <h3 id="org9e047bf"><span class="section-number-3">2.5</span> Design of the library</h3>
<div class="outline-text-3" id="text-2-5"> <div class="outline-text-3" id="text-2-5">
<p> <p>
The proposed API should allow the library to: deal with memory transfers The proposed API should allow the library to: deal with memory transfers
@ -547,8 +547,8 @@ functions (see below).
</div> </div>
</div> </div>
<div id="outline-container-org9097f30" class="outline-3"> <div id="outline-container-orgd922e9c" class="outline-3">
<h3 id="org9097f30"><span class="section-number-3">2.6</span> Naming conventions</h3> <h3 id="orgd922e9c"><span class="section-number-3">2.6</span> Naming conventions</h3>
<div class="outline-text-3" id="text-2-6"> <div class="outline-text-3" id="text-2-6">
<p> <p>
To avoid namespace collisions, we use <code>qmckl_</code> as a prefix for all exported 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> </div>
<div id="outline-container-org6f73afd" class="outline-3"> <div id="outline-container-orgdd4de4b" class="outline-3">
<h3 id="org6f73afd"><span class="section-number-3">2.7</span> Application programming interface</h3> <h3 id="orgdd4de4b"><span class="section-number-3">2.7</span> Application programming interface</h3>
<div class="outline-text-3" id="text-2-7"> <div class="outline-text-3" id="text-2-7">
<p> <p>
In the C language, the number of bits used by the integer types can change 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> </div>
<div id="outline-container-orgb598e6b" class="outline-3"> <div id="outline-container-orgc4e27dc" class="outline-3">
<h3 id="orgb598e6b"><span class="section-number-3">2.8</span> Global state</h3> <h3 id="orgc4e27dc"><span class="section-number-3">2.8</span> Global state</h3>
<div class="outline-text-3" id="text-2-8"> <div class="outline-text-3" id="text-2-8">
<p> <p>
Global variables should be avoided in the library, because it is Global variables should be avoided in the library, because it is
possible that one single program needs to use multiple instances possible that one single program needs to use multiple instances
of the library. To solve this problem we propose to use a pointer 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 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="orga083249">=context=</a> contains the global <code>qmckl_context_create</code> function. The <a id="orgeaf04ec">=context=</a> contains the global
state of the library, and is used as the first argument of many state of the library, and is used as the first argument of many
QMCkl functions. QMCkl functions.
</p> </p>
@ -628,8 +628,8 @@ the state is done by setters and getters, prefixed by
</div> </div>
</div> </div>
<div id="outline-container-orgf4a3994" class="outline-3"> <div id="outline-container-org21cbcd0" class="outline-3">
<h3 id="orgf4a3994"><span class="section-number-3">2.9</span> Headers</h3> <h3 id="org21cbcd0"><span class="section-number-3">2.9</span> Headers</h3>
<div class="outline-text-3" id="text-2-9"> <div class="outline-text-3" id="text-2-9">
<p> <p>
A single <code>qmckl.h</code> header to be distributed by the library 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> </div>
<div id="outline-container-org4bca58d" class="outline-3"> <div id="outline-container-orgfab3614" class="outline-3">
<h3 id="org4bca58d"><span class="section-number-3">2.10</span> Low-level functions</h3> <h3 id="orgfab3614"><span class="section-number-3">2.10</span> Low-level functions</h3>
<div class="outline-text-3" id="text-2-10"> <div class="outline-text-3" id="text-2-10">
<p> <p>
Low-level functions are very simple functions which are leaves of 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> <p>
These functions are <i>pure</i>, and unaware of the QMCkl These functions are <i>pure</i>, and unaware of the QMCkl
<a href="#orga083249"><code>context</code></a>. They are not allowed to allocate/deallocate memory, and <a href="#orgeaf04ec"><code>context</code></a>. They are not allowed to allocate/deallocate memory, and
if they need temporary memory it should be provided in input. if they need temporary memory it should be provided in input.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-org3ef5653" class="outline-3"> <div id="outline-container-org92b2c80" class="outline-3">
<h3 id="org3ef5653"><span class="section-number-3">2.11</span> High-level functions</h3> <h3 id="org92b2c80"><span class="section-number-3">2.11</span> High-level functions</h3>
<div class="outline-text-3" id="text-2-11"> <div class="outline-text-3" id="text-2-11">
<p> <p>
High-level functions are at the top of the function call tree. 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> <p>
The high-level functions should be pure, unless the introduction The high-level functions should be pure, unless the introduction
of non-purity is justified. All the side effects should be made in of non-purity is justified. All the side effects should be made in
the <a href="#orga083249"><code>context</code></a> variable. the <a href="#orgeaf04ec"><code>context</code></a> variable.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-org2b8a6bd" class="outline-3"> <div id="outline-container-org539099d" class="outline-3">
<h3 id="org2b8a6bd"><span class="section-number-3">2.12</span> Numerical precision</h3> <h3 id="org539099d"><span class="section-number-3">2.12</span> Numerical precision</h3>
<div class="outline-text-3" id="text-2-12"> <div class="outline-text-3" id="text-2-12">
<p> <p>
The number of bits of precision required for a function should be The number of bits of precision required for a function should be
given as an input of low-level computational functions. This input given as an input of low-level computational functions. This input
will be used to define the values of the different thresholds that will be used to define the values of the different thresholds that
might be used to avoid computing unnecessary noise. High-level might be used to avoid computing unnecessary noise. High-level
functions will use the precision specified in the <a href="#orga083249"><code>context</code></a> functions will use the precision specified in the <a href="#orgeaf04ec"><code>context</code></a>
variable. variable.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgfcb2fea" class="outline-3"> <div id="outline-container-org86e4cd8" class="outline-3">
<h3 id="orgfcb2fea"><span class="section-number-3">2.13</span> Algorithms</h3> <h3 id="org86e4cd8"><span class="section-number-3">2.13</span> Algorithms</h3>
<div class="outline-text-3" id="text-2-13"> <div class="outline-text-3" id="text-2-13">
<p> <p>
Reducing the scaling of an algorithm usually implies also reducing Reducing the scaling of an algorithm usually implies also reducing
@ -783,7 +783,7 @@ implemented adapted to different problem sizes.
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2021-04-28 Wed 10:09</p> <p class="date">Created: 2021-04-28 Wed 11:30</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

158
qmckl_ao.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-04-28 Wed 10:09 --> <!-- 2021-04-28 Wed 11:31 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Atomic Orbitals</title> <title>Atomic Orbitals</title>
@ -333,52 +333,52 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org40ceaef">1. Context</a> <li><a href="#orgfb81763">1. Context</a>
<ul> <ul>
<li><a href="#orgb14cf91">1.1. Data structure</a></li> <li><a href="#org830f2cd">1.1. Data structure</a></li>
<li><a href="#org446d3e1">1.2. Access functions</a></li> <li><a href="#orgc30f38b">1.2. Access functions</a></li>
<li><a href="#orgcb06e98">1.3. Initialization functions</a></li> <li><a href="#org710293f">1.3. Initialization functions</a></li>
<li><a href="#org301ef5e">1.4. <span class="todo TODO">TODO</span> Fortran interfaces</a></li> <li><a href="#org6381630">1.4. <span class="todo TODO">TODO</span> Fortran interfaces</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org9af2aba">2. Polynomial part</a> <li><a href="#org5d994ee">2. Polynomial part</a>
<ul> <ul>
<li><a href="#org93b4e3a">2.1. Powers of \(x-X_i\)</a> <li><a href="#org2da5476">2.1. Powers of \(x-X_i\)</a>
<ul> <ul>
<li><a href="#orga8ce953">2.1.1. Requirements</a></li> <li><a href="#orgab6dd95">2.1.1. Requirements</a></li>
<li><a href="#org511dcf7">2.1.2. C Header</a></li> <li><a href="#orgf45dea5">2.1.2. C Header</a></li>
<li><a href="#org0782080">2.1.3. Source</a></li> <li><a href="#orgea5f3d2">2.1.3. Source</a></li>
<li><a href="#org9aee3b2">2.1.4. C interface</a></li> <li><a href="#org920d9c0">2.1.4. C interface</a></li>
<li><a href="#org7897924">2.1.5. Fortran interface</a></li> <li><a href="#orge2cabf5">2.1.5. Fortran interface</a></li>
<li><a href="#org4318917">2.1.6. Test</a></li> <li><a href="#orgb9038f8">2.1.6. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org7d2535d">2.2. Value, Gradient and Laplacian of a polynomial</a> <li><a href="#org251c210">2.2. Value, Gradient and Laplacian of a polynomial</a>
<ul> <ul>
<li><a href="#orgfa2000c">2.2.1. Requirements</a></li> <li><a href="#org474bb16">2.2.1. Requirements</a></li>
<li><a href="#orgf6d5afd">2.2.2. C Header</a></li> <li><a href="#org5bb941d">2.2.2. C Header</a></li>
<li><a href="#org9f42bf0">2.2.3. Source</a></li> <li><a href="#org6f34b90">2.2.3. Source</a></li>
<li><a href="#org4267a08">2.2.4. C interface</a></li> <li><a href="#org03b7bf4">2.2.4. C interface</a></li>
<li><a href="#org266b2ad">2.2.5. Fortran interface</a></li> <li><a href="#orgd5f958c">2.2.5. Fortran interface</a></li>
<li><a href="#org67a01d9">2.2.6. Test</a></li> <li><a href="#org4271b54">2.2.6. Test</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org29dfaeb">3. Radial part</a> <li><a href="#org5c96f67">3. Radial part</a>
<ul> <ul>
<li><a href="#org7067b54">3.1. Gaussian basis functions</a></li> <li><a href="#orgadbc940">3.1. Gaussian basis functions</a></li>
<li><a href="#org5ca7d76">3.2. <span class="todo TODO">TODO</span> Slater basis functions</a></li> <li><a href="#orgb6dca01">3.2. <span class="todo TODO">TODO</span> Slater basis functions</a></li>
<li><a href="#org79ba100">3.3. <span class="todo TODO">TODO</span> Radial functions on a grid</a></li> <li><a href="#orga75162f">3.3. <span class="todo TODO">TODO</span> Radial functions on a grid</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgaf7b64f">4. Combining radial and polynomial parts</a></li> <li><a href="#org8ed16e7">4. Combining radial and polynomial parts</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org40ceaef" class="outline-2"> <div id="outline-container-orgfb81763" class="outline-2">
<h2 id="org40ceaef"><span class="section-number-2">1</span> Context</h2> <h2 id="orgfb81763"><span class="section-number-2">1</span> Context</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The following arrays are stored in the context: The following arrays are stored in the context:
@ -503,8 +503,8 @@ coefficient = [ 0.006068, 0.045308, 0.202822, 0.503903, 0.383421,
</pre> </pre>
</div> </div>
<div id="outline-container-orgb14cf91" class="outline-3"> <div id="outline-container-org830f2cd" class="outline-3">
<h3 id="orgb14cf91"><span class="section-number-3">1.1</span> Data structure</h3> <h3 id="org830f2cd"><span class="section-number-3">1.1</span> Data structure</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<div class="org-src-container"> <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> { <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> </div>
<div id="outline-container-org446d3e1" class="outline-3"> <div id="outline-container-orgc30f38b" class="outline-3">
<h3 id="org446d3e1"><span class="section-number-3">1.2</span> Access functions</h3> <h3 id="orgc30f38b"><span class="section-number-3">1.2</span> Access functions</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
When all the data for the AOs have been provided, the following When all the data for the AOs have been provided, the following
@ -548,8 +548,8 @@ function returns <code>true</code>.
</div> </div>
</div> </div>
<div id="outline-container-orgcb06e98" class="outline-3"> <div id="outline-container-org710293f" class="outline-3">
<h3 id="orgcb06e98"><span class="section-number-3">1.3</span> Initialization functions</h3> <h3 id="org710293f"><span class="section-number-3">1.3</span> Initialization functions</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<p> <p>
To set the basis set, all the following functions need to be To set the basis set, all the following functions need to be
@ -572,17 +572,17 @@ called. When
</div> </div>
</div> </div>
<div id="outline-container-org301ef5e" class="outline-3"> <div id="outline-container-org6381630" class="outline-3">
<h3 id="org301ef5e"><span class="section-number-3">1.4</span> <span class="todo TODO">TODO</span> Fortran interfaces</h3> <h3 id="org6381630"><span class="section-number-3">1.4</span> <span class="todo TODO">TODO</span> Fortran interfaces</h3>
</div> </div>
</div> </div>
<div id="outline-container-org9af2aba" class="outline-2"> <div id="outline-container-org5d994ee" class="outline-2">
<h2 id="org9af2aba"><span class="section-number-2">2</span> Polynomial part</h2> <h2 id="org5d994ee"><span class="section-number-2">2</span> Polynomial part</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
</div> </div>
<div id="outline-container-org93b4e3a" class="outline-3"> <div id="outline-container-org2da5476" class="outline-3">
<h3 id="org93b4e3a"><span class="section-number-3">2.1</span> Powers of \(x-X_i\)</h3> <h3 id="org2da5476"><span class="section-number-3">2.1</span> Powers of \(x-X_i\)</h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
<p> <p>
The <code>qmckl_ao_power</code> function computes all the powers of the <code>n</code> 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_{ik} = X_i^k \]
</p> </p>
<table id="org3901d79" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org5da58e7" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -652,8 +652,8 @@ the \(n\) points:
</table> </table>
</div> </div>
<div id="outline-container-orga8ce953" class="outline-4"> <div id="outline-container-orgab6dd95" class="outline-4">
<h4 id="orga8ce953"><span class="section-number-4">2.1.1</span> Requirements</h4> <h4 id="orgab6dd95"><span class="section-number-4">2.1.1</span> Requirements</h4>
<div class="outline-text-4" id="text-2-1-1"> <div class="outline-text-4" id="text-2-1-1">
<ul class="org-ul"> <ul class="org-ul">
<li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li> <li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li>
@ -666,8 +666,8 @@ the \(n\) points:
</div> </div>
</div> </div>
<div id="outline-container-org511dcf7" class="outline-4"> <div id="outline-container-orgf45dea5" class="outline-4">
<h4 id="org511dcf7"><span class="section-number-4">2.1.2</span> C Header</h4> <h4 id="orgf45dea5"><span class="section-number-4">2.1.2</span> C Header</h4>
<div class="outline-text-4" id="text-2-1-2"> <div class="outline-text-4" id="text-2-1-2">
<div class="org-src-container"> <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> ( <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> </div>
<div id="outline-container-org0782080" class="outline-4"> <div id="outline-container-orgea5f3d2" class="outline-4">
<h4 id="org0782080"><span class="section-number-4">2.1.3</span> Source</h4> <h4 id="orgea5f3d2"><span class="section-number-4">2.1.3</span> Source</h4>
<div class="outline-text-4" id="text-2-1-3"> <div class="outline-text-4" id="text-2-1-3">
<div class="org-src-container"> <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> <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> </div>
<div id="outline-container-org9aee3b2" class="outline-4"> <div id="outline-container-org920d9c0" class="outline-4">
<h4 id="org9aee3b2"><span class="section-number-4">2.1.4</span> C interface</h4> <h4 id="org920d9c0"><span class="section-number-4">2.1.4</span> C interface</h4>
</div> </div>
<div id="outline-container-org7897924" class="outline-4"> <div id="outline-container-orge2cabf5" class="outline-4">
<h4 id="org7897924"><span class="section-number-4">2.1.5</span> Fortran interface</h4> <h4 id="orge2cabf5"><span class="section-number-4">2.1.5</span> Fortran interface</h4>
</div> </div>
<div id="outline-container-org4318917" class="outline-4"> <div id="outline-container-orgb9038f8" class="outline-4">
<h4 id="org4318917"><span class="section-number-4">2.1.6</span> Test</h4> <h4 id="orgb9038f8"><span class="section-number-4">2.1.6</span> Test</h4>
<div class="outline-text-4" id="text-2-1-6"> <div class="outline-text-4" id="text-2-1-6">
<div class="org-src-container"> <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) <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> </div>
<div id="outline-container-org7d2535d" class="outline-3"> <div id="outline-container-org251c210" class="outline-3">
<h3 id="org7d2535d"><span class="section-number-3">2.2</span> Value, Gradient and Laplacian of a polynomial</h3> <h3 id="org251c210"><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"> <div class="outline-text-3" id="text-2-2">
<p> <p>
A polynomial is centered on a nucleus \(\mathbf{R}_i\) 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>. angular momentum up to <code>lmax</code>.
</p> </p>
<table id="org67fbb39" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org8199efc" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -918,8 +918,8 @@ angular momentum up to <code>lmax</code>.
</table> </table>
</div> </div>
<div id="outline-container-orgfa2000c" class="outline-4"> <div id="outline-container-org474bb16" class="outline-4">
<h4 id="orgfa2000c"><span class="section-number-4">2.2.1</span> Requirements</h4> <h4 id="org474bb16"><span class="section-number-4">2.2.1</span> Requirements</h4>
<div class="outline-text-4" id="text-2-2-1"> <div class="outline-text-4" id="text-2-2-1">
<ul class="org-ul"> <ul class="org-ul">
<li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li> <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> </div>
<div id="outline-container-orgf6d5afd" class="outline-4"> <div id="outline-container-org5bb941d" class="outline-4">
<h4 id="orgf6d5afd"><span class="section-number-4">2.2.2</span> C Header</h4> <h4 id="org5bb941d"><span class="section-number-4">2.2.2</span> C Header</h4>
<div class="outline-text-4" id="text-2-2-2"> <div class="outline-text-4" id="text-2-2-2">
<div class="org-src-container"> <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> ( <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> </div>
<div id="outline-container-org9f42bf0" class="outline-4"> <div id="outline-container-org6f34b90" class="outline-4">
<h4 id="org9f42bf0"><span class="section-number-4">2.2.3</span> Source</h4> <h4 id="org6f34b90"><span class="section-number-4">2.2.3</span> Source</h4>
<div class="outline-text-4" id="text-2-2-3"> <div class="outline-text-4" id="text-2-2-3">
<div class="org-src-container"> <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> <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> </div>
<div id="outline-container-org4267a08" class="outline-4"> <div id="outline-container-org03b7bf4" class="outline-4">
<h4 id="org4267a08"><span class="section-number-4">2.2.4</span> C interface</h4> <h4 id="org03b7bf4"><span class="section-number-4">2.2.4</span> C interface</h4>
</div> </div>
<div id="outline-container-org266b2ad" class="outline-4"> <div id="outline-container-orgd5f958c" class="outline-4">
<h4 id="org266b2ad"><span class="section-number-4">2.2.5</span> Fortran interface</h4> <h4 id="orgd5f958c"><span class="section-number-4">2.2.5</span> Fortran interface</h4>
</div> </div>
<div id="outline-container-org67a01d9" class="outline-4"> <div id="outline-container-org4271b54" class="outline-4">
<h4 id="org67a01d9"><span class="section-number-4">2.2.6</span> Test</h4> <h4 id="org4271b54"><span class="section-number-4">2.2.6</span> Test</h4>
<div class="outline-text-4" id="text-2-2-6"> <div class="outline-text-4" id="text-2-2-6">
<div class="org-src-container"> <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) <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 @@ munit_assert_int(0, ==, test_qmckl_ao_polynomial_vgl(context));
</div> </div>
</div> </div>
<div id="outline-container-org29dfaeb" class="outline-2"> <div id="outline-container-org5c96f67" class="outline-2">
<h2 id="org29dfaeb"><span class="section-number-2">3</span> Radial part</h2> <h2 id="org5c96f67"><span class="section-number-2">3</span> Radial part</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
</div> </div>
<div id="outline-container-org7067b54" class="outline-3"> <div id="outline-container-orgadbc940" class="outline-3">
<h3 id="org7067b54"><span class="section-number-3">3.1</span> Gaussian basis functions</h3> <h3 id="orgadbc940"><span class="section-number-3">3.1</span> Gaussian basis functions</h3>
<div class="outline-text-3" id="text-3-1"> <div class="outline-text-3" id="text-3-1">
<p> <p>
<code>qmckl_ao_gaussian_vgl</code> computes the values, gradients and <code>qmckl_ao_gaussian_vgl</code> computes the values, gradients and
@ -1450,21 +1450,21 @@ Requirements
</div> </div>
</div> </div>
<div id="outline-container-org5ca7d76" class="outline-3"> <div id="outline-container-orgb6dca01" class="outline-3">
<h3 id="org5ca7d76"><span class="section-number-3">3.2</span> <span class="todo TODO">TODO</span> Slater basis functions</h3> <h3 id="orgb6dca01"><span class="section-number-3">3.2</span> <span class="todo TODO">TODO</span> Slater basis functions</h3>
</div> </div>
<div id="outline-container-org79ba100" class="outline-3"> <div id="outline-container-orga75162f" class="outline-3">
<h3 id="org79ba100"><span class="section-number-3">3.3</span> <span class="todo TODO">TODO</span> Radial functions on a grid</h3> <h3 id="orga75162f"><span class="section-number-3">3.3</span> <span class="todo TODO">TODO</span> Radial functions on a grid</h3>
</div> </div>
</div> </div>
<div id="outline-container-orgaf7b64f" class="outline-2"> <div id="outline-container-org8ed16e7" class="outline-2">
<h2 id="orgaf7b64f"><span class="section-number-2">4</span> Combining radial and polynomial parts</h2> <h2 id="org8ed16e7"><span class="section-number-2">4</span> Combining radial and polynomial parts</h2>
</div> </div>
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2021-04-28 Wed 10:09</p> <p class="date">Created: 2021-04-28 Wed 11:31</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

44
qmckl_context.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-04-28 Wed 10:09 --> <!-- 2021-04-28 Wed 11:31 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Context</title> <title>Context</title>
@ -311,21 +311,21 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orga884440">1. Context handling</a> <li><a href="#orgfe190d0">1. Context handling</a>
<ul> <ul>
<li><a href="#org7780890">1.1. Data structure</a></li> <li><a href="#org6326ad7">1.1. Data structure</a></li>
<li><a href="#orgcf77533">1.2. Creation</a></li> <li><a href="#org5ff4136">1.2. Creation</a></li>
<li><a href="#orgf4e1752">1.3. Locking</a></li> <li><a href="#orgbd8fcdc">1.3. Locking</a></li>
<li><a href="#orga13c138">1.4. <span class="todo TODO">TODO</span> Copy</a></li> <li><a href="#orga54612d">1.4. <span class="todo TODO">TODO</span> Copy</a></li>
<li><a href="#orgf133344">1.5. Destroy</a></li> <li><a href="#org44f4382">1.5. Destroy</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-orga884440" class="outline-2"> <div id="outline-container-orgfe190d0" class="outline-2">
<h2 id="orga884440"><span class="section-number-2">1</span> Context handling</h2> <h2 id="orgfe190d0"><span class="section-number-2">1</span> Context handling</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The context variable is a handle for the state of the library, 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> </p>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c" id="orga87b923"><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="org862b374"><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 <span style="color: #483d8b;">#define</span> <span style="color: #a0522d;">QMCKL_NULL_CONTEXT</span> (qmckl_context) 0
</pre> </pre>
</div> </div>
@ -356,8 +356,8 @@ and <code>ctx</code> is a <code>qmckl_context_struct*</code> pointer.
</p> </p>
</div> </div>
<div id="outline-container-org7780890" class="outline-3"> <div id="outline-container-org6326ad7" class="outline-3">
<h3 id="org7780890"><span class="section-number-3">1.1</span> Data structure</h3> <h3 id="org6326ad7"><span class="section-number-3">1.1</span> Data structure</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<p> <p>
The context keeps a ``date'' that allows to check which data needs The context keeps a ``date'' that allows to check which data needs
@ -367,7 +367,7 @@ coordinates are updated.
<p> <p>
When a new element is added to the context, the functions When a new element is added to the context, the functions
<a href="#orgcf77533">qmckl<sub>context</sub><sub>create</sub></a>, <a href="#orgf133344">qmckl<sub>context</sub><sub>destroy</sub></a> and <a href="#orga13c138">qmckl<sub>context</sub><sub>copy</sub></a> <a href="#org5ff4136">qmckl<sub>context</sub><sub>create</sub></a>, <a href="#org44f4382">qmckl<sub>context</sub><sub>destroy</sub></a> and <a href="#orga54612d">qmckl<sub>context</sub><sub>copy</sub></a>
should be updated inorder to make deep copies. should be updated inorder to make deep copies.
</p> </p>
@ -416,8 +416,8 @@ if the context is valid, <code>QMCKL_NULL_CONTEXT</code> otherwise.
</div> </div>
</div> </div>
<div id="outline-container-orgcf77533" class="outline-3"> <div id="outline-container-org5ff4136" class="outline-3">
<h3 id="orgcf77533"><span class="section-number-3">1.2</span> Creation</h3> <h3 id="org5ff4136"><span class="section-number-3">1.2</span> Creation</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
To create a new context, <code>qmckl_context_create()</code> should be used. 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>
</div> </div>
<div id="outline-container-orgf4e1752" class="outline-3"> <div id="outline-container-orgbd8fcdc" class="outline-3">
<h3 id="orgf4e1752"><span class="section-number-3">1.3</span> Locking</h3> <h3 id="orgbd8fcdc"><span class="section-number-3">1.3</span> Locking</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<p> <p>
For thread safety, the context may be locked/unlocked. The lock is 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> </div>
<div id="outline-container-orga13c138" class="outline-3"> <div id="outline-container-orga54612d" class="outline-3">
<h3 id="orga13c138"><span class="section-number-3">1.4</span> <span class="todo TODO">TODO</span> Copy</h3> <h3 id="orga54612d"><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"> <div class="outline-text-3" id="text-1-4">
<p> <p>
<code>qmckl_context_copy</code> makes a deep copy of a context. It returns <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>
</div> </div>
<div id="outline-container-orgf133344" class="outline-3"> <div id="outline-container-org44f4382" class="outline-3">
<h3 id="orgf133344"><span class="section-number-3">1.5</span> Destroy</h3> <h3 id="org44f4382"><span class="section-number-3">1.5</span> Destroy</h3>
<div class="outline-text-3" id="text-1-5"> <div class="outline-text-3" id="text-1-5">
<p> <p>
The context is destroyed with <code>qmckl_context_destroy</code>, leaving the ancestors untouched. 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>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2021-04-28 Wed 10:09</p> <p class="date">Created: 2021-04-28 Wed 11:31</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

80
qmckl_distance.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-04-28 Wed 10:09 --> <!-- 2021-04-28 Wed 11:31 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Inter-particle distances</title> <title>Inter-particle distances</title>
@ -333,26 +333,26 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orgbc16b74">1. Squared distance</a> <li><a href="#org7e3d157">1. Squared distance</a>
<ul> <ul>
<li><a href="#orgb6e4326">1.1. <code>qmckl_distance_sq</code></a> <li><a href="#orgf276b1b">1.1. <code>qmckl_distance_sq</code></a>
<ul> <ul>
<li><a href="#org2babbe6">1.1.1. Requirements</a></li> <li><a href="#org2c7e2fc">1.1.1. Requirements</a></li>
<li><a href="#org599af6b">1.1.2. C header</a></li> <li><a href="#org9361ff0">1.1.2. C header</a></li>
<li><a href="#org2181cea">1.1.3. Source</a></li> <li><a href="#org44d51b5">1.1.3. Source</a></li>
<li><a href="#org466303b">1.1.4. Performance</a></li> <li><a href="#orgccf825b">1.1.4. Performance</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
</li> </li>
<li><a href="#org989d290">2. Distance</a> <li><a href="#orgc9bc1aa">2. Distance</a>
<ul> <ul>
<li><a href="#orgc984271">2.1. <code>qmckl_distance</code></a> <li><a href="#orgacb09f7">2.1. <code>qmckl_distance</code></a>
<ul> <ul>
<li><a href="#org0773704">2.1.1. Requirements</a></li> <li><a href="#org2f056d0">2.1.1. Requirements</a></li>
<li><a href="#org7a44c28">2.1.2. C header</a></li> <li><a href="#org81fa37c">2.1.2. C header</a></li>
<li><a href="#org659a66f">2.1.3. Source</a></li> <li><a href="#org7d1f8df">2.1.3. Source</a></li>
<li><a href="#org8cf5c96">2.1.4. Performance</a></li> <li><a href="#org650a273">2.1.4. Performance</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -361,12 +361,12 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-orgbc16b74" class="outline-2"> <div id="outline-container-org7e3d157" class="outline-2">
<h2 id="orgbc16b74"><span class="section-number-2">1</span> Squared distance</h2> <h2 id="org7e3d157"><span class="section-number-2">1</span> Squared distance</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
</div> </div>
<div id="outline-container-orgb6e4326" class="outline-3"> <div id="outline-container-orgf276b1b" class="outline-3">
<h3 id="orgb6e4326"><span class="section-number-3">1.1</span> <code>qmckl_distance_sq</code></h3> <h3 id="orgf276b1b"><span class="section-number-3">1.1</span> <code>qmckl_distance_sq</code></h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<p> <p>
<code>qmckl_distance_sq</code> computes the matrix of the squared distances <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> </p>
<table id="orgbdc91a3" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgbf917d6" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -472,8 +472,8 @@ between all pairs of points in two sets, one point within each set:
</table> </table>
</div> </div>
<div id="outline-container-org2babbe6" class="outline-4"> <div id="outline-container-org2c7e2fc" class="outline-4">
<h4 id="org2babbe6"><span class="section-number-4">1.1.1</span> Requirements</h4> <h4 id="org2c7e2fc"><span class="section-number-4">1.1.1</span> Requirements</h4>
<div class="outline-text-4" id="text-1-1-1"> <div class="outline-text-4" id="text-1-1-1">
<ul class="org-ul"> <ul class="org-ul">
<li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li> <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> </div>
<div id="outline-container-org599af6b" class="outline-4"> <div id="outline-container-org9361ff0" class="outline-4">
<h4 id="org599af6b"><span class="section-number-4">1.1.2</span> C header</h4> <h4 id="org9361ff0"><span class="section-number-4">1.1.2</span> C header</h4>
<div class="outline-text-4" id="text-1-1-2"> <div class="outline-text-4" id="text-1-1-2">
<div class="org-src-container"> <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> ( <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> </div>
<div id="outline-container-org2181cea" class="outline-4"> <div id="outline-container-org44d51b5" class="outline-4">
<h4 id="org2181cea"><span class="section-number-4">1.1.3</span> Source</h4> <h4 id="org44d51b5"><span class="section-number-4">1.1.3</span> Source</h4>
<div class="outline-text-4" id="text-1-1-3"> <div class="outline-text-4" id="text-1-1-3">
<div class="org-src-container"> <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;">&amp;</span> <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;">&amp;</span>
@ -648,8 +648,8 @@ between all pairs of points in two sets, one point within each set:
</div> </div>
</div> </div>
<div id="outline-container-org466303b" class="outline-4"> <div id="outline-container-orgccf825b" class="outline-4">
<h4 id="org466303b"><span class="section-number-4">1.1.4</span> Performance</h4> <h4 id="orgccf825b"><span class="section-number-4">1.1.4</span> Performance</h4>
<div class="outline-text-4" id="text-1-1-4"> <div class="outline-text-4" id="text-1-1-4">
<p> <p>
This function might be more efficient when <code>A</code> and <code>B</code> are This function might be more efficient when <code>A</code> and <code>B</code> are
@ -659,12 +659,12 @@ transposed.
</div> </div>
</div> </div>
</div> </div>
<div id="outline-container-org989d290" class="outline-2"> <div id="outline-container-orgc9bc1aa" class="outline-2">
<h2 id="org989d290"><span class="section-number-2">2</span> Distance</h2> <h2 id="orgc9bc1aa"><span class="section-number-2">2</span> Distance</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
</div> </div>
<div id="outline-container-orgc984271" class="outline-3"> <div id="outline-container-orgacb09f7" class="outline-3">
<h3 id="orgc984271"><span class="section-number-3">2.1</span> <code>qmckl_distance</code></h3> <h3 id="orgacb09f7"><span class="section-number-3">2.1</span> <code>qmckl_distance</code></h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
<p> <p>
<code>qmckl_distance</code> computes the matrix of the distances between all <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> </p>
<table id="org24aae5f" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org238ed41" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -770,8 +770,8 @@ pairs of points in two sets, one point within each set:
</table> </table>
</div> </div>
<div id="outline-container-org0773704" class="outline-4"> <div id="outline-container-org2f056d0" class="outline-4">
<h4 id="org0773704"><span class="section-number-4">2.1.1</span> Requirements</h4> <h4 id="org2f056d0"><span class="section-number-4">2.1.1</span> Requirements</h4>
<div class="outline-text-4" id="text-2-1-1"> <div class="outline-text-4" id="text-2-1-1">
<ul class="org-ul"> <ul class="org-ul">
<li><code>context</code> is not <code>QMCKL_NULL_CONTEXT</code></li> <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> </div>
<div id="outline-container-org7a44c28" class="outline-4"> <div id="outline-container-org81fa37c" class="outline-4">
<h4 id="org7a44c28"><span class="section-number-4">2.1.2</span> C header</h4> <h4 id="org81fa37c"><span class="section-number-4">2.1.2</span> C header</h4>
<div class="outline-text-4" id="text-2-1-2"> <div class="outline-text-4" id="text-2-1-2">
<div class="org-src-container"> <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> ( <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> </div>
<div id="outline-container-org659a66f" class="outline-4"> <div id="outline-container-org7d1f8df" class="outline-4">
<h4 id="org659a66f"><span class="section-number-4">2.1.3</span> Source</h4> <h4 id="org7d1f8df"><span class="section-number-4">2.1.3</span> Source</h4>
<div class="outline-text-4" id="text-2-1-3"> <div class="outline-text-4" id="text-2-1-3">
<div class="org-src-container"> <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;">&amp;</span> <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;">&amp;</span>
@ -950,8 +950,8 @@ pairs of points in two sets, one point within each set:
</div> </div>
</div> </div>
<div id="outline-container-org8cf5c96" class="outline-4"> <div id="outline-container-org650a273" class="outline-4">
<h4 id="org8cf5c96"><span class="section-number-4">2.1.4</span> Performance</h4> <h4 id="org650a273"><span class="section-number-4">2.1.4</span> Performance</h4>
<div class="outline-text-4" id="text-2-1-4"> <div class="outline-text-4" id="text-2-1-4">
<p> <p>
This function might be more efficient when <code>A</code> and <code>B</code> are This function might be more efficient when <code>A</code> and <code>B</code> are
@ -964,7 +964,7 @@ transposed.
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2021-04-28 Wed 10:09</p> <p class="date">Created: 2021-04-28 Wed 11:31</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

66
qmckl_electron.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-04-28 Wed 10:09 --> <!-- 2021-04-28 Wed 11:31 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Electrons</title> <title>Electrons</title>
@ -311,21 +311,21 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org2dc6543">1. Context</a> <li><a href="#org285d037">1. Context</a>
<ul> <ul>
<li><a href="#orga3291d4">1.1. Data structure</a></li> <li><a href="#org4b36329">1.1. Data structure</a></li>
<li><a href="#orgfa7a9a7">1.2. Access functions</a></li> <li><a href="#orgfc62be3">1.2. Access functions</a></li>
<li><a href="#org2810b8d">1.3. Initialization functions</a></li> <li><a href="#org839d63f">1.3. Initialization functions</a></li>
<li><a href="#org66d50d7">1.4. Test</a></li> <li><a href="#orgea7612a">1.4. Test</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgdbd614b">2. Computation</a> <li><a href="#org919cbe2">2. Computation</a>
<ul> <ul>
<li><a href="#orga0012e5">2.1. Electron-electron distances</a> <li><a href="#org981688f">2.1. Electron-electron distances</a>
<ul> <ul>
<li><a href="#org3d32149">2.1.1. Get</a></li> <li><a href="#orgd0835c5">2.1.1. Get</a></li>
<li><a href="#org8087dae">2.1.2. Compute</a></li> <li><a href="#orgfe4bb72">2.1.2. Compute</a></li>
<li><a href="#org36d538a">2.1.3. Test</a></li> <li><a href="#org12b918c">2.1.3. Test</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -334,8 +334,8 @@ for the JavaScript code in this tag.
</div> </div>
</div> </div>
<div id="outline-container-org2dc6543" class="outline-2"> <div id="outline-container-org285d037" class="outline-2">
<h2 id="org2dc6543"><span class="section-number-2">1</span> Context</h2> <h2 id="org285d037"><span class="section-number-2">1</span> Context</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
The following data stored in the context: The following data stored in the context:
@ -421,8 +421,8 @@ The following data stored in the context:
</table> </table>
</div> </div>
<div id="outline-container-orga3291d4" class="outline-3"> <div id="outline-container-org4b36329" class="outline-3">
<h3 id="orga3291d4"><span class="section-number-3">1.1</span> Data structure</h3> <h3 id="org4b36329"><span class="section-number-3">1.1</span> Data structure</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<div class="org-src-container"> <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> { <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> </div>
<div id="outline-container-orgfa7a9a7" class="outline-3"> <div id="outline-container-orgfc62be3" class="outline-3">
<h3 id="orgfa7a9a7"><span class="section-number-3">1.2</span> Access functions</h3> <h3 id="orgfc62be3"><span class="section-number-3">1.2</span> Access functions</h3>
<div class="outline-text-3" id="text-1-2"> <div class="outline-text-3" id="text-1-2">
<p> <p>
When all the data relative to electrons have been set, the When all the data relative to electrons have been set, the
@ -465,8 +465,8 @@ following function returns <code>true</code>.
</div> </div>
</div> </div>
<div id="outline-container-org2810b8d" class="outline-3"> <div id="outline-container-org839d63f" class="outline-3">
<h3 id="org2810b8d"><span class="section-number-3">1.3</span> Initialization functions</h3> <h3 id="org839d63f"><span class="section-number-3">1.3</span> Initialization functions</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-3">
<p> <p>
To set the data relative to the electrons in the context, the To set the data relative to the electrons in the context, the
@ -496,8 +496,8 @@ electrons have been set.
</div> </div>
</div> </div>
<div id="outline-container-org66d50d7" class="outline-3"> <div id="outline-container-orgea7612a" class="outline-3">
<h3 id="org66d50d7"><span class="section-number-3">1.4</span> Test</h3> <h3 id="orgea7612a"><span class="section-number-3">1.4</span> Test</h3>
<div class="outline-text-3" id="text-1-4"> <div class="outline-text-3" id="text-1-4">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">/* <span style="color: #b22222;">Reference input data </span>*/ <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> </div>
<div id="outline-container-orgdbd614b" class="outline-2"> <div id="outline-container-org919cbe2" class="outline-2">
<h2 id="orgdbd614b"><span class="section-number-2">2</span> Computation</h2> <h2 id="org919cbe2"><span class="section-number-2">2</span> Computation</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
The computed data is stored in the context so that it can be reused The computed data is stored in the context so that it can be reused
@ -556,12 +556,12 @@ current date is stored.
</p> </p>
</div> </div>
<div id="outline-container-orga0012e5" class="outline-3"> <div id="outline-container-org981688f" class="outline-3">
<h3 id="orga0012e5"><span class="section-number-3">2.1</span> Electron-electron distances</h3> <h3 id="org981688f"><span class="section-number-3">2.1</span> Electron-electron distances</h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
</div> </div>
<div id="outline-container-org3d32149" class="outline-4"> <div id="outline-container-orgd0835c5" class="outline-4">
<h4 id="org3d32149"><span class="section-number-4">2.1.1</span> Get</h4> <h4 id="orgd0835c5"><span class="section-number-4">2.1.1</span> Get</h4>
<div class="outline-text-4" id="text-2-1-1"> <div class="outline-text-4" id="text-2-1-1">
<div class="org-src-container"> <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>); <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> </div>
<div id="outline-container-org8087dae" class="outline-4"> <div id="outline-container-orgfe4bb72" class="outline-4">
<h4 id="org8087dae"><span class="section-number-4">2.1.2</span> Compute</h4> <h4 id="orgfe4bb72"><span class="section-number-4">2.1.2</span> Compute</h4>
<div class="outline-text-4" id="text-2-1-2"> <div class="outline-text-4" id="text-2-1-2">
<table id="orgee84f4a" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="orgf68137d" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -670,8 +670,8 @@ current date is stored.
</div> </div>
</div> </div>
<div id="outline-container-org36d538a" class="outline-4"> <div id="outline-container-org12b918c" class="outline-4">
<h4 id="org36d538a"><span class="section-number-4">2.1.3</span> Test</h4> <h4 id="org12b918c"><span class="section-number-4">2.1.3</span> Test</h4>
<div class="outline-text-4" id="text-2-1-3"> <div class="outline-text-4" id="text-2-1-3">
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c">/* <span style="color: #b22222;">Reference input data </span>*/ <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>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2021-04-28 Wed 10:09</p> <p class="date">Created: 2021-04-28 Wed 11:31</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

40
qmckl_error.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-04-28 Wed 10:09 --> <!-- 2021-04-28 Wed 11:31 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Error handling</title> <title>Error handling</title>
@ -311,18 +311,18 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orgab1fe61"></a></li> <li><a href="#org970f36e"></a></li>
<li><a href="#org4e585b8">1. Decoding errors</a></li> <li><a href="#org826493d">1. Decoding errors</a></li>
<li><a href="#org5e67c6b">2. Data structure in context</a></li> <li><a href="#org51e580d">2. Data structure in context</a></li>
<li><a href="#orge0955ee">3. Updating errors in the context</a></li> <li><a href="#orgae48835">3. Updating errors in the context</a></li>
<li><a href="#org96a1ec0">4. Failing</a></li> <li><a href="#orgb3a9c23">4. Failing</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-orgab1fe61" class="outline-2"> <div id="outline-container-org970f36e" class="outline-2">
<h2 id="orgab1fe61"></h2> <h2 id="org970f36e"></h2>
<div class="outline-text-2" id="text-orgab1fe61"> <div class="outline-text-2" id="text-org970f36e">
<p> <p>
The library should never make the calling programs abort, nor The library should never make the calling programs abort, nor
perform any input/output operations. This decision has to be taken perform any input/output operations. This decision has to be taken
@ -333,7 +333,7 @@ by the developer of the code calling the library.
All the functions return with an exit code, defined as All the functions return with an exit code, defined as
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-c" id="org8f4eb4d"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int32_t</span> <span style="color: #228b22;">qmckl_exit_code</span>; <pre class="src src-c" id="orgf8d2553"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int32_t</span> <span style="color: #228b22;">qmckl_exit_code</span>;
</pre> </pre>
</div> </div>
@ -350,7 +350,7 @@ error code is returned to the program.
Here is the complete list of exit codes. Here is the complete list of exit codes.
</p> </p>
<table id="org536b0ce" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org3a3d0a7" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -480,8 +480,8 @@ string is assumed to be large enough to contain the error message
</div> </div>
</div> </div>
<div id="outline-container-org4e585b8" class="outline-2"> <div id="outline-container-org826493d" class="outline-2">
<h2 id="org4e585b8"><span class="section-number-2">1</span> Decoding errors</h2> <h2 id="org826493d"><span class="section-number-2">1</span> Decoding errors</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
To decode the error messages, <code>qmckl_string_of_error</code> converts an To decode the error messages, <code>qmckl_string_of_error</code> converts an
@ -575,8 +575,8 @@ The text strings are extracted from the previous table.
</div> </div>
</div> </div>
<div id="outline-container-org5e67c6b" class="outline-2"> <div id="outline-container-org51e580d" class="outline-2">
<h2 id="org5e67c6b"><span class="section-number-2">2</span> Data structure in context</h2> <h2 id="org51e580d"><span class="section-number-2">2</span> Data structure in context</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
The strings are declared with a maximum fixed size to avoid The strings are declared with a maximum fixed size to avoid
@ -599,8 +599,8 @@ dynamic memory allocation.
</div> </div>
</div> </div>
<div id="outline-container-orge0955ee" class="outline-2"> <div id="outline-container-orgae48835" class="outline-2">
<h2 id="orge0955ee"><span class="section-number-2">3</span> Updating errors in the context</h2> <h2 id="orgae48835"><span class="section-number-2">3</span> Updating errors in the context</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
<p> <p>
The error is updated in the context using <code>qmckl_set_error</code>. The error is updated in the context using <code>qmckl_set_error</code>.
@ -646,8 +646,8 @@ explaining the error. The exit code can't be <code>QMCKL_SUCCESS</code>.
</div> </div>
</div> </div>
<div id="outline-container-org96a1ec0" class="outline-2"> <div id="outline-container-orgb3a9c23" class="outline-2">
<h2 id="org96a1ec0"><span class="section-number-2">4</span> Failing</h2> <h2 id="orgb3a9c23"><span class="section-number-2">4</span> Failing</h2>
<div class="outline-text-2" id="text-4"> <div class="outline-text-2" id="text-4">
<p> <p>
To make a function fail, the <code>qmckl_failwith</code> function should be To make a function fail, the <code>qmckl_failwith</code> function should be
@ -710,7 +710,7 @@ For example, this function can be used as
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2021-04-28 Wed 10:09</p> <p class="date">Created: 2021-04-28 Wed 11:31</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

22
qmckl_memory.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-04-28 Wed 10:09 --> <!-- 2021-04-28 Wed 11:31 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Memory management</title> <title>Memory management</title>
@ -311,15 +311,15 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org63e2dde">1. Memory data structure for the context</a></li> <li><a href="#org0459698">1. Memory data structure for the context</a></li>
<li><a href="#org17b9a5e">2. Passing info to allocation routines</a></li> <li><a href="#org6efad30">2. Passing info to allocation routines</a></li>
<li><a href="#orgd48bfcb">3. Allocation/deallocation functions</a></li> <li><a href="#org3b0f572">3. Allocation/deallocation functions</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org63e2dde" class="outline-2"> <div id="outline-container-org0459698" class="outline-2">
<h2 id="org63e2dde"><span class="section-number-2">1</span> Memory data structure for the context</h2> <h2 id="org0459698"><span class="section-number-2">1</span> Memory data structure for the context</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
Every time a new block of memory is allocated, the information 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> </div>
<div id="outline-container-org17b9a5e" class="outline-2"> <div id="outline-container-org6efad30" class="outline-2">
<h2 id="org17b9a5e"><span class="section-number-2">2</span> Passing info to allocation routines</h2> <h2 id="org6efad30"><span class="section-number-2">2</span> Passing info to allocation routines</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
Passing information to the allocation routine should be done by 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> </div>
<div id="outline-container-orgd48bfcb" class="outline-2"> <div id="outline-container-org3b0f572" class="outline-2">
<h2 id="orgd48bfcb"><span class="section-number-2">3</span> Allocation/deallocation functions</h2> <h2 id="org3b0f572"><span class="section-number-2">3</span> Allocation/deallocation functions</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
<p> <p>
Memory allocation inside the library should be done with Memory allocation inside the library should be done with
@ -535,7 +535,7 @@ allocation and needs to be updated.
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2021-04-28 Wed 10:09</p> <p class="date">Created: 2021-04-28 Wed 11:31</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

30
qmckl_numprec.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-04-28 Wed 10:09 --> <!-- 2021-04-28 Wed 11:31 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Numerical precision</title> <title>Numerical precision</title>
@ -333,16 +333,16 @@ for the JavaScript code in this tag.
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#org79c80d9">1. Control of the numerical precision</a></li> <li><a href="#org0ad7cc5">1. Control of the numerical precision</a></li>
<li><a href="#orga792a34">2. Precision</a></li> <li><a href="#org3a86eb7">2. Precision</a></li>
<li><a href="#orgd543bed">3. Range</a></li> <li><a href="#orga1f1c24">3. Range</a></li>
<li><a href="#orgf7d4b54">4. Helper functions</a></li> <li><a href="#orgd4d90e8">4. Helper functions</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div id="outline-container-org79c80d9" class="outline-2"> <div id="outline-container-org0ad7cc5" class="outline-2">
<h2 id="org79c80d9"><span class="section-number-2">1</span> Control of the numerical precision</h2> <h2 id="org0ad7cc5"><span class="section-number-2">1</span> Control of the numerical precision</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
<p> <p>
Controlling numerical precision enables optimizations. Here, the Controlling numerical precision enables optimizations. Here, the
@ -353,7 +353,7 @@ Arithmetic (IEEE 754),
refers to the number of exponent bits. refers to the number of exponent bits.
</p> </p>
<table id="orgc944183" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> <table id="org953188f" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup> <colgroup>
@ -397,8 +397,8 @@ integer. The update functions return <code>QMCKL_SUCCESS</code> or
</div> </div>
</div> </div>
<div id="outline-container-orga792a34" class="outline-2"> <div id="outline-container-org3a86eb7" class="outline-2">
<h2 id="orga792a34"><span class="section-number-2">2</span> Precision</h2> <h2 id="org3a86eb7"><span class="section-number-2">2</span> Precision</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
<p> <p>
<code>qmckl_context_set_numprec_precision</code> modifies the parameter for the <code>qmckl_context_set_numprec_precision</code> modifies the parameter for the
@ -485,8 +485,8 @@ numerical precision in the context.
</div> </div>
</div> </div>
<div id="outline-container-orgd543bed" class="outline-2"> <div id="outline-container-orga1f1c24" class="outline-2">
<h2 id="orgd543bed"><span class="section-number-2">3</span> Range</h2> <h2 id="orga1f1c24"><span class="section-number-2">3</span> Range</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
<p> <p>
<code>qmckl_set_numprec_range</code> modifies the parameter for the numerical <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>
</div> </div>
<div id="outline-container-orgf7d4b54" class="outline-2"> <div id="outline-container-orgd4d90e8" class="outline-2">
<h2 id="orgf7d4b54"><span class="section-number-2">4</span> Helper functions</h2> <h2 id="orgd4d90e8"><span class="section-number-2">4</span> Helper functions</h2>
<div class="outline-text-2" id="text-4"> <div class="outline-text-2" id="text-4">
<p> <p>
<code>qmckl_get_numprec_epsilon</code> returns \(\epsilon = 2^{1-n}\) where <code>n</code> is the precision. <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>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2021-04-28 Wed 10:09</p> <p class="date">Created: 2021-04-28 Wed 11:31</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>

4
test_qmckl.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head> <head>
<!-- 2021-04-28 Wed 10:09 --> <!-- 2021-04-28 Wed 11:31 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Testing</title> <title>Testing</title>
@ -311,7 +311,7 @@ for the JavaScript code in this tag.
</div> </div>
<div id="postamble" class="status"> <div id="postamble" class="status">
<p class="author">Author: TREX CoE</p> <p class="author">Author: TREX CoE</p>
<p class="date">Created: 2021-04-28 Wed 10:09</p> <p class="date">Created: 2021-04-28 Wed 11:31</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div> </div>
</body> </body>