TREX/qmckl
1
0
Fork 0
mirror of https://github.com/TREX-CoE/qmckl.git synced 2025-01-03 18:16:28 +01:00
Code Issues Projects Releases Wiki Activity

Fix indentation of lists in documentations

Browse Source 
Line breaks in the lists of the documentation appeared in the file
preview. They have been removed so that all of its text belongs
correctly to eac bullet point.
This commit is contained in:
Aurélien Delval 2021-09-02 11:56:56 +02:00
parent e3ec28ad40
commit 703031b16f
1 changed files with 28 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
org/qmckl.org
View File

@ -285,14 +285,9 @@ cppcheck --addon=cert --enable=all *.c &> cppcheck.out
as a boolean that you are free to use or ignore.
Here are these 3 functions :
- ~qmckl_probe~ : place a normal probe witout any check. Won't do
anything when ~vfc_ci~ is disabled.
- ~qmckl_probe_check~ : place a probe with a relative check. If
~vfc_ci~ is disabled, this will return the result of a relative
check (|val - ref| / ref < accuracy target?).
- ~qmckl_probe_check~ : place a probe with an absolute check. If
~vfc_ci~ is disabled, this will return the result of an absolute
check (|val - ref| < accuracy target ?)
- ~qmckl_probe~ : place a normal probe witout any check. Won't do anything when ~vfc_ci~ is disabled.
- ~qmckl_probe_check~ : place a probe with a relative check. If ~vfc_ci~ is disabled, this will return the result of a relative check (|val - ref| / ref < accuracy target?).
- ~qmckl_probe_check~ : place a probe with an absolute check. If ~vfc_ci~ is disabled, this will return the result of an absolute check (|val - ref| < accuracy target ?)
If you need more details on these functions or their Fortran
interfaces, have a look at the ~tools/qmckl_probes~ files.
@ -301,18 +296,11 @@ cppcheck --addon=cert --enable=all *.c &> cppcheck.out
or modify an existing one, you should pay attention to the
following points :
- you should add the new kernel to the ~vfc_tests_config.json~ file,
which controls the backends and repetitions for each executable. More
details can be found in the ~vfc_ci~ documentation.
- you should add the new kernel to the ~vfc_tests_config.json~ file, which controls the backends and repetitions for each executable. More details can be found in the ~vfc_ci~ documentation.
- in order to call the ~qmckl_probes~ functions from Fortran, import
the ~qmckl_probes_f~ module. All Fortran functions are appended with
the ~_f~ suffix.
- in order to call the ~qmckl_probes~ functions from Fortran, import the ~qmckl_probes_f~ module. All Fortran functions are appended with the ~_f~ suffix.
- if your tests include some asserts that rely on accurate FP values,
you should probably wrap them inside a ~#ifndef VFC_CI~ statement, as
the asserts would otherwise risk to fail when executed with the
different Verificarlo backends.
- if your tests include some asserts that rely on accurate FP values, you should probably wrap them inside a ~#ifndef VFC_CI~ statement, as the asserts would otherwise risk to fail when executed with the different Verificarlo backends.
** Algorithms
@ -322,4 +310,3 @@ cppcheck --addon=cert --enable=all *.c &> cppcheck.out
algorithms are better adapted than linear scaling algorithms. As
QMCkl is a general purpose library, multiple algorithms should be
implemented adapted to different problem sizes.