various corrections on help pages
Yann Collette [Tue, 8 Sep 2009 09:55:45 +0000 (11:55 +0200)]
scilab/modules/development_tools/help/en_US/test_run.xml
scilab/modules/optimization/help/en_US/neldermead/fminsearch.xml
scilab/modules/optimization/help/en_US/neldermead/neldermead.xml
scilab/modules/optimization/help/en_US/neldermead/optimget.xml
scilab/modules/optimization/help/en_US/neldermead/optimset.xml
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/string/help/en_US/strsplit.xml

index 749e2b3..d4a1bb6 100644 (file)
@@ -98,8 +98,7 @@
    control the processing of the corresponding test. These tags
    are expected to be found in Scilab comments.
    </para>
-    <para>
-   These are the available tags :
+    <para>These are the available tags :</para>
    <itemizedlist>
      <listitem>
        <para>
        </para>
        </listitem>
      </itemizedlist>
-   </para>
    
     <para>
    Each test is executed in a separated process, created with the "host" command.
index 8fdf9c4..84bf26e 100644 (file)
@@ -1,6 +1,6 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <!--
- * Ajouter ici d'éventuels commentaires sur le fichier XML
+ * Ajouter ici d'éventuels commentaires sur le fichier XML
 -->
 <refentry version="5.0-subset Scilab" xml:id="fminsearch" xml:lang="fr"
           xmlns="http://docbook.org/ns/docbook"
 
   <refsection>
     <title>Design</title>
-    <para>
-      This function is based on a specialized use of the more general
-      <link linkend="neldermead">neldermead</link> component. Users which want to have a more flexible solution
-      based on direct search algorithms should consider using the neldermead
-      component instead of the fminsearch function.
-    </para>
+
+    <para>This function is based on a specialized use of the more general
+    <link linkend="neldermead">neldermead</link> component. Users which want
+    to have a more flexible solution based on direct search algorithms should
+    consider using the neldermead component instead of the fminsearch
+    function.</para>
   </refsection>
 
   <refsection>
 
     <para>If both the following conditions</para>
 
-    <programlisting role="example">ssize &lt; options.TolX</programlisting>
+    <programlisting role="example"><![CDATA[ 
+ssize < options.TolX
+ ]]></programlisting>
 
     <para>and</para>
 
-    <programlisting role="example">shiftfv &lt; options.TolFun</programlisting>
+    <programlisting role="example"><![CDATA[ 
+shiftfv < options.TolFun
+ ]]></programlisting>
 
     <para>are true, then the iterations stop.</para>
 
     <para>In this section, we present the default values for the number of
     iterations in fminsearch.</para>
 
-    <para>The <parameter>options</parameter> input argument is an optionnal
-    data structure which can contain the
-    <parameter>options.MaxIter</parameter> field. It stores the maximum number
-    of iterations. The default value is 200n, where n is the number of
-    variables. The factor 200 has not been chosen by chance, but is the result
-    of experiments performed against quadratic functions with increasing space
-    dimension.</para>
+    <para>The <emphasis>options</emphasis> input argument is an optionnal data
+    structure which can contain the <emphasis>options.MaxIter</emphasis>
+    field. It stores the maximum number of iterations. The default value is
+    200n, where n is the number of variables. The factor 200 has not been
+    chosen by chance, but is the result of experiments performed against
+    quadratic functions with increasing space dimension.</para>
 
     <para>This result is presented in "Effect of dimensionality on the
     nelder-mead simplex method" by Lixing Han and Michael Neumann. This paper
     "banana", and then use the fminsearch function to search the minimum,
     starting with the initial guess [-1.2 1.0].</para>
 
-    <programlisting role="example">
-      function y = banana (x)
-      y = 100*(x(2)-x(1)^2)^2 + (1-x(1))^2;
-      endfunction
-      [x , fval , exitflag , output] = fminsearch ( banana , [-1.2 1] );
-    </programlisting>
+    <programlisting role="example"><![CDATA[ 
+function y = banana (x)
+  y = 100*(x(2)-x(1)^2)^2 + (1-x(1))^2;
+endfunction
+[x, fval, exitflag, output] = fminsearch(banana, [-1.2 1]);
+ ]]></programlisting>
   </refsection>
 
   <refsection>
     <title>Bibliography</title>
 
-    <para>
-      "Sequential Application of Simplex Designs in Optimisation and
-      Evolutionary Operation", Spendley, W. and Hext, G. R. and Himsworth, F.
-      R., American Statistical Association and American Society for Quality,
-      1962
-    </para>
-
-    <para>
-      "A Simplex Method for Function Minimization", Nelder, J. A. and
-      Mead, R., The Computer Journal, 1965
-    </para>
-
-    <para>
-      "Iterative Methods for Optimization", C. T. Kelley, SIAM Frontiers
-      in Applied Mathematics, 1999
-    </para>
-
-    <para>
-      "Algorithm AS47 - Function minimization using a simplex procedure",
-      O'Neill, R., Applied Statistics, 1971
-    </para>
-
-    <para>
-      "Effect of dimensionality on the nelder-mead simplex method", Lixing
-      Han and Michael Neumann, Optimization Methods and Software, 21, 1, 1--16,
-      2006.
-    </para>
-
-    <para>
-      "Algorithms in Unconstrained Optimization", Lixing Han, Ph.D., The
-      University of Connecticut, 2000.
-    </para>
-
-    <para>
-      "Global Optimization Of Lennard-Jones Atomic Clusters"
-      Ellen Fan, Thesis, February 26, 2002, McMaster University
-    </para>
+    <para>"Sequential Application of Simplex Designs in Optimisation and
+    Evolutionary Operation", Spendley, W. and Hext, G. R. and Himsworth, F.
+    R., American Statistical Association and American Society for Quality,
+    1962</para>
+
+    <para>"A Simplex Method for Function Minimization", Nelder, J. A. and
+    Mead, R., The Computer Journal, 1965</para>
+
+    <para>"Iterative Methods for Optimization", C. T. Kelley, SIAM Frontiers
+    in Applied Mathematics, 1999</para>
+
+    <para>"Algorithm AS47 - Function minimization using a simplex procedure",
+    O'Neill, R., Applied Statistics, 1971</para>
+
+    <para>"Effect of dimensionality on the nelder-mead simplex method", Lixing
+    Han and Michael Neumann, Optimization Methods and Software, 21, 1, 1--16,
+    2006.</para>
+
+    <para>"Algorithms in Unconstrained Optimization", Lixing Han, Ph.D., The
+    University of Connecticut, 2000.</para>
+
+    <para>"Global Optimization Of Lennard-Jones Atomic Clusters" Ellen Fan,
+    Thesis, February 26, 2002, McMaster University</para>
   </refsection>
 
   <refsection>
 
         <listitem>
           <para>add more unit tests for fminsearch, especially the management
