Xcos tests & doc: minor fix and simpler variables

Remove 'Run with' comments because they won't be valid if files move.

Turned constants such as "3*10^-3" into 'real constants' "3d-3" for faster comprehension.

Change-Id: I30a13d52d6856b5e1221f4c8d6dd6e7a3fc8dbaf

diff --git a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Bouncing.dia.ref b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Bouncing.dia.ref
index ea4557a..ebeb7b7 100644 (file)
--- a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Bouncing.dia.ref
+++ b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Bouncing.dia.ref
@@ -79,6 +79,6 @@ mea = mean(compa);
 [maxi, indexMaxi] = max(compa);
 stdeviation = st_deviation(compa);
 // Verifying closeness of the results
-assert_checktrue(maxi <= 5*10^-(5));
-assert_checktrue(mea <= 5*10^-(5));
-assert_checktrue(stdeviation <= 5*10^-(5));
+assert_checktrue(maxi <= 5d-5);
+assert_checktrue(mea <= 5d-5);
+assert_checktrue(stdeviation <= 5d-5);

diff --git a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Bouncing.tst b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Bouncing.tst
index 607b2cf..f61423c 100644 (file)
--- a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Bouncing.tst
+++ b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Bouncing.tst
@@ -40,6 +40,6 @@ mea = mean(compa);
 stdeviation = st_deviation(compa);
 
 // Verifying closeness of the results
-assert_checktrue(maxi <= 5*10^-(5));
-assert_checktrue(mea <= 5*10^-(5));
-assert_checktrue(stdeviation <= 5*10^-(5));
+assert_checktrue(maxi <= 5d-5);
+assert_checktrue(mea <= 5d-5);
+assert_checktrue(stdeviation <= 5d-5);

diff --git a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Hydraulics.dia.ref b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Hydraulics.dia.ref
index 8ba2ba4..7bfab2d 100644 (file)
--- a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Hydraulics.dia.ref
+++ b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Hydraulics.dia.ref
@@ -117,6 +117,6 @@ mea = mean(compa);
 [maxi, indexMaxi] = max(compa);
 stdeviation = st_deviation(compa);
 // Verifying closeness of the results
-assert_checktrue(maxi <= 2*10^-(6));
-assert_checktrue(mea <= 2*10^-(6));
-assert_checktrue(stdeviation <= 2*10^-(6));
+assert_checktrue(maxi <= 2d-6);
+assert_checktrue(mea <= 2d-6);
+assert_checktrue(stdeviation <= 2d-6);

diff --git a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Hydraulics.tst b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Hydraulics.tst
index 3b989df..51b8ca2 100644 (file)
--- a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Hydraulics.tst
+++ b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrK_Hydraulics.tst
@@ -39,6 +39,6 @@ mea = mean(compa);
 stdeviation = st_deviation(compa);
 
 // Verifying closeness of the results
-assert_checktrue(maxi <= 2*10^-(6));
-assert_checktrue(mea <= 2*10^-(6));
-assert_checktrue(stdeviation <= 2*10^-(6));
+assert_checktrue(maxi <= 2d-6);
+assert_checktrue(mea <= 2d-6);
+assert_checktrue(stdeviation <= 2d-6);

diff --git a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Bouncing.dia.ref b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Bouncing.dia.ref
index 3a4cba6..60547b8 100644 (file)
--- a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Bouncing.dia.ref
+++ b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Bouncing.dia.ref
@@ -46,7 +46,7 @@ Info = scicos_simulate(scs_m, list());
 !                                                         !
 !                                                         !
 !                                                         !
-!Generated files path: TMPDIR/         !
+!Generated files path: TMPDIR/           !
 !                                                         !
 !                                                         !
    Generate a loader file
@@ -79,6 +79,6 @@ mea = mean(compa);
 [maxi, indexMaxi] = max(compa);
 stdeviation = st_deviation(compa);
 // Verifying closeness of the results
-assert_checktrue(maxi <= 10^-(12));
-assert_checktrue(mea <= 10^-(12));
-assert_checktrue(stdeviation <= 10^-(12));
+assert_checktrue(maxi <= 1d-12);
+assert_checktrue(mea <= 1d-12);
+assert_checktrue(stdeviation <= 1d-12);

