Renamed mtlb_fminsearch into fminsearch
Michaƫl Baudin [Mon, 31 Aug 2009 13:09:57 +0000 (15:09 +0200)]
scilab/modules/optimization/help/en_US/neldermead/overview.xml
scilab/modules/optimization/help/en_US/optimbase/optimbase.xml
scilab/modules/optimization/help/en_US/optimsimplex/optimsimplex.xml
scilab/modules/optimization/macros/neldermead/fminsearch.sci
scilab/modules/optimization/macros/neldermead/optimset.sci
scilab/modules/optimization/tests/unit_tests/neldermead.tst
scilab/modules/optimization/tests/unit_tests/neldermead/fminsearch.dia.ref
scilab/modules/optimization/tests/unit_tests/neldermead/fminsearch.tst
scilab/modules/optimization/tests/unit_tests/neldermead/optimset.tst

index 34254ac..6f7b6a3 100644 (file)
@@ -43,7 +43,7 @@
   <refsection>
     <title>Design</title>
 
-    <para>The internal design of the system is based on the following
+    <para>This package provides the following
     components :</para>
 
     <itemizedlist>
@@ -72,8 +72,8 @@
       </listitem>
     </itemizedlist>
 
-    <para>The current toolbox is based on (and therefore requires) the
-    following toolboxes </para>
+    <para>The current component is based on the
+    following components </para>
 
     <itemizedlist>
       <listitem>
index 3f77592..13799dc 100644 (file)
@@ -51,10 +51,11 @@ this = optimbase_stoplog ( this , msg )
   <refsection>
     <title>Purpose</title>
 
-    <para>The goal of this toolbox is to provide a building block for
-    optimization methods. The goal is to provide a building block for a large
-    class of specialized optimization methods. This component manages
-    <itemizedlist>
+    <para>
+      The goal of this component is to provide a building block for
+      optimization methods. The goal is to provide a building block for a large
+      class of specialized optimization methods. This component manages
+      <itemizedlist>
         <listitem>
           <para>the number of variables,</para>
         </listitem>
index 1357ba8..22e7279 100644 (file)
@@ -68,9 +68,10 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
   <refsection>
     <title>Purpose</title>
 
-    <para>The goal of this toolbox is to provide a building block for
-    optimization algorithms based on a simplex. That Optimsimplex package may
-    be used in the following optimization methods :<itemizedlist>
+    <para>
+      The goal of this component is to provide a building block for
+      optimization algorithms based on a simplex. The optimsimplex package may
+      be used in the following optimization methods :<itemizedlist>
         <listitem>
           <para>the Spendley et al. simplex method,</para>
         </listitem>
@@ -85,7 +86,9 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
 
         <listitem>
           <para>the multi-dimensional search by Virginia Torczon,</para>
+        </listitem>
 
+        <listitem>
           <para>etc ...</para>
         </listitem>
       </itemizedlist></para>
index ce085cf..0e4ba92 100644 (file)
@@ -8,7 +8,7 @@
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
 //
-// mtlb_fminsearch --
+// fminsearch --
 //   Emulate the fminsearch command of Matlab.
 //   Search the minimum with Nelder-Mead algorithm.
 //   [x,fval,exitflag,output] = fminsearch(fun,x0,options)
@@ -17,9 +17,9 @@
 //   x0 : a row vector with dimension n where n is the number of parameters
 //        to optimize.
 //        Initial guess for optimization algorithm.
-//  options : an optional struct, as provided by mtlb_optimset
+//  options : an optional struct, as provided by optimset
 //
-function [x,fval,exitflag,output] = mtlb_fminsearch ( varargin )
+function [x,fval,exitflag,output] = fminsearch ( varargin )
   [lhs,rhs]=argn();
   if rhs<>2 & rhs<>3 then
     errmsg = sprintf("Unexpected number of arguments : %d provided while 2 or 3 are expected.",rhs);
@@ -30,7 +30,7 @@ function [x,fval,exitflag,output] = mtlb_fminsearch ( varargin )
   if rhs==2 then
     // No options on the command line
     // Set default values
-    options = mtlb_optimset ("fminsearch");
+    options = optimset ("fminsearch");
   elseif rhs==3 then
     // One options struc on the command line : use it !
     options = varargin(3);
index 718412b..ae35356 100644 (file)
@@ -8,14 +8,14 @@
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
 //
-// mtlb_optimset --
+// optimset --
 //   Emulate the optimset command of Matlab.
 // Usage:
-//   options = mtlb_optimset ()
-//   options = mtlb_optimset ('TolX',1e-4)
-//   options = mtlb_optimset (options,'TolX',1e-4)
+//   options = optimset ()
+//   options = optimset ('TolX',1e-4)
+//   options = optimset (options,'TolX',1e-4)
 //
-function options = mtlb_optimset (varargin)
+function options = optimset (varargin)
   [lhs,rhs]=argn();
   //mprintf("lhs\n");
   //disp(lhs);
@@ -27,7 +27,7 @@ function options = mtlb_optimset (varargin)
     // name of a method.
     //
     method = varargin(1);
-    options = mtlb_optimset_method ( method );
+    options = optimset_method ( method );
   elseif modulo(rhs,2)<>0 then
     //
     // If the number of arguments is odd,
@@ -42,7 +42,7 @@ function options = mtlb_optimset (varargin)
     // ivar is a counter of the input arguments
     ivar = 1;
   else
-    options = mtlb_optimset_new ();
+    options = optimset_new ();
     // ivar is a counter of the input arguments
     ivar = 0;
   end
@@ -58,18 +58,18 @@ function options = mtlb_optimset (varargin)
     //mprintf("Argument #%d\n",ivar);
     //mprintf("key = %s\n",key);
     //mprintf("value = %s\n",string(value)); // One cannot display a function.
