examples/test_functions: Polish doc

* examples/test_functions/stk_testfun_braninhoo.m: Polish doc. * examples/test_functions/stk_testfun_goldsteinprice.m: Idem. * examples/test_functions/stk_testfun_hartman3.m: Idem. * examples/test_functions/stk_testfun_hartman6.m: Idem.
stk-kriging · Oct 27, 2024 · f876eaf · f876eaf
1 parent 449a98e
commit f876eaf
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 0 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,12 @@
+2024-10-27  Julien Bect  <[email protected]>
+
+	examples/test_functions: Polish doc
+
+	* examples/test_functions/stk_testfun_braninhoo.m: Polish doc.
+	* examples/test_functions/stk_testfun_goldsteinprice.m: Idem.
+	* examples/test_functions/stk_testfun_hartman3.m: Idem.
+	* examples/test_functions/stk_testfun_hartman6.m: Idem.
+
 2024-10-20  Julien Bect  <[email protected]>
 
 	Source formatting, unit test

diff --git a/examples/test_functions/stk_testfun_braninhoo.m b/examples/test_functions/stk_testfun_braninhoo.m
@@ -1,5 +1,9 @@
 % STK_TESTFUN_BRANINHOO computes the Branin-Hoo function.
 %
+% CALL: Y = stk_testfun_braninhoo (X)
+%
+%    computes the value Y of the Branin-Hoo function at X.
+%
 %    The Branin-Hoo function (Branin and Hoo, 1972) is a classical test
 %    function for global optimization algorithms, which belongs to the
 %    well-known Dixon-Szego test set (Dixon and Szego, 1978). It is usually

diff --git a/examples/test_functions/stk_testfun_goldsteinprice.m b/examples/test_functions/stk_testfun_goldsteinprice.m
@@ -1,5 +1,9 @@
 % STK_TESTFUN_GOLDSTEINPRICE computes the Goldstein-Price function
 %
+% CALL: Y = stk_testfun_goldsteinprice (X)
+%
+%    computes the value Y of the Goldstein-Price function at X.
+%
 %    The Goldstein-Price function [1] is a classical test function for
 %    global optimization algorithms, which belongs to the well-known
 %    Dixon-Szego test set [2].

diff --git a/examples/test_functions/stk_testfun_hartman3.m b/examples/test_functions/stk_testfun_hartman3.m
@@ -1,5 +1,9 @@
 % STK_TESTFUN_HARTMAN3 computes the "Hartman3" function
 %
+% CALL: Y = stk_testfun_hartman3 (X)
+%
+%    computes the value Y of the Hartman3 function at X.
+%
 %    The Hartman3 function is a test function in dimension 3, which is
 %    part of the famous Dixon & Szego benchmark [1] in global optimization.
 %

diff --git a/examples/test_functions/stk_testfun_hartman6.m b/examples/test_functions/stk_testfun_hartman6.m
@@ -1,5 +1,9 @@
 % STK_TESTFUN_HARTMAN6 computes the "Hartman6" function
 %
+% CALL: Y = stk_testfun_hartman6 (X)
+%
+%    computes the value Y of the Hartman6 function at X.
+%
 %    The Hartman6 function is a test function in dimension 6, which is
 %    part of the famous Dixon & Szego benchmark [1] in global optimization.
 %