-          of the options provided by optimset().
-          </para>
+          of the options provided by optimset().</para>
         </listitem>
       </varlistentry>
 
         <term>demo with an output function</term>
 
         <listitem>
-          <para>
-            add a demo with an interactive output function, which
-            draws the plot during the optimization.
-          </para>
+          <para>add a demo with an interactive output function, which draws
+          the plot during the optimization.</para>
         </listitem>
       </varlistentry>
-
     </variablelist>
   </refsection>
 
     <title>Authors</title>
 
     <para>Michael Baudin - INRIA - 2008-2009</para>
+
     <para>Michael Baudin - Digiteo - 2009</para>
   </refsection>
 
     <title>See Also</title>
 
     <simplelist type="inline">
-      <member>
-        <link linkend="neldermead">neldermead</link>
-      </member>
+      <member><link linkend="neldermead">neldermead</link></member>
 
-      <member>
-        <link linkend="optimset">optimset</link>
-      </member>
+      <member><link linkend="optimset">optimset</link></member>
 
-      <member>
-        <link linkend="optimget">optimget</link>
-      </member>
+      <member><link linkend="optimget">optimget</link></member>
     </simplelist>
   </refsection>
 </refentry>
index 4b8f993..f5b4fb8 100644 (file)
@@ -45,9 +45,11 @@ this = neldermead_search ( this )
     <para>The optimization problem to solve is the minimization of a cost
     function, with bounds and nonlinear constraints</para>
 
-    <programlisting role="example">min f(x)
-l_i &lt;= x_i &lt;= h_i, i = 1,n
-g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
+    <programlisting role="example"><![CDATA[ 
+min f(x)
+l_i <= x_i <= h_i, i = 1,n
+g_i(x) <= 0, i = 1,nbineq
+ ]]></programlisting>
 
     <para>where</para>
 
@@ -1166,7 +1168,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
     <para>In the more general case, the cost function is expected to have the
     following header</para>
 
-    <programlisting role="example">function y = myfunction ( x , index , data )</programlisting>
+    <programlisting role="example"><![CDATA[ 
+function y = myfunction(x, index, data)
+ ]]></programlisting>
 
     <para>where</para>
 
@@ -1241,7 +1245,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
     <para>In the most simple case, the cost function is expected to have the
     following header</para>
 
-    <programlisting role="example">function y = myfunction (x)</programlisting>
+    <programlisting role="example"><![CDATA[ 
+function y = myfunction(x)
+ ]]></programlisting>
 
     <para>where x is the current point and y is the value of the cost. This
     case is associated with an unconstrained problem without any additionnal
@@ -1257,7 +1263,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
 
     <para>The output function must have the following header</para>
 
-    <programlisting role="example">function outputcmd ( state , data , myobj )</programlisting>
+    <programlisting role="example"><![CDATA[ 
+function outputcmd(state, data, myobj)
+ ]]></programlisting>
 
     <para>where</para>
 
@@ -1363,7 +1371,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
         <para>The number of iterations is examined and compared to the
         -maxiter option : if the following condition</para>
 
-        <programlisting role="example">iterations &gt;= maxiter</programlisting>
+        <programlisting role="example"><![CDATA[ 
+iterations >= maxiter
+ ]]></programlisting>
 
         <para>is true, then the status is set to "maxiter" and terminate is
         set to 1.</para>
@@ -1373,7 +1383,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
         <para>The number of function evaluations and compared to the
         -maxfunevals option is examined : if the following condition</para>
 
-        <programlisting role="example">funevals &gt;= maxfunevals</programlisting>
+        <programlisting role="example"><![CDATA[ 
+funevals >= maxfunevals
+ ]]></programlisting>
 
         <para>is true, then the status is set to "maxfuneval" and terminate is
         set to 1.</para>
@@ -1398,7 +1410,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
             <listitem>
               <para>if the following condition</para>
 
-              <programlisting role="example">abs(currentfopt) &lt; tolfunrelative * abs(previousfopt) + tolfunabsolute</programlisting>
+              <programlisting role="example"><![CDATA[ 
+abs(currentfopt) < tolfunrelative * abs(previousfopt) + tolfunabsolute
+ ]]></programlisting>
 
               <para>is true, then the status is set to "tolf" and terminate is
               set to 1.</para>
@@ -1434,7 +1448,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
             <listitem>
               <para>if the following condition</para>
 
