The qmckl.h header file installed in the ${prefix}/include directory
@@ -385,12 +385,12 @@ Both files are located in the include/ directory.
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.
For a tutorial on literate programming with org-mode, follow this link. @@ -467,8 +467,8 @@ org-mode.
Most of the codes of the TREX CoE are written in Fortran with some scripts in @@ -516,8 +516,8 @@ For more guidelines on using Fortran to generate a C interface, see
The authors should follow the recommendations of the C99
@@ -535,8 +535,8 @@ Compliance can be checked with cppcheck as:
The proposed API should allow the library to: deal with memory transfers @@ -547,8 +547,8 @@ functions (see below).
To avoid namespace collisions, we use qmckl_ as a prefix for all exported
@@ -573,8 +573,8 @@ form is allowed.
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.
Global variables should be avoided in the library, because it is
possible that one single program needs to use multiple instances
of the library. To solve this problem we propose to use a pointer
to a context variable, built by the library with the
-qmckl_context_create function. The =context= contains the global
+qmckl_context_create function. The =context= contains the global
state of the library, and is used as the first argument of many
QMCkl functions.
A single qmckl.h header to be distributed by the library
@@ -717,8 +717,8 @@ and the types definitions should be written in the *fh_type.f90 fil
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).
These functions are pure, and unaware of the QMCkl
-context. They are not allowed to allocate/deallocate memory, and
+context. They are not allowed to allocate/deallocate memory, and
if they need temporary memory it should be provided in input.
High-level functions are at the top of the function call tree. @@ -747,20 +747,20 @@ temporary storage, to simplify the use of accelerators.
The high-level functions should be pure, unless the introduction
of non-purity is justified. All the side effects should be made in
-the context variable.
+the context variable.
The number of bits of precision required for a function should be
given as an input of low-level computational functions. This input
will be used to define the values of the different thresholds that
might be used to avoid computing unnecessary noise. High-level
-functions will use the precision specified in the context
+functions will use the precision specified in the context
variable.
Reducing the scaling of an algorithm usually implies also reducing @@ -847,7 +847,7 @@ implemented adapted to different problem sizes.
The atomic basis set is defined as a list of shells. Each shell \(s\) is @@ -432,19 +432,19 @@ gradients and Laplacian of the atomic basis functions.
The following arrays are stored in the context, and need to be set when initializing the library:
-typedef struct qmckl_determinant_struct { @@ -598,8 +598,8 @@ this mechanism.
When all the data for the slater determinants have been provided, the following
@@ -613,8 +613,8 @@ function returns true.
To set the basis set, all the following functions need to be @@ -638,24 +638,24 @@ computed to accelerate the calculations.
qmckl_exit_code qmckl_get_det_vgl_alpha(qmckl_context context, double* const det_vgl_alpha); @@ -665,14 +665,14 @@ computed to accelerate the calculations.
context is not QMCKL_NULL_CONTEXT[n][3] in C and (3,n) in Fortra
qmckl_exit_code qmckl_distance ( @@ -834,8 +834,8 @@ the leading dimension:[n][3]in C and(3,n)in Fortra
integer function qmckl_distance_f(context, transa, transb, m, n, & @@ -1002,8 +1002,8 @@ the leading dimension:[n][3]in C and(3,n)in Fortra
This function is more efficient when A and B are transposed.
@@ -1013,12 +1013,12 @@ This function is more efficient when A and B are trans
qmckl_distance_rescaledqmckl_distance_rescaled
qmckl_distance_rescaled computes the matrix of the rescaled distances between all
@@ -1036,7 +1036,7 @@ If the input array is normal ('N'), the xyz coordinates are in
the leading dimension: [n][3] in C and (3,n) in Fortran.
context is not QMCKL_NULL_CONTEXT[n][3] in C and (3,n) in Fortra
qmckl_exit_code qmckl_distance_rescaled ( @@ -1185,8 +1185,8 @@ the leading dimension:[n][3]in C and(3,n)in Fortra
integer function qmckl_distance_rescaled_f(context, transa, transb, m, n, & @@ -1356,8 +1356,8 @@ the leading dimension:[n][3]in C and(3,n)in Fortra
This function is more efficient when A and B are transposed.
@@ -1366,12 +1366,12 @@ This function is more efficient when A and B are trans
qmckl_distance_rescaled_deriv_eqmckl_distance_rescaled_deriv_e
qmckl_distance_rescaled_deriv_e computes the matrix of the gradient and laplacian of the
@@ -1438,7 +1438,7 @@ If the input array is normal ('N'), the xyz coordinates are in
the leading dimension: [n][3] in C and (3,n) in Fortran.