diff --git a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Bouncing.tst b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Bouncing.tst
index 14313bc..5fa85e4 100644 (file)
--- a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Bouncing.tst
+++ b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Bouncing.tst
@@ -40,6 +40,6 @@ mea = mean(compa);
 stdeviation = st_deviation(compa);
 
 // Verifying closeness of the results
-assert_checktrue(maxi <= 10^-(12));
-assert_checktrue(mea <= 10^-(12));
-assert_checktrue(stdeviation <= 10^-(12));
+assert_checktrue(maxi <= 1d-12);
+assert_checktrue(mea <= 1d-12);
+assert_checktrue(stdeviation <= 1d-12);

diff --git a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Hydraulics.dia.ref b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Hydraulics.dia.ref
index 5573f0b..1bb65a6 100644 (file)
--- a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Hydraulics.dia.ref
+++ b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Hydraulics.dia.ref
@@ -48,7 +48,7 @@ scicos_simulate(scs_m);   // DDaskr
 !                                                         !
 !                                                         !
 !                                                         !
-!Generated files path: TMPDIR/         !
+!Generated files path: TMPDIR/          !
 !                                                         !
 !                                                         !
    Generate a loader file
@@ -96,7 +96,7 @@ scicos_simulate(scs_m);   // IDA
 !                                                         !
 !                                                         !
 !                                                         !
-!Generated files path: TMPDIR/         !
+!Generated files path: TMPDIR/          !
 !                                                         !
 !                                                         !
    Generate a loader file
@@ -117,6 +117,6 @@ mea = mean(compa);
 [maxi, indexMaxi] = max(compa);
 stdeviation = st_deviation(compa);
 // Verifying closeness of the results
-assert_checktrue(maxi <= 2*10^-(7));
-assert_checktrue(mea <= 2*10^-(7));
-assert_checktrue(stdeviation <= 2*10^-(7));
+assert_checktrue(maxi <= 2d-7);
+assert_checktrue(mea <= 2d-7);
+assert_checktrue(stdeviation <= 2d-7);

diff --git a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Hydraulics.tst b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Hydraulics.tst
index f6335b2..4780eb5 100644 (file)
--- a/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Hydraulics.tst
+++ b/scilab/modules/scicos/tests/unit_tests/Solvers/DDaskrN_Hydraulics.tst
@@ -39,6 +39,6 @@ mea = mean(compa);
 stdeviation = st_deviation(compa);
 
 // Verifying closeness of the results
-assert_checktrue(maxi <= 2*10^-(7));
-assert_checktrue(mea <= 2*10^-(7));
-assert_checktrue(stdeviation <= 2*10^-(7));
+assert_checktrue(maxi <= 2d-7);
+assert_checktrue(mea <= 2d-7);
+assert_checktrue(stdeviation <= 2d-7);

diff --git a/scilab/modules/scicos/tests/unit_tests/Solvers/LSodar.dia.ref b/scilab/modules/scicos/tests/unit_tests/Solvers/LSodar.dia.ref
index 89d2429..214704a 100644 (file)
--- a/scilab/modules/scicos/tests/unit_tests/Solvers/LSodar.dia.ref
+++ b/scilab/modules/scicos/tests/unit_tests/Solvers/LSodar.dia.ref
@@ -24,6 +24,6 @@ mea = mean(compa);
 [maxi, indexMaxi] = max(compa);
 stdeviation = st_deviation(compa);
 // Verifying closeness of the results
-assert_checktrue(maxi <= 10^-8);
-assert_checktrue(mea <= 10^-8);
-assert_checktrue(stdeviation <= 10^-8);
+assert_checktrue(maxi <= 1d-8);
+assert_checktrue(mea <= 1d-8);
+assert_checktrue(stdeviation <= 1d-8);

diff --git a/scilab/modules/scicos/tests/unit_tests/Solvers/LSodar.tst b/scilab/modules/scicos/tests/unit_tests/Solvers/LSodar.tst
index 13ba90c..b887f6c 100644 (file)
--- a/scilab/modules/scicos/tests/unit_tests/Solvers/LSodar.tst
+++ b/scilab/modules/scicos/tests/unit_tests/Solvers/LSodar.tst
@@ -31,6 +31,6 @@ mea = mean(compa);
 stdeviation = st_deviation(compa);
 
 // Verifying closeness of the results