-              <programlisting role="example">norm(currentxopt - previousxopt) &lt; tolxrelative * norm(currentxopt) + tolxabsolute</programlisting>
+              <programlisting role="example"><![CDATA[ 
+norm(currentxopt - previousxopt) < tolxrelative * norm(currentxopt) + tolxabsolute
+ ]]></programlisting>
 
               <para>is true, then the status is set to "tolx" and terminate is
               set to 1.</para>
@@ -1472,7 +1488,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
             <listitem>
               <para>if the following condition</para>
 
-              <programlisting role="example">st_deviation(fv) &lt; tolfstdeviation</programlisting>
+              <programlisting role="example"><![CDATA[ 
+st_deviation(fv) < tolfstdeviation
+ ]]></programlisting>
 
               <para>is true where fv is an array containing the function
               values in the simplex, then the status is set to "tolfstdev" and
@@ -1501,7 +1519,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
             <listitem>
               <para>if the following condition</para>
 
-              <programlisting role="example">ssize &lt; tolsimplexizerelative * simplexsize0 + tolsimplexizeabsolute</programlisting>
+              <programlisting role="example"><![CDATA[ 
+ssize < tolsimplexizerelative * simplexsize0 + tolsimplexizeabsolute
+ ]]></programlisting>
 
               <para>is true where simplexsize0 is the size of the simplex at
               iteration 0, then the status is set to "tolsize" and terminate
@@ -1531,9 +1551,13 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
             <listitem>
               <para>if both the following conditions</para>
 
-              <programlisting role="example">ssize &lt; tolsimplexizeabsolute</programlisting>
+              <programlisting role="example"><![CDATA[ 
+ssize < tolsimplexizeabsolute 
+ ]]></programlisting>
 
-              <programlisting role="example">shiftfv &lt; toldeltafv</programlisting>
+              <programlisting role="example"><![CDATA[ 
+shiftfv < toldeltafv
+ ]]></programlisting>
 
               <para>is true where ssize is the current simplex size and
               shiftfv is the absolute value of the difference of function
@@ -1564,7 +1588,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
             <listitem>
               <para>if the following condition</para>
 
