diff --git a/org/qmckl.org b/org/qmckl.org index 9927b73..e46b2bd 100644 --- a/org/qmckl.org +++ b/org/qmckl.org @@ -285,9 +285,10 @@ 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 (false is returned). + - ~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 the check fails, true is returned (false otherwise). + - ~qmckl_probe_check_relative~ : 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?). If the check fails, true is returned (false otherwise). + If you need more details on these functions or their Fortran interfaces, have a look at the ~tools/qmckl_probes~ files. @@ -298,7 +299,7 @@ cppcheck --addon=cert --enable=all *.c &> cppcheck.out - 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. - 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.