-assert_checktrue(maxi <= 10^-8);
-assert_checktrue(mea <= 10^-8);
-assert_checktrue(stdeviation <= 10^-8);
+assert_checktrue(maxi <= 1d-8);
+assert_checktrue(mea <= 1d-8);
+assert_checktrue(stdeviation <= 1d-8);

diff --git a/scilab/modules/xcos/examples/solvers/Rootfinding.sce b/scilab/modules/xcos/examples/solvers/Rootfinding.sce
index 6f791d7..b995bb2 100644 (file)
--- a/scilab/modules/xcos/examples/solvers/Rootfinding.sce
+++ b/scilab/modules/xcos/examples/solvers/Rootfinding.sce
@@ -3,8 +3,6 @@
 //
 // This file is released under the 3-clause BSD license. See COPYING-BSD.
 
-// Run with exec("SCI/modules/xcos/examples/solvers/Rootfinding.sce");
-
 // Import the "with-ZC" diagram and augment the ending time
 loadScicos();
 loadXcosLibs();
@@ -12,8 +10,8 @@ importXcosDiagram("SCI/modules/xcos/examples/solvers/with_ZeroCrossing.zcos");
 scs_m.props.tf = 30000;
 
 // Set tolerances and select LSodar
-scs_m.props.tol(1) = 1.0e-13;
-scs_m.props.tol(2) = 1.0e-13;
+scs_m.props.tol(1) = 1d-13;
+scs_m.props.tol(2) = 1d-13;
 scs_m.props.tol(6) = 0;
 
 // Start the timer, launch the simulation and display time
@@ -27,8 +25,8 @@ importXcosDiagram("SCI/modules/xcos/examples/solvers/without_ZeroCrossing.zcos")
 scs_m.props.tf = 30000;
 
 // Set tolerances and select LSodar
-scs_m.props.tol(1) = 1.0e-13;
-scs_m.props.tol(2) = 1.0e-13;
+scs_m.props.tol(1) = 1d-13;
+scs_m.props.tol(2) = 1d-13;
 scs_m.props.tol(6) = 0;
 
 // Start the timer, launch the simulation and display time

diff --git a/scilab/modules/xcos/examples/solvers/RootfindingSimple.sce b/scilab/modules/xcos/examples/solvers/RootfindingSimple.sce
index a499a06..37f2353 100644 (file)
--- a/scilab/modules/xcos/examples/solvers/RootfindingSimple.sce
+++ b/scilab/modules/xcos/examples/solvers/RootfindingSimple.sce
@@ -3,8 +3,6 @@
 //
 // This file is released under the 3-clause BSD license. See COPYING-BSD.
 
-// Run with exec("SCI/modules/xcos/examples/solvers/RootfindingSimple.sce");
-
 // Import the "with-ZC" diagram and augment the ending time
 loadScicos();
 loadXcosLibs();