-              <programlisting role="example">newfvmean &gt;= oldfvmean - alpha * sg' * sg</programlisting>
+              <programlisting role="example"><![CDATA[ 
+newfvmean <= oldfvmean - alpha * sg' * sg
+ ]]></programlisting>
 
               <para>is true where newfvmean (resp. oldfvmean) is the function
               value average in the current iteration (resp. in the previous
@@ -1606,7 +1632,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
           <para>in "Iterative Methods for Optimization", Kelley uses a
           normalized alpha, computed from the following formula</para>
 
-          <programlisting role="example">alpha = alpha0 * sigma0 / nsg</programlisting>
+          <programlisting role="example"><![CDATA[ 
+alpha = alpha0 * sigma0 / nsg
+ ]]></programlisting>
 
           <para>where sigma0 is the size of the initial simplex and nsg is the
           norm of the simplex gradient for the initial guess point.</para>
index 63b4026..3e3c98f 100644 (file)
@@ -1,6 +1,6 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <!--
- * Ajouter ici d'éventuels commentaires sur le fichier XML
+ * Ajouter ici d'éventuels commentaires sur le fichier XML
 -->
 <refentry version="5.0-subset Scilab" xml:id="optimget" xml:lang="fr"
           xmlns="http://docbook.org/ns/docbook"
   <refsection>
     <title>Description</title>
 
-    <para>
-      This function allows to make queries on an existing optimization data structure.
-      This data structure must have been created and updated by the  
-      <litteral>optimset</litteral> function.
-      The <litteral>optimget</litteral> allows to retrieve the value associated with a given key.
-    </para>
-
-    <para>
-        In the following, we analyse the various ways to call the optimget
-        function.
-      </para>
-
-    <para>
-      The following calling sequence
-      <programlisting role="example">
-        val = optimget ( options , key )
-      </programlisting>
-      returns the value associated with the given <litteral>key</litteral>. 
-      The <litteral>key</litteral> is expected to be a string.
-      We search the <litteral>key</litteral> among 
-      the list of all possible fields in the <litteral>options</litteral> data structure.
-      In this search, the case is ignored. The <litteral>key</litteral> which matches 
-      a possible field is returned. Some letters of the field may be dropped, provided that 
-      the matching field is unique. For example, the key "MaxF" corresponds to the 
-      field "MaxFunEval". But the key "Tol" corresponds both to the 
-      "TolX" and "TolFun" fields and therefore will generate an error.
-    </para>
-
-    <para>
-      The following calling sequence
-      <programlisting role="example">
-        val = optimset ( options , key , value )
-      </programlisting>
-      allows to manage default value for optimization parameters. Indeed, 
-      if the field corresponding to the <litteral>key</litteral> is empty (i.e.
-      has not been set by the user), the
-      input argument <litteral>value</litteral> is returned.
-      Instead, if the field corresponding the the key is not empty (i.e.
-      has been set by the user), the 
-      stored parameter is returned.
-    </para>
-
+    <para>This function allows to make queries on an existing optimization
+    data structure. This data structure must have been created and updated by
+    the <literal>optimset</literal> function. The <literal>optimget</literal>
+    allows to retrieve the value associated with a given key.</para>
+
+    <para>In the following, we analyse the various ways to call the optimget
+    function.</para>
+
+    <para>The following calling sequence </para>
+    <programlisting role="example"><![CDATA[ 
+val = optimget(options , key)
+ ]]></programlisting> 
+    <para>returns the value associated with the given
+    <literal>key</literal>. The <literal>key</literal> is expected to be a
+    string. We search the <literal>key</literal> among the list of all
+    possible fields in the <literal>options</literal> data structure. In this
+    search, the case is ignored. The <literal>key</literal> which matches a
+    possible field is returned. Some letters of the field may be dropped,
+    provided that the matching field is unique. For example, the key "MaxF"
+    corresponds to the field "MaxFunEval". But the key "Tol" corresponds both
+    to the "TolX" and "TolFun" fields and therefore will generate an
+    error.</para>
+
+    <para>The following calling sequence </para>
+    <programlisting role="example"><![CDATA[ 
+val = optimset(options, key, value)
+ ]]></programlisting> 
+    <para>allows to manage default value for optimization parameters.
+    Indeed, if the field corresponding to the <literal>key</literal> is empty
+    (i.e. has not been set by the user), the input argument
+    <literal>value</literal> is returned. Instead, if the field corresponding
+    the the key is not empty (i.e. has been set by the user), the stored
+    parameter is returned.</para>
   </refsection>
 
   <refsection>
     <variablelist>
       <varlistentry>
         <term>options</term>
+
         <listitem>
-          <para>
-            A struct which contains the optimization fields.
-          </para>
+          <para>A struct which contains the optimization fields.</para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
         <term>key</term>
+
         <listitem>
-          <para>
-            A string corresponding to a field of the optimization structure.
-          </para>
+          <para>A string corresponding to a field of the optimization
+          structure.</para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
         <term>value</term>
+
         <listitem>
-          <para>
-            A real default value.
-          </para>
+          <para>A real default value.</para>
         </listitem>
       </varlistentry>
 
       <varlistentry>
         <term>val</term>
+
         <listitem>
-          <para>
-            The real value corresponding to the key.
-          </para>
+          <para>The real value corresponding to the key.</para>
         </listitem>
       </varlistentry>
-
     </variablelist>
   </refsection>
 
   <refsection>
     <title>Example #1</title>
 
-    <para>
-      In the following example, we create an optimization structure
-      and set the "TolX" field to 1.e-12. Then we use <literral>optimget</literral>
-      to get back the value.
-    </para>
-
-    <programlisting role="example">
-      op = optimset ();
-      op = optimset(op,'TolX',1.e-12);
-      val = optimget(op,'TolX'); // val is 1.e-12
-    </programlisting>
+    <para>In the following example, we create an optimization structure and
+    set the "TolX" field to 1.e-12. Then we use <literal>optimget</literal> to
+    get back the value.</para>
+
+    <programlisting role="example"><![CDATA[ 
+op = optimset();
+op = optimset(op,'TolX',1.e-12);
+val = optimget(op,'TolX'); // val is 1.e-12
+ ]]></programlisting>
   </refsection>
 
   <refsection>
     <title>Example #2</title>
 
-    <para>
-      In the following example, we create an empty optimization structure.
-      Then we use <literral>optimget</literral> to get back the value corresponding
-      to the "TolX" field, with 1.e-5 as the default value. Since the 
-      field is empty, we retrieve 1.e-5.
-    </para>
-
-    <programlisting role="example">
-      op = optimset ();
-      val = optimget(op,'TolX' , 1.e-5); // val = 1.e-5
-    </programlisting>
+    <para>In the following example, we create an empty optimization structure.
+    Then we use <literal>optimget</literal> to get back the value
+    corresponding to the "TolX" field, with 1.e-5 as the default value. Since
+    the field is empty, we retrieve 1.e-5.</para>
+
+    <programlisting role="example"><![CDATA[ 
+op = optimset();
+val = optimget(op,'TolX' , 1.e-5); // val = 1.e-5
+ ]]></programlisting>
   </refsection>
 
   <refsection>
     <title>Example #3</title>
 
-    <para>
-      In the following example, we create an optimization structure
-      and set the "TolX" field to 1.e-12.
-      Then we use <literral>optimget</literral> to get back the value corresponding
-      to the "TolX" field, with 1.e-5 as the default value. Since the
-      field is not empty, we retrieve 1.e-12.
-    </para>
-
-    <programlisting role="example">
-      op = optimset ();
-      op = optimset(op,'TolX',1.e-12);
-      val = optimget(op,'TolX' , 1.e-5); // val = 1.e-12
-    </programlisting>
+    <para>In the following example, we create an optimization structure and
+    set the "TolX" field to 1.e-12. Then we use <literal>optimget</literal> to
+    get back the value corresponding to the "TolX" field, with 1.e-5 as the
+    default value. Since the field is not empty, we retrieve 1.e-12.</para>
+
+    <programlisting role="example"><![CDATA[ 
+op = optimset();
+op = optimset(op,'TolX',1.e-12);
+val = optimget(op,'TolX' , 1.e-5); // val = 1.e-12
+ ]]></programlisting>
   </refsection>
 
   <refsection>
     <title>Example #4</title>
 
-    <para>
-      In the following example, we create an optimization structure and 
-      configure the maximum number of function evaluations to 1000.
-      Then we quiery the data structure, giving only the "MaxF" key to the 
-      <literral>optimget</literral> function. Since that corresponds 
-      only to the "MaxFunEvals" field, there is only one match and the function
-      returns 10000.
-    </para>
-
-    <programlisting role="example">
-      op = optimset ();
-      op = optimset ( op , 'MaxFunEvals' , 1000 );
-      val = optimget ( op , 'MaxF' ); // val = 1000
-    </programlisting>
+    <para>In the following example, we create an optimization structure and
+    configure the maximum number of function evaluations to 1000. Then we
+    quiery the data structure, giving only the "MaxF" key to the
+    <literal>optimget</literal> function. Since that corresponds only to the
+    "MaxFunEvals" field, there is only one match and the function returns
+    10000.</para>
+
+    <programlisting role="example"><![CDATA[ 
+op = optimset();
+op = optimset(op, 'MaxFunEvals' , 1000);
+val = optimget(op, 'MaxF'); // val = 1000
+ ]]></programlisting>
   </refsection>
 
   <refsection>
     <title>See Also</title>
 
     <simplelist type="inline">
-      <member>
-        <link linkend="optimset">optimset</link>
-      </member>
+      <member><link linkend="optimset">optimset</link></member>
     </simplelist>
   </refsection>
 </refentry>
index 948292f..9ca100f 100644 (file)
         function.
       </para>
 
-    <para>
-      The following calling sequence
-      <programlisting role="example">
-      options = optimset ()
-    </programlisting>
-      creates a new data structure where the fields have been set to the empty matrix (i.e. []).
-    </para>
-
-    <para>
-      The following calling sequence
-      <programlisting role="example">
-        options = optimset ( funname )
-      </programlisting>
-      creates a new data structure where the default parameters which correspond to
-      the "funname" function have been set. For example,
-      <programlisting role="example">
-        options = optimset ( "fminsearch" )
-      </programlisting>
-      returns a new data structure where the default parameters which correspond to 
-      the "fminsearch" function have been set.
+    <para>The following calling sequence</para>
+      <programlisting role="example"><![CDATA[ 
+options = optimset ()
+ ]]></programlisting>
+      <para>creates a new data structure where the fields have been set to the empty matrix (i.e. []).
     </para>
 
-    <para>
-      The following calling sequence
-      <programlisting role="example">
-        options = optimset ( oldoptions , key , value )
-      </programlisting>
-      creates a new data structure where all fields from the "oldoptions" 
+    <para>The following calling sequence</para>
+      <programlisting role="example"><![CDATA[ 
+options = optimset ( funname )
+ ]]></programlisting>
+      <para>creates a new data structure where the default parameters which correspond to the "funname" function have been set. For example,</para>
+      <programlisting role="example"><![CDATA[ 
+options = optimset ( "fminsearch" )
+ ]]></programlisting>
+      <para>returns a new data structure where the default parameters which correspond to the "fminsearch" function have been set.</para>
+
+    <para>The following calling sequence</para>
+      <programlisting role="example"><![CDATA[ 
+options = optimset ( oldoptions , key , value )
+ ]]></programlisting>
+      <para>creates a new data structure where all fields from the "oldoptions" 
       structure have been copied, except the field corresponding to the "key",
       which has been set to "value".
     </para>
       In the following example, we create an empty optimization structure.
     </para>
 
-    <programlisting role="example">
-      op = optimset ()
-    </programlisting>
+    <programlisting role="example"><![CDATA[ 
+op = optimset ()
+ ]]></programlisting>
   </refsection>
 
   <refsection>
       with all fields set to specific settings.
     </para>
 
-    <programlisting role="example">
-      op = optimset (...
-      "Display","iter",...
-      "FunValCheck","on",...
-      "MaxFunEvals",100,...
-      "MaxIter",110,...
-      "OutputFcn",myoutputfun,...
-      "PlotFcns",myplotfun,...
-      "TolFun",1.e-12,...
-      "TolX",1.e-13...
-      )
-    </programlisting>
+    <programlisting role="example"><![CDATA[ 
+op = optimset ("Display","iter",...
+               "FunValCheck","on",...
+               "MaxFunEvals",100,...
+               "MaxIter",110,...
+               "OutputFcn",myoutputfun,...
+               "PlotFcns",myplotfun,...
+               "TolFun",1.e-12,...
+               "TolX",1.e-13)
+ ]]></programlisting>
   </refsection>
 
   
       optimization function.
     </para>
 
-    <programlisting role="example">
-      op = optimset ("fminsearch")
-    </programlisting>
+    <programlisting role="example"><![CDATA[ 
+op = optimset ("fminsearch")
+ ]]></programlisting>
   </refsection>
 
   <refsection>
index 6f7b6a3..7b66e10 100644 (file)
@@ -24,7 +24,8 @@
 
     <para>The goal of this toolbox is to provide a Nelder-Mead direct search
     optimization method. That Nelder-Mead algorithm may be used in the
-    following optimization context :<itemizedlist>
+    following optimization context :</para>
+    <itemizedlist>
         <listitem>
           <para>there is no need to provide the derivatives of the objective
           function,</para>
@@ -37,7 +38,7 @@
         <listitem>
           <para>there are bounds and/or non linear constraints.</para>
         </listitem>
-      </itemizedlist></para>
+      </itemizedlist>
   </refsection>
 
   <refsection>
 
       <listitem>
         <para>Manage various termination criteria, including maximum number of
-        iterations, tolerance on function value (relative or absolute),
+        iterations, tolerance on function value (relative or absolute),</para>
         <itemizedlist>
             <listitem>
               <para>tolerance on x (relative or absolute),</para>
             <listitem>
               <para>absolute or relative simplex size,</para>
             </listitem>
-          </itemizedlist></para>
+          </itemizedlist>
       </listitem>
 
       <listitem>
   <refsection>
     <title>TODO</title>
 
-    <para><itemizedlist>
+    <itemizedlist>
         <listitem>
           <para>implement "optimget"</para>
         </listitem>
         <listitem>
           <para>implement parabolic line search</para>
         </listitem>
-      </itemizedlist></para>
+      </itemizedlist>
   </refsection>
 
   <refsection>
     the algorithm. After the optimization is performed, the optimum is
     retrieved with quiery features.</para>
 
-    <programlisting role="example">
+    <programlisting role="example"><![CDATA[ 
 function y = rosenbrock (x)
   y = 100*(x(2)-x(1)^2)^2 + (1-x(1))^2;
 endfunction
@@ -270,7 +271,7 @@ historysimplex = neldermead_get(nm,"-historysimplex");
 fx0 = neldermead_get(nm,"-fx0");
 status = neldermead_get(nm,"-status");
 nm = neldermead_destroy(nm);
-    </programlisting>
+ ]]></programlisting>
   </refsection>
 
   <refsection>
index 13799dc..fb74698 100644 (file)
@@ -54,7 +54,7 @@ this = optimbase_stoplog ( this , msg )
     <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
+      class of specialized optimization methods. This component manages</para>
       <itemizedlist>
         <listitem>
           <para>the number of variables,</para>
@@ -83,7 +83,7 @@ this = optimbase_stoplog ( this , msg )
         <listitem>
           <para>etc...</para>
         </listitem>
-      </itemizedlist></para>
+      </itemizedlist>
   </refsection>
 
   <refsection>
@@ -115,7 +115,8 @@ this = optimbase_stoplog ( this , msg )
       </listitem>
 
       <listitem>
-        <para>Manage various termination criteria, including <itemizedlist>
+        <para>Manage various termination criteria, including </para>
+       <itemizedlist>
             <listitem>
               <para>maximum number of iterations,</para>
             </listitem>
@@ -131,7 +132,7 @@ this = optimbase_stoplog ( this , msg )
             <listitem>
               <para>maximum number of evaluations of cost function,</para>
             </listitem>
-          </itemizedlist></para>
+        </itemizedlist>
       </listitem>
 
       <listitem>
@@ -196,9 +197,11 @@ this = optimbase_stoplog ( this , msg )
 
     <para>The optimization problem to solve is the following</para>
 
-    <programlisting role="example">min f(x)
-l_i &lt;= x_i &lt;= h_i, i = 1,n
-g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
+    <programlisting role="example"><![CDATA[ 
+min f(x)
+l_i <= x_i <= h_i, i = 1,n
+g_i(x) <= 0, i = 1,nbineq
+ ]]></programlisting>
 
     <para>where</para>
 
@@ -1177,7 +1180,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
     <para>In the more general case, the cost function is expected to have the
     following header</para>
 
-    <programlisting role="example">function y = myfunction ( x , index , data )</programlisting>
+    <programlisting role="example"><![CDATA[ 
+function y = myfunction(x, index, data)
+ ]]></programlisting>
 
     <para>where</para>
 
@@ -1252,7 +1257,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
     <para>In the most simple case, the cost function is expected to have the
     following header</para>
 
-    <programlisting role="example">function y = myfunction (x)</programlisting>
+    <programlisting role="example"><![CDATA[ 
+function y = myfunction(x)
+ ]]></programlisting>
 
     <para>where x is the current point and y is the value of the cost. This
     case is associated with an unconstrained problem without any additionnal
@@ -1268,7 +1275,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
 
     <para>The output function must have the following header</para>
 
-    <programlisting role="example">function outputcmd ( state , data , myobj )</programlisting>
+    <programlisting role="example"><![CDATA[ 
+function outputcmd(state, data, myobj)
+ ]]></programlisting>
 
     <para>where</para>
 
@@ -1373,7 +1382,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
         <para>The number of iterations is examined and compared to the
         -maxiter option : if the following condition</para>
 
-        <programlisting role="example">iterations &gt;= maxiter</programlisting>
+        <programlisting role="example"><![CDATA[ 
+iterations >= maxiter
+ ]]></programlisting>
 
         <para>is true, then the status is set to "maxiter" and terminate is
         set to 1.</para>
@@ -1383,7 +1394,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
         <para>The number of function evaluations and compared to the
         -maxfunevals option is examined : if the following condition</para>
 
-        <programlisting role="example">funevals &gt;= maxfunevals</programlisting>
+        <programlisting role="example"><![CDATA[ 
+funevals >= maxfunevals
+ ]]></programlisting>
 
         <para>is true, then the status is set to "maxfuneval" and terminate is
         set to 1.</para>
@@ -1408,7 +1421,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
             <listitem>
               <para>if the following condition</para>
 
-              <programlisting role="example">abs(currentfopt) &lt; tolfunrelative * abs(previousfopt) + tolfunabsolute</programlisting>
+              <programlisting role="example"><![CDATA[ 
+abs(currentfopt) < tolfunrelative * abs(previousfopt) + tolfunabsolute
+ ]]></programlisting>
 
               <para>is true, then the status is set to "tolf" and terminate is
               set to 1.</para>
@@ -1444,7 +1459,9 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
             <listitem>
               <para>if the following condition</para>
 
-              <programlisting role="example">norm(currentxopt - previousxopt) &lt; tolxrelative * norm(currentxopt) + tolxabsolute</programlisting>
+              <programlisting role="example"><![CDATA[ 
+norm(currentxopt - previousxopt) < tolxrelative * norm(currentxopt) + tolxabsolute
+ ]]></programlisting>
 
               <para>is true, then the status is set to "tolx" and terminate is
               set to 1.</para>
@@ -1476,21 +1493,20 @@ g_i(x) &lt;= 0, i = 1,nbineq</programlisting>
     the algorithm. After the optimization is performed, the optimum is
     retrieved with quiery features.</para>
 
-    <programlisting role="example">
+    <programlisting role="example"><![CDATA[ 
 function y = rosenbrock (x)
   y = 100*(x(2)-x(1)^2)^2 + (1-x(1))^2;
 endfunction
 
-opt = optimbase_new ();
+opt = optimbase_new();
 // Check number of variables
 opt = optimbase_configure(opt,"-numberofvariables",2);
 nbvar = optimbase_cget(opt,"-numberofvariables");
 // Check cost function without additionnal argument
 opt = optimbase_configure(opt,"-function",rosenbrock);
-[this,f] = optimbase_function ( opt , [0.0 0.0] );
+[this,f] = optimbase_function(opt, [0.0 0.0]);
 opt = optimbase_destroy(opt);
-
-    </programlisting>
+ ]]></programlisting>
   </refsection>
 
   <refsection>
@@ -1502,7 +1518,7 @@ opt = optimbase_destroy(opt);
   <refsection>
     <title>TODO</title>
 
-    <para><itemizedlist>
+    <itemizedlist>
         <listitem>
           <para>manage equality constraints</para>
         </listitem>
@@ -1523,6 +1539,6 @@ opt = optimbase_destroy(opt);
           <para>methods with derivatives : add a flag to manage for the
           derivatives of the cost function</para>
         </listitem>
-      </itemizedlist></para>
+    </itemizedlist>
   </refsection>
 </refentry>
index f27c7a2..e09f5b0 100644 (file)
@@ -71,7 +71,8 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
     <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>
+      be used in the following optimization methods :</para>
+    <itemizedlist>
         <listitem>
           <para>the Spendley et al. simplex method,</para>
         </listitem>
@@ -91,7 +92,7 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
         <listitem>
           <para>etc ...</para>
         </listitem>
-      </itemizedlist></para>
+    </itemizedlist>
   </refsection>
 
   <refsection>
@@ -231,7 +232,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 <para>The function is expected to have the following input and
                 output arguments :</para>
 
-                <programlisting role="example">function y = myfunction (x)</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function y = myfunction (x)
+ ]]></programlisting>
               </listitem>
             </varlistentry>
 