-    options = mtlb_optimset_configure (options,key,value);
+    options = optimset_configure (options,key,value);
   end
 endfunction
 //
-// mtlb_optimset_configure --
+// optimset_configure --
 //   Configure the given key with the given value.
 // Arguments
 //   options : a optimset struct
 //   key : a string, the key to configure
 //   value : the value
 //
-function options = mtlb_optimset_configure ( options , key , value )
+function options = optimset_configure ( options , key , value )
     select key
     case "Display" then
       options.Display = value;
@@ -93,10 +93,10 @@ function options = mtlb_optimset_configure ( options , key , value )
     end
 endfunction
 //
-// mtlb_optimset_new --
+// optimset_new --
 //   Returns an empty optimset struct
 //
-function options = mtlb_optimset_new ()
+function options = optimset_new ()
     options = struct(...
       "Display" ,[],...
       "FunValCheck" ,[],...
@@ -109,21 +109,21 @@ function options = mtlb_optimset_new ()
       );
 endfunction
 //
-// mtlb_optimset_method --
+// optimset_method --
 //   Returns an optimset struct which content is the default 
 //   settings for the given method.
 // Arguments
 //   method : a string, the name of the method
 //
-function options = mtlb_optimset_method ( method )
-    options = mtlb_optimset_new ();
+function options = optimset_method ( method )
+    options = optimset_new ();
     select method
     case "fminsearch" then
-      options = mtlb_optimset_configure ( options , "Display" , "notify" );
-      options = mtlb_optimset_configure ( options , "MaxFunEvals" , "200*numberofvariables" );
-      options = mtlb_optimset_configure ( options , "MaxIter" , "200*numberofvariables" );
-      options = mtlb_optimset_configure ( options , "TolFun" , 1.e-4 );
-      options = mtlb_optimset_configure ( options , "TolX" , 1.e-4 );
+      options = optimset_configure ( options , "Display" , "notify" );
+      options = optimset_configure ( options , "MaxFunEvals" , "200*numberofvariables" );
+      options = optimset_configure ( options , "MaxIter" , "200*numberofvariables" );
+      options = optimset_configure ( options , "TolFun" , 1.e-4 );
+      options = optimset_configure ( options , "TolX" , 1.e-4 );
     else
       errmsg = sprintf("Unknown method %s",method)
       error(errmsg)
index 659ded8..3ec845b 100644 (file)
@@ -6,8 +6,8 @@
 // =============================================================================
 
 utdir = SCI+"/modules/optimization/tests/unit_tests/neldermead"
-exec(utdir+"/mtlb_fminsearch.tst")
-exec(utdir+"/mtlb_optimset.tst")
+exec(utdir+"/fminsearch.tst")
+exec(utdir+"/optimset.tst")
 exec(utdir+"/neldermead_configure.tst")
 exec(utdir+"/neldermead_display.tst")
 exec(utdir+"/neldermead_mckinnon.tst")
index ce8b3e4..4c3d1da 100644 (file)
@@ -45,7 +45,7 @@ endfunction
 function y = banana (x)
   y = 100*(x(2)-x(1)^2)^2 + (1-x(1))^2;
 endfunction
-[x , fval , exitflag , output] = mtlb_fminsearch ( banana , [-1.2 1] );
+[x , fval , exitflag , output] = fminsearch ( banana , [-1.2 1] );
 assert_close ( x , [1.000022021783570   1.000042219751772], 1e-4 );
 assert_close ( fval , 0.0 , 1e-4 );
 assert_equal ( output.iterations , 85 );
index be0cfbe..47e3aca 100644 (file)
@@ -46,7 +46,7 @@ endfunction
 function y = banana (x)
   y = 100*(x(2)-x(1)^2)^2 + (1-x(1))^2;
 endfunction
-[x , fval , exitflag , output] = mtlb_fminsearch ( banana , [-1.2 1] );
+[x , fval , exitflag , output] = fminsearch ( banana , [-1.2 1] );
 assert_close ( x , [1.000022021783570   1.000042219751772], 1e-4 );
 assert_close ( fval , 0.0 , 1e-4 );
 assert_equal ( output.iterations , 85 );
index d501049..c6ffc92 100644 (file)
@@ -10,7 +10,7 @@
 // 
 // Test #1 : Without parameters 
 //
-op = mtlb_optimset ();
+op = optimset ();
 if op.Display <> [] then pause,end
 if op.FunValCheck <> [] then pause,end
 if op.MaxFunEvals <> [] then pause,end
@@ -29,7 +29,7 @@ endfunction
 // 
 // Test #2 : With parameters
 //
-op = mtlb_optimset (...
+op = optimset (...
   'Display','iter',...
   "FunValCheck","on",...
   "MaxFunEvals",100,...
@@ -51,8 +51,8 @@ clear op
 // 
 // Test #3 : Copy one option set into another
 // 
-op1 = mtlb_optimset ("TolFun",1.e-12);
-op2 = mtlb_optimset (op1,"TolX",1.e-13);
+op1 = optimset ("TolFun",1.e-12);
+op2 = optimset (op1,"TolX",1.e-13);
 if op2.TolFun <> 1.e-12 then pause,end
 if op2.TolX <> 1.e-13 then pause,end
 clear op1
@@ -60,7 +60,7 @@ clear op2
 // 
 // Test #3 : with one method name
 // 
-op = mtlb_optimset ("fminsearch");
+op = optimset ("fminsearch");
 if op.TolFun <> 1.e-4 then pause,end
 if op.TolX <> 1.e-4 then pause,end
 if op.Display <> "notify" then pause,end