@@ -12,8 +10,8 @@ importXcosDiagram("SCI/modules/xcos/examples/solvers/with_ZeroCrossingSimple.zco
 scs_m.props.tf = 30;
 
 // Set tolerances and select LSodar
-scs_m.props.tol(1) = 1.0e-7;
-scs_m.props.tol(2) = 1.0e-7;
+scs_m.props.tol(1) = 1d-7;
+scs_m.props.tol(2) = 1d-7;
 scs_m.props.tol(6) = 0;
 
 // Start the timer, launch the simulation and display time
@@ -27,8 +25,8 @@ importXcosDiagram("SCI/modules/xcos/examples/solvers/without_ZeroCrossingSimple.
 scs_m.props.tf = 30;
 
 // Set tolerances and select LSodar
-scs_m.props.tol(1) = 1.0e-7;
-scs_m.props.tol(2) = 1.0e-7;
+scs_m.props.tol(1) = 1d-7;
+scs_m.props.tol(2) = 1d-7;
 scs_m.props.tol(6) = 0;
 
 // Start the timer, launch the simulation and display time

diff --git a/scilab/modules/xcos/examples/solvers/benchBasic.sce b/scilab/modules/xcos/examples/solvers/benchBasic.sce
index 1336469..f26cbae 100644 (file)
--- a/scilab/modules/xcos/examples/solvers/benchBasic.sce
+++ b/scilab/modules/xcos/examples/solvers/benchBasic.sce
@@ -3,8 +3,6 @@
 //
 // This file is released under the 3-clause BSD license. See COPYING-BSD.
 
-// Run with exec("SCI/modules/xcos/examples/solvers/benchBasic.sce");
-
 // Import the diagram, augment the ending time and store its compilation in Info()
 loadScicos();
 loadXcosLibs();
@@ -12,8 +10,8 @@ importXcosDiagram("SCI/modules/xcos/demos/Controller.zcos");
 Info = scicos_simulate(scs_m, "nw");
 tf = 4000;
 tolerances = scs_m.props.tol;
-tolerances(1) = 10^(-13);
-tolerances(2) = 10^(-13);
+tolerances(1) = 1d-13;
+tolerances(2) = 1d-13;
 [%tcur, %cpr, alreadyran, needstart, needcompile, %state0] = Info(:);
 
 solverName = ["LSodar", "CVode BDF/Newton", "CVode BDF/Functional", "CVode Adams/Newton", "CVode Adams/Functional", "Dormand-Prince", "Runge-Kutta", "implicit Runge-Kutta"];
@@ -25,7 +23,7 @@ for solver = 0:7
     tolerances(6) = solver;
 
     // Modify 'Max step size' if RK-based solver
-    if (solver >= 5) then tolerances(7) = 3*10^(-2); end
+    if (solver >= 5) then tolerances(7) = 0.03; end
 
     // Start the solver
     [state, t] = scicosim(%state0, 0.0, tf, %cpr.sim, "start", tolerances);
@@ -41,4 +39,3 @@ for solver = 0:7
 
 end
 disp("--------------------------------");
-

diff --git a/scilab/modules/xcos/examples/solvers/benchKalman.sce b/scilab/modules/xcos/examples/solvers/benchKalman.sce
index 9c828d2..043c832 100644 (file)
--- a/scilab/modules/xcos/examples/solvers/benchKalman.sce
+++ b/scilab/modules/xcos/examples/solvers/benchKalman.sce
@@ -3,8 +3,6 @@
 //
 // This file is released under the 3-clause BSD license. See COPYING-BSD.
 
-// Run with exec("SCI/modules/xcos/examples/solvers/benchKalman.sce");
-
 // Import the diagram, augment the ending time and store its compilation in Info()
 loadScicos();
 loadXcosLibs();
@@ -12,8 +10,8 @@ importXcosDiagram("SCI/modules/xcos/demos/Kalman.zcos");
 Info = scicos_simulate(scs_m, "nw");
 tf = 1050;
 tolerances = scs_m.props.tol;
-tolerances(1) = 10^(-13);
-tolerances(2) = 10^(-13);
+tolerances(1) = 1d-13;
+tolerances(2) = 1d-13;
 [%tcur, %cpr, alreadyran, needstart, needcompile, %state0] = Info(:);
 
 solverName = ["LSodar", "CVode BDF/Newton", "CVode BDF/Functional", "CVode Adams/Newton", "CVode Adams/Functional", "Dormand-Prince", "Runge-Kutta", "implicit Runge-Kutta"];
@@ -25,11 +23,11 @@ for solver = 0:7
     tolerances(6) = solver;
 
     // Modify 'Max step size' if RK-based solver
-    if (solver >= 5) then tolerances(7) = 3*10^(-2); end
+    if (solver >= 5) then tolerances(7) = 0.03; end
 
-    // Implicit RK does not support tolerances above 10^-(11) for this diagram
-    if (solver >= 7) then tolerances(1) = 10^(-10); end
-    if (solver >= 7) then tolerances(2) = 10^(-10); end
+    // Implicit RK does not support tolerances above 10^-11 for this diagram
+    if (solver >= 7) then tolerances(1) = 1d-10; end
+    if (solver >= 7) then tolerances(2) = 1d-10; end
 
     // Start the solver
     [state, t] = scicosim(%state0, 0.0, tf, %cpr.sim, "start", tolerances);
@@ -45,4 +43,3 @@ for solver = 0:7
 
 end
 disp("--------------------------------");
-

diff --git a/scilab/modules/xcos/examples/solvers/benchSine.sce b/scilab/modules/xcos/examples/solvers/benchSine.sce
index db9118e..4c16415 100644 (file)
--- a/scilab/modules/xcos/examples/solvers/benchSine.sce
+++ b/scilab/modules/xcos/examples/solvers/benchSine.sce
@@ -21,7 +21,7 @@ for solver = 0:7
     tolerances(6) = solver;
 
     // Modify 'Max step size' if RK-based solver
-    if (solver >= 5) then tolerances(7) = 10^(-2); end
+    if (solver >= 5) then tolerances(7) = 0.01; end
 
     // Start the solver
     [state, t] = scicosim(%state0, 0.0, tf, %cpr.sim, "start", tolerances);

diff --git a/scilab/modules/xcos/examples/solvers/integCVode.sce b/scilab/modules/xcos/examples/solvers/integCVode.sce
index f5c353a..808fd1d 100644 (file)
--- a/scilab/modules/xcos/examples/solvers/integCVode.sce
+++ b/scilab/modules/xcos/examples/solvers/integCVode.sce
@@ -3,8 +3,6 @@
 //
 // This file is released under the 3-clause BSD license. See COPYING-BSD.
 
-// Run with exec("SCI/modules/xcos/examples/solvers/integ.sce");
-
 // Import the diagram and augment the ending time
 loadScicos();
 loadXcosLibs();

diff --git a/scilab/modules/xcos/examples/solvers/integDoPri.sce b/scilab/modules/xcos/examples/solvers/integDoPri.sce
index a51b39c..d17da15 100644 (file)
--- a/scilab/modules/xcos/examples/solvers/integDoPri.sce
+++ b/scilab/modules/xcos/examples/solvers/integDoPri.sce
@@ -3,8 +3,6 @@
 //
 // This file is released under the 3-clause BSD license. See COPYING-BSD.
 
-// Run with exec("SCI/modules/xcos/examples/solvers/integDoPri.sce");
-
 // Import the diagram and augment the ending time
 loadScicos();
 loadXcosLibs();

diff --git a/scilab/modules/xcos/examples/solvers/integImpRK.sce b/scilab/modules/xcos/examples/solvers/integImpRK.sce
index d3a18a9..a217918 100644 (file)
--- a/scilab/modules/xcos/examples/solvers/integImpRK.sce
+++ b/scilab/modules/xcos/examples/solvers/integImpRK.sce
@@ -3,8 +3,6 @@
 //
 // This file is released under the 3-clause BSD license. See COPYING-BSD.
 
-// Run with exec("SCI/modules/xcos/examples/solvers/integRK.sce");
-
 // Import the diagram and augment the ending time
 loadScicos();
 loadXcosLibs();
@@ -20,7 +18,7 @@ for solver=1:5
     if (solver == 5) then scs_m.props.tol(6) = 7; end
 
     // Set max step size and reltol if implicit Runge-Kutta
-    if (solver == 5) then scs_m.props.tol(7) = 0.01; scs_m.props.tol(2) = 1.0e-10; end
+    if (solver == 5) then scs_m.props.tol(7) = 0.01; scs_m.props.tol(2) = 1d-10; end
 
     // Start the timer, launch the simulation and display time
     tic();

diff --git a/scilab/modules/xcos/examples/solvers/integLSodar.sce b/scilab/modules/xcos/examples/solvers/integLSodar.sce
index 269ed1d..1f162a4 100644 (file)
--- a/scilab/modules/xcos/examples/solvers/integLSodar.sce
+++ b/scilab/modules/xcos/examples/solvers/integLSodar.sce
@@ -3,8 +3,6 @@
 //
 // This file is released under the 3-clause BSD license. See COPYING-BSD.
 
-// Run with exec("SCI/modules/xcos/examples/solvers/integLSodar.sce");
-
 // Import the diagram and augment the ending time
 loadScicos();
 loadXcosLibs();

diff --git a/scilab/modules/xcos/examples/solvers/integRK.sce b/scilab/modules/xcos/examples/solvers/integRK.sce
index a53a127..3dd0672 100644 (file)
--- a/scilab/modules/xcos/examples/solvers/integRK.sce
+++ b/scilab/modules/xcos/examples/solvers/integRK.sce
@@ -3,8 +3,6 @@
 //
 // This file is released under the 3-clause BSD license. See COPYING-BSD.
 
-// Run with exec("SCI/modules/xcos/examples/solvers/integRK.sce");
-
 // Import the diagram and augment the ending time
 loadScicos();
 loadXcosLibs();