@@ -246,7 +249,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 function both as an input and output argument. In that case,
                 the function must have the following header :</para>
 
-                <programlisting role="example">function [ y , data ] = myfunction ( x , data )</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function [ y , data ] = myfunction ( x , data )
+ ]]></programlisting>
 
                 <para>The data input parameter may be used if the function
                 uses some additionnal parameters. It is returned as an output
@@ -312,7 +317,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 <para>The function is expected to have the following input and
                 output arguments :</para>
 
-                <programlisting role="example">function y = myfunction (x)</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function y = myfunction (x)
+ ]]></programlisting>
               </listitem>
             </varlistentry>
 
@@ -338,7 +345,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 function both as an input and output argument. In that case,
                 the function must have the following header :</para>
 
-                <programlisting role="example">function [ y , data ] = myfunction ( x , data )</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function [ y , data ] = myfunction ( x , data )
+ ]]></programlisting>
 
                 <para>The data input parameter may be used if the function
                 uses some additionnal parameters. It is returned as an output
@@ -387,7 +396,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 <para>The function is expected to have the following input and
                 output arguments :</para>
 
-                <programlisting role="example">function y = myfunction (x)</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function y = myfunction (x)
+ ]]></programlisting>
               </listitem>
             </varlistentry>
 
@@ -420,7 +431,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 function both as an input and output argument. In that case,
                 the function must have the following header :</para>
 
