2021-03-19 13:49:11 +01:00
<?xml version="1.0" encoding="utf-8"?>
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en" xml:lang = "en" >
< head >
2022-02-25 16:41:55 +01:00
<!-- 2022 - 02 - 25 Fri 15:41 -->
2021-03-19 13:49:11 +01:00
< meta http-equiv = "Content-Type" content = "text/html;charset=utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > Context< / title >
< meta name = "generator" content = "Org mode" / >
2021-04-30 01:35:52 +02:00
< meta name = "author" content = "TREX CoE" / >
2021-03-19 13:49:11 +01:00
< style type = "text/css" >
<!-- /* --> <![CDATA[/*> <!-- */
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
/*]]>*/-->
< / style >
2021-04-30 01:35:52 +02:00
< link rel = "stylesheet" title = "Standard" href = "qmckl.css" type = "text/css" / >
< script type = "text/javascript" src = "org-info.js" >
/**
*
* @source: org-info.js
*
* @licstart The following is the entire license notice for the
* JavaScript code in org-info.js.
*
* Copyright (C) 2012-2019 Free Software Foundation, Inc.
*
*
* The JavaScript code in this tag is free software: you can
* redistribute it and/or modify it under the terms of the GNU
* General Public License (GNU GPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option)
* any later version. The code is distributed WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
*
* As additional permission under GNU GPL version 3 section 7, you
* may distribute non-source (e.g., minimized or compacted) forms of
* that code without the copy of the GNU GPL normally required by
* section 4, provided you include this license notice and a URL
* through which recipients can access the Corresponding Source.
*
* @licend The above is the entire license notice
* for the JavaScript code in org-info.js.
*
*/
< / script >
< script type = "text/javascript" >
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2019 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!-- /* --> <![CDATA[/*> <!-- */
org_html_manager.set("TOC_DEPTH", "4");
org_html_manager.set("LINK_HOME", "index.html");
org_html_manager.set("LINK_UP", "");
org_html_manager.set("LOCAL_TOC", "1");
org_html_manager.set("VIEW_BUTTONS", "0");
org_html_manager.set("MOUSE_HINT", "underline");
org_html_manager.set("FIXED_TOC", "0");
org_html_manager.set("TOC", "1");
org_html_manager.set("VIEW", "info");
org_html_manager.setup(); // activate after the parameters are set
/*]]>*///-->
< / script >
2021-03-19 13:49:11 +01:00
< script type = "text/javascript" >
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2019 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!-- /* --> <![CDATA[/*> <!-- */
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
< / script >
< / head >
< body >
2021-04-30 01:35:52 +02:00
< div id = "org-div-home-and-up" >
< a accesskey = "h" href = "" > UP < / a >
|
< a accesskey = "H" href = "index.html" > HOME < / a >
< / div > < div id = "content" >
2021-03-19 13:49:11 +01:00
< h1 class = "title" > Context< / h1 >
< div id = "table-of-contents" >
< h2 > Table of Contents< / h2 >
< div id = "text-table-of-contents" >
< ul >
2022-02-25 16:41:55 +01:00
< li > < a href = "#org81b9b19" > 1. Context handling< / a >
2021-03-19 13:49:11 +01:00
< ul >
2022-02-25 16:41:55 +01:00
< li > < a href = "#org96fff53" > 1.1. Data structure< / a > < / li >
< li > < a href = "#org6e66dea" > 1.2. Creation< / a > < / li >
< li > < a href = "#orgae8fc83" > 1.3. Locking< / a > < / li >
< li > < a href = "#orgae92c5f" > 1.4. < span class = "todo TODO" > TODO< / span > Copy< / a > < / li >
< li > < a href = "#org303ac89" > 1.5. Destroy< / a > < / li >
2021-03-19 13:49:11 +01:00
< / ul >
< / li >
< / ul >
< / div >
< / div >
2021-04-21 00:01:53 +02:00
2022-02-25 16:41:55 +01:00
< div id = "outline-container-org81b9b19" class = "outline-2" >
< h2 id = "org81b9b19" > < span class = "section-number-2" > 1< / span > Context handling< / h2 >
2021-04-21 00:01:53 +02:00
< div class = "outline-text-2" id = "text-1" >
2021-03-19 13:49:11 +01:00
< p >
The context variable is a handle for the state of the library,
and is stored in a data structure which can't be seen outside of
2021-04-21 00:01:53 +02:00
the library. To simplify compatibility with other languages, the
2021-03-19 13:49:11 +01:00
pointer to the internal data structure is converted into a 64-bit
signed integer, defined in the < code > qmckl_context< / code > type.
A value of < code > QMCKL_NULL_CONTEXT< / code > for the context is equivalent to a
< code > NULL< / code > pointer.
< / p >
< div class = "org-src-container" >
2022-02-25 16:41:55 +01:00
< pre class = "src src-c" id = "orgaa9a98c" > < span style = "color: #a020f0;" > typedef< / span > < span style = "color: #228b22;" > int64_t< / span > < span style = "color: #228b22;" > qmckl_context< / span > ;
2021-03-19 13:49:11 +01:00
< span style = "color: #483d8b;" > #define< / span > < span style = "color: #a0522d;" > QMCKL_NULL_CONTEXT< / span > (qmckl_context) 0
< / pre >
< / div >
< p >
2021-04-21 00:01:53 +02:00
An immutable context would have required to implement a garbage
collector. To keep the library simple, we have chosen to implement
the context as a mutable data structure, so it has to be handled
with care.
2021-03-19 13:49:11 +01:00
< / p >
< p >
By convention, in this file < code > context< / code > is a < code > qmckl_context< / code > variable
and < code > ctx< / code > is a < code > qmckl_context_struct*< / code > pointer.
< / p >
< / div >
2022-02-25 16:41:55 +01:00
< div id = "outline-container-org96fff53" class = "outline-3" >
< h3 id = "org96fff53" > < span class = "section-number-3" > 1.1< / span > Data structure< / h3 >
2021-03-19 13:49:11 +01:00
< div class = "outline-text-3" id = "text-1-1" >
< p >
A tag is used internally to check if the memory domain pointed
by a pointer is a valid context. This allows to check that even if
the pointer associated with a context is non-null, we can still
verify that it points to the expected data structure.
< / p >
< p >
The < code > qmckl_context_check< / code > function checks if the domain pointed by
the pointer is a valid context. It returns the input < code > qmckl_context< / code >
if the context is valid, < code > QMCKL_NULL_CONTEXT< / code > otherwise.
< / p >
< div class = "org-src-container" >
2022-02-24 19:08:50 +01:00
< pre class = "src src-c" > < span style = "color: #228b22;" > qmckl_context< / span >
< span style = "color: #0000ff;" > qmckl_context_check< / span > (< span style = "color: #a020f0;" > const< / span > < span style = "color: #228b22;" > qmckl_context< / span > < span style = "color: #a0522d;" > context< / span > ) ;
2021-03-19 13:49:11 +01:00
< / pre >
< / div >
2022-02-18 01:57:42 +01:00
< p >
2022-02-24 19:08:50 +01:00
The context keeps a < i > date< / i > that allows to check which data needs
2022-02-18 01:57:42 +01:00
to be recomputed. The date is incremented when the context is touched.
< / p >
< p >
When a new element is added to the context, the functions
2022-02-25 16:41:55 +01:00
< a href = "#org6e66dea" > < code > qmckl_context_create< / code > < / a > < a href = "#org303ac89" > < code > qmckl_context_destroy< / code > < / a > and < a href = "#orgae92c5f" > < code > qmckl_context_copy< / code > < / a >
2022-02-18 01:57:42 +01:00
should be updated in order to make deep copies.
< / p >
2022-02-24 19:08:50 +01:00
< p >
When the electron coordinates have changed, the context is touched
2022-02-25 16:41:55 +01:00
using the following function.
2022-02-24 19:08:50 +01:00
< / p >
2022-02-18 01:57:42 +01:00
< div class = "org-src-container" >
2022-02-24 19:08:50 +01:00
< pre class = "src src-c" > < span style = "color: #228b22;" > qmckl_exit_code< / span >
< span style = "color: #0000ff;" > qmckl_context_touch< / span > (< span style = "color: #a020f0;" > const< / span > < span style = "color: #228b22;" > qmckl_context< / span > < span style = "color: #a0522d;" > context< / span > );
2022-02-18 01:57:42 +01:00
< / pre >
< / div >
2022-02-24 19:08:50 +01:00
< p >
This has the effect to increment the date of the context.
< / p >
2021-03-19 13:49:11 +01:00
< / div >
< / div >
2022-02-25 16:41:55 +01:00
< div id = "outline-container-org6e66dea" class = "outline-3" >
< h3 id = "org6e66dea" > < span class = "section-number-3" > 1.2< / span > Creation< / h3 >
2021-03-19 13:49:11 +01:00
< div class = "outline-text-3" id = "text-1-2" >
< p >
To create a new context, < code > qmckl_context_create()< / code > should be used.
< / p >
< ul class = "org-ul" >
< li > Upon success, it returns a pointer to a new context with the < code > qmckl_context< / code > type< / li >
< li > It returns < code > QMCKL_NULL_CONTEXT< / code > upon failure to allocate the internal data structure< / li >
2021-05-26 11:42:24 +02:00
< li > A new context always has all its members initialized with a NULL value< / li >
2021-03-19 13:49:11 +01:00
< / ul >
< div class = "org-src-container" >
2022-02-24 19:08:50 +01:00
< pre class = "src src-c" > < span style = "color: #228b22;" > qmckl_context< / span > < span style = "color: #0000ff;" > qmckl_context_create< / span > ();
2021-03-19 13:49:11 +01:00
< / pre >
< / div >
< / div >
< / div >
2022-02-25 16:41:55 +01:00
< div id = "outline-container-orgae8fc83" class = "outline-3" >
< h3 id = "orgae8fc83" > < span class = "section-number-3" > 1.3< / span > Locking< / h3 >
2021-04-21 00:01:53 +02:00
< div class = "outline-text-3" id = "text-1-3" >
2021-03-19 13:49:11 +01:00
< p >
For thread safety, the context may be locked/unlocked. The lock is
initialized with the < code > PTHREAD_MUTEX_RECURSIVE< / code > attribute, and the
number of times the thread has locked it is saved in the
< code > lock_count< / code > attribute.
< / p >
< div class = "org-src-container" >
2022-02-24 19:08:50 +01:00
< pre class = "src src-c" > < span style = "color: #228b22;" > void< / span > < span style = "color: #0000ff;" > qmckl_lock< / span > (< span style = "color: #228b22;" > qmckl_context< / span > < span style = "color: #a0522d;" > context< / span > );
< span style = "color: #228b22;" > void< / span > < span style = "color: #0000ff;" > qmckl_unlock< / span > (< span style = "color: #228b22;" > qmckl_context< / span > < span style = "color: #a0522d;" > context< / span > );
2021-03-19 13:49:11 +01:00
< / pre >
< / div >
< / div >
< / div >
2022-02-25 16:41:55 +01:00
< div id = "outline-container-orgae92c5f" class = "outline-3" >
< h3 id = "orgae92c5f" > < span class = "section-number-3" > 1.4< / span > < span class = "todo TODO" > TODO< / span > Copy< / h3 >
2021-04-21 00:01:53 +02:00
< div class = "outline-text-3" id = "text-1-4" >
2021-03-19 13:49:11 +01:00
< p >
2021-04-21 00:01:53 +02:00
< code > qmckl_context_copy< / code > makes a deep copy of a context. It returns
2021-03-19 13:49:11 +01:00
< code > QMCKL_NULL_CONTEXT< / code > upon failure.
< / p >
< / div >
< / div >
2022-02-25 16:41:55 +01:00
< div id = "outline-container-org303ac89" class = "outline-3" >
< h3 id = "org303ac89" > < span class = "section-number-3" > 1.5< / span > Destroy< / h3 >
2021-04-21 00:01:53 +02:00
< div class = "outline-text-3" id = "text-1-5" >
2021-03-19 13:49:11 +01:00
< p >
The context is destroyed with < code > qmckl_context_destroy< / code > , leaving the ancestors untouched.
It frees the context, and returns the previous context.
< / p >
< div class = "org-src-container" >
2022-02-24 19:08:50 +01:00
< pre class = "src src-c" > < span style = "color: #228b22;" > qmckl_exit_code< / span >
< span style = "color: #0000ff;" > qmckl_context_destroy< / span > (< span style = "color: #a020f0;" > const< / span > < span style = "color: #228b22;" > qmckl_context< / span > < span style = "color: #a0522d;" > context< / span > );
2021-03-19 13:49:11 +01:00
< / pre >
< / div >
< / div >
< / div >
< / div >
< / div >
< div id = "postamble" class = "status" >
2021-04-30 01:35:52 +02:00
< p class = "author" > Author: TREX CoE< / p >
2022-02-25 16:41:55 +01:00
< p class = "date" > Created: 2022-02-25 Fri 15:41< / p >
2021-03-19 13:49:11 +01:00
< p class = "validation" > < a href = "http://validator.w3.org/check?uri=referer" > Validate< / a > < / p >
< / div >
< / body >
< / html >