-                <programlisting role="example">function [ y , data ] = myfunction ( x , data )</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function [ y , data ] = myfunction ( x , data )
+ ]]></programlisting>
 
                 <para>The data input parameter may be used if the function
                 uses some additionnal parameters. It is returned as an output
@@ -470,7 +483,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 <para>The function is expected to have the following input and
                 output arguments :</para>
 
-                <programlisting role="example">function y = myfunction (x)</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function y = myfunction (x)
+ ]]></programlisting>
               </listitem>
             </varlistentry>
 
@@ -491,7 +506,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 <para>Each component ix =1 , n of the vertex #jve = 2,k is
                 computed from the formula :</para>
 
-                <programlisting role="example">x ( ix , jve ) = boundsmin( ix ) + rand() * (boundsmax( ix ) - boundsmin( ix ))</programlisting>
+                <programlisting role="example"><![CDATA[ 
+x ( ix , jve ) = boundsmin( ix ) + rand() * (boundsmax( ix ) - boundsmin( ix ))
+ ]]></programlisting>
               </listitem>
             </varlistentry>
 
@@ -514,7 +531,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 function both as an input and output argument. In that case,
                 the function must have the following header :</para>
 
-                <programlisting role="example">function [ y , data ] = myfunction ( x , data )</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function [ y , data ] = myfunction ( x , data )
+ ]]></programlisting>
 
                 <para>The data input parameter may be used if the function
                 uses some additionnal parameters. It is returned as an output
@@ -563,7 +582,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 <para>The function is expected to have the following input and
                 output arguments :</para>
 
-                <programlisting role="example">function y = myfunction (x)</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function y = myfunction (x)
+ ]]></programlisting>
               </listitem>
             </varlistentry>
 
@@ -587,7 +608,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 function both as an input and output argument. In that case,
                 the function must have the following header :</para>
 
-                <programlisting role="example">function [ y , data ] = myfunction ( x , data )</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function [ y , data ] = myfunction ( x , data )
+ ]]></programlisting>
 
                 <para>The data input parameter may be used if the function
                 uses some additionnal parameters. It is returned as an output
@@ -1141,7 +1164,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 <para>The function is expected to have the following input and
                 output arguments :</para>
 
-                <programlisting role="example">function y = myfunction (x)</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function y = myfunction (x)
+ ]]></programlisting>
               </listitem>
             </varlistentry>
 
@@ -1156,7 +1181,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 function both as an input and output argument. In that case,
                 the function must have the following header :</para>
 
-                <programlisting role="example">function [ y , data ] = myfunction ( x , data )</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function [ y , data ] = myfunction ( x , data )
+ ]]></programlisting>
 
                 <para>The data input parameter may be used if the function
                 uses some additionnal parameters. It is returned as an output
@@ -1293,7 +1320,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 <para>The function is expected to have the following input and
                 output arguments :</para>
 
-                <programlisting role="example">function y = myfunction (x)</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function y = myfunction (x)
+ ]]></programlisting>
               </listitem>
             </varlistentry>
 
@@ -1322,7 +1351,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 function both as an input and output argument. In that case,
                 the function must have the following header :</para>
 
-                <programlisting role="example">function [ y , data ] = myfunction ( x , data )</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function [ y , data ] = myfunction ( x , data )
+ ]]></programlisting>
 
                 <para>The data input parameter may be used if the function
                 uses some additionnal parameters. It is returned as an output
@@ -1364,7 +1395,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 <para>The function is expected to have the following input and
                 output arguments :</para>
 
-                <programlisting role="example">function y = myfunction (x)</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function y = myfunction (x)
+ ]]></programlisting>
               </listitem>
             </varlistentry>
 
@@ -1379,7 +1412,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 function both as an input and output argument. In that case,
                 the function must have the following header :</para>
 
-                <programlisting role="example">function [ y , data ] = myfunction ( x , data )</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function [ y , data ] = myfunction ( x , data )
+ ]]></programlisting>
 
                 <para>The data input parameter may be used if the function
                 uses some additionnal parameters. It is returned as an output
@@ -1438,7 +1473,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 <para>The function is expected to have the following input and
                 output arguments :</para>
 
-                <programlisting role="example">function y = myfunction (x)</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function y = myfunction (x)
+ ]]></programlisting>
               </listitem>
             </varlistentry>
 
@@ -1453,7 +1490,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 function both as an input and output argument. In that case,
                 the function must have the following header :</para>
 
-                <programlisting role="example">function [ y , data ] = myfunction ( x , data )</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function [ y , data ] = myfunction ( x , data )
+ ]]></programlisting>
 
                 <para>The data input parameter may be used if the function
                 uses some additionnal parameters. It is returned as an output
@@ -1494,7 +1533,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 <para>The function is expected to have the following input and
                 output arguments :</para>
 
-                <programlisting role="example">function y = myfunction (x)</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function y = myfunction (x)
+ ]]></programlisting>
               </listitem>
             </varlistentry>
 
@@ -1518,7 +1559,9 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
                 function both as an input and output argument. In that case,
                 the function must have the following header :</para>
 
-                <programlisting role="example">function [ y , data ] = myfunction ( x , data )</programlisting>
+                <programlisting role="example"><![CDATA[ 
+function [ y , data ] = myfunction ( x , data )
+ ]]></programlisting>
 
                 <para>The data input parameter may be used if the function
                 uses some additionnal parameters. It is returned as an output
@@ -1648,7 +1691,7 @@ cen = optimsimplex_xbar ( this , iexcl )</synopsis>
     <para>In the following example, one creates a simplex with known vertices
     coordinates. The function values at the vertices are unset.</para>
 
-    <programlisting role="example">
+    <programlisting role="example"><![CDATA[ 
 coords = [
 0.0 1.0 0.0
 0.0 0.0 1.0
@@ -1658,7 +1701,7 @@ computed = optimsimplex_getallx ( s1 );
 computed = optimsimplex_getn(s1);
 computed = optimsimplex_getnbve (s1);
 s1 = optimsimplex_destroy(s1);
-    </programlisting>
+ ]]></programlisting>
   </refsection>
 
   <refsection>
@@ -1672,7 +1715,7 @@ s1 = optimsimplex_destroy(s1);
     value of mydude.nb is 5, which is the expected result because there is one
     function call by vertex.</para>
 
-    <programlisting role="example">
+    <programlisting role="example"><![CDATA[ 
 function [ y , myobj ] = mycostf ( x , myobj )
   y = rosenbrock(x);
   myobj.nb = myobj.nb + 1
@@ -1684,19 +1727,18 @@ s1 = optimsimplex_new ();
 [ s1 , mydude ] = optimsimplex_randbounds ( s1 , x0 = [-1.2 1.0], fun = mycostf, ...
   boundsmin = [-5.0 -5.0] , boundsmax = [5.0 5.0], nbve=5 , data = mydude );
 s1 = optimsimplex_destroy ( s1 );
-
-    </programlisting>
+ ]]></programlisting>
   </refsection>
 
   <refsection>
     <title>TODO</title>
 
-    <para><itemizedlist>
+    <itemizedlist>
         <listitem>
           <para>implement reflection and expansion as in multidimensional
           search by Torczon</para>
         </listitem>
-      </itemizedlist></para>
+    </itemizedlist>
   </refsection>
 
   <refsection>
index 73e0fe1..46eee6c 100644 (file)
   <refsynopsisdiv>
     <title>Calling Sequence</title>
 
-    <synopsis>v = strsplit(str,ind)</synopsis>
-
-    <synopsis>[v, matched_separators] = strsplit(str)</synopsis>
-
-    <synopsis>[v, matched_separators] = strsplit(str, matrix_of_strings, limit)</synopsis>
-
-    <synopsis>[v, matched_separators] = strsplit(str, regexp_pattern, limit)</synopsis>
+    <synopsis>
+      v = strsplit(str,ind)
+      [v, matched_separators] = strsplit(str)
+      [v, matched_separators] = strsplit(str, matrix_of_strings, limit)
+      [v, matched_separators] = strsplit(str, regexp_pattern, limit)
+    </synopsis>
   </refsynopsisdiv>
 
   <refsection>