Fixed the name of optimsimplex functions (after rename)
Michaƫl Baudin [Mon, 31 Aug 2009 15:14:51 +0000 (17:14 +0200)]
scilab/modules/optimization/help/en_US/optimsimplex/optimsimplex.xml

index 22e7279..c90798a 100644 (file)
@@ -14,7 +14,7 @@
   </info>
 
   <refnamediv>
-    <refname>simplex</refname>
+    <refname>optimsimplex</refname>
 
     <refpurpose>Manage a simplex with arbitrary number of points.</refpurpose>
   </refnamediv>
   <refsynopsisdiv>
     <title>SYNOPSIS</title>
 
-    <synopsis>[ newobj , data ] = simplex_new ( coords , fun , data )
-this = simplex_destroy (this)
-[ this , data ] = simplex_axes ( this , x0 , fun , len , data )
-[ this , data ] = simplex_pfeffer ( this , x0 , fun , deltausual , deltazero , data )
-[ this , data ] = simplex_randbounds ( this , x0 , fun , boundsmin , boundsmax , nbpoints  , data )
-[ this , data ] = simplex_spendley ( this , x0 , fun , len , data )
-this = simplex_setall ( this , simplex )
-this = simplex_setallfv ( this , fv )
-this = simplex_setallx ( this , x )
-this = simplex_setfv ( this , ive , fv )
-this = simplex_setn ( this , n )
-this = simplex_setnbve ( this , nbve )
-this = simplex_setve ( this , ive , fv , x )
-this = simplex_setx ( this , ive , x )
-simplex = simplex_getall ( this )
-fv = simplex_getallfv ( this )
-x = simplex_getallx ( this )
-fv = simplex_getfv ( this , ive )
-n = simplex_getn ( this )
-n = simplex_getnbve ( this )
-vertex = simplex_getve ( this , ive )
-x = simplex_getx ( this , ive )
-sicenter = simplex_center ( this )
-simplex_check ( this )
-[ this , data ] = simplex_computefv ( this , fun , data )
-df = simplex_deltafv ( this )
-dfm = simplex_deltafvmax ( this )
-m = simplex_dirmat ( this )
-sd = simplex_fvmean ( this )
-sd = simplex_fvstdev ( this )
-[ g , data ] = simplex_gradientfv ( this , fun , method , data )
-g = simplex_gradforward ( this )
-[ g , data ] = simplex_gradcentered ( this , fun , data )
-[ ns , data ] = simplex_oriented ( this , fun , data )
-simplex_print ( this )
-[ r , data ] = simplex_reflect ( this , fun , data )
-[ this , data ] = simplex_shrink ( this , fun , sigma , data )
-ssize = simplex_size ( this , method )
-this = simplex_sort ( this )
-str = simplex_tostring ( this )
-cen = simplex_xbar ( this , iexcl )</synopsis>
+    <synopsis>[ newobj , data ] = optimsimplex_new ( coords , fun , data )
+this = optimsimplex_destroy (this)
+[ this , data ] = optimsimplex_axes ( this , x0 , fun , len , data )
+[ this , data ] = optimsimplex_pfeffer ( this , x0 , fun , deltausual , deltazero , data )
+[ this , data ] = optimsimplex_randbounds ( this , x0 , fun , boundsmin , boundsmax , nbpoints  , data )
+[ this , data ] = optimsimplex_spendley ( this , x0 , fun , len , data )
+this = optimsimplex_setall ( this , simplex )
+this = optimsimplex_setallfv ( this , fv )
+this = optimsimplex_setallx ( this , x )
+this = optimsimplex_setfv ( this , ive , fv )
+this = optimsimplex_setn ( this , n )
+this = optimsimplex_setnbve ( this , nbve )
+this = optimsimplex_setve ( this , ive , fv , x )
+this = optimsimplex_setx ( this , ive , x )
+simplex = optimsimplex_getall ( this )
+fv = optimsimplex_getallfv ( this )
+x = optimsimplex_getallx ( this )
+fv = optimsimplex_getfv ( this , ive )
+n = optimsimplex_getn ( this )
+n = optimsimplex_getnbve ( this )
+vertex = optimsimplex_getve ( this , ive )
+x = optimsimplex_getx ( this , ive )
+sicenter = optimsimplex_center ( this )
+optimsimplex_check ( this )
+[ this , data ] = optimsimplex_computefv ( this , fun , data )
+df = optimsimplex_deltafv ( this )
+dfm = optimsimplex_deltafvmax ( this )
+m = optimsimplex_dirmat ( this )
+sd = optimsimplex_fvmean ( this )
+sd = optimsimplex_fvstdev ( this )
+[ g , data ] = optimsimplex_gradientfv ( this , fun , method , data )
+g = optimsimplex_gradforward ( this )
+[ g , data ] = optimsimplex_gradcentered ( this , fun , data )
+[ ns , data ] = optimsimplex_oriented ( this , fun , data )
+optimsimplex_print ( this )
+[ r , data ] = optimsimplex_reflect ( this , fun , data )
+[ this , data ] = optimsimplex_shrink ( this , fun , sigma , data )
+ssize = optimsimplex_size ( this , method )
+this = optimsimplex_sort ( this )
+str = optimsimplex_tostring ( this )
+cen = optimsimplex_xbar ( this , iexcl )</synopsis>
   </refsynopsisdiv>
 
   <refsection>
@@ -176,14 +176,14 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
     simplex gradient can be computed with a order 1 forward formula and with a
     order 2 centered formula.</para>
 
-    <para>The simplex_new function allows to create a simplex. If vertices
+    <para>The optimsimplex_new function allows to create a simplex. If vertices
     coordinates are given, there are registered in the simplex. If a function
-    is provided, it is evaluated at each vertex. The simplex_destroy function
+    is provided, it is evaluated at each vertex. The optimsimplex_destroy function
     destroys the object and frees internal memory. Several functions allow to
     create a simplex with special shapes, including axes-by-axes
-    (simplex_axes), regular (simplex_spendley), randomized bounds simplex with
-    arbitrary k vertices (simplex_randbounds) and an heuristical small
-    variation around a given point (simplex_pfeffer).</para>
+    (optimsimplex_axes), regular (optimsimplex_spendley), randomized bounds simplex with
+    arbitrary k vertices (optimsimplex_randbounds) and an heuristical small
+    variation around a given point (optimsimplex_pfeffer).</para>
   </refsection>
 
   <refsection>
@@ -193,7 +193,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
 
     <variablelist>
       <varlistentry>
-        <term>[ newobj , data ] = simplex_new ( coords , fun , data )</term>
+        <term>[ newobj , data ] = optimoptimsimplex_new ( coords , fun , data )</term>
 
         <listitem>
           <para>Creates a new simplex object. All input arguments are
@@ -261,7 +261,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>this = simplex_destroy (this)</term>
+        <term>this = optimoptimsimplex_destroy (this)</term>
 
         <listitem>
           <para>Destroy the given object.</para>
@@ -279,7 +279,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>[ this , data ] = simplex_axes ( this , x0 , fun , len , data
+        <term>[ this , data ] = optimoptimsimplex_axes ( this , x0 , fun , len , data
         )</term>
 
         <listitem>
@@ -353,7 +353,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>[ this , data ] = simplex_pfeffer ( this , x0 , fun , deltausual
+        <term>[ this , data ] = optimoptimsimplex_pfeffer ( this , x0 , fun , deltausual
         , deltazero , data )</term>
 
         <listitem>
@@ -435,7 +435,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>[ this , data ] = simplex_randbounds ( this , x0 , fun ,
+        <term>[ this , data ] = optimoptimsimplex_randbounds ( this , x0 , fun ,
         boundsmin , boundsmax , nbpoints , data )</term>
 
         <listitem>
@@ -529,7 +529,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>[ this , data ] = simplex_spendley ( this , x0 , fun , len ,
+        <term>[ this , data ] = optimoptimsimplex_spendley ( this , x0 , fun , len ,
         data )</term>
 
         <listitem>
@@ -602,7 +602,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>this = simplex_setall ( this , simplex )</term>
+        <term>this = optimoptimsimplex_setall ( this , simplex )</term>
 
         <listitem>
           <para>Set all the coordinates and and the function values of all the
@@ -647,7 +647,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>this = simplex_setallfv ( this , fv )</term>
+        <term>this = optimoptimsimplex_setallfv ( this , fv )</term>
 
         <listitem>
           <para>Set all the function values of all the vertices. The vertex #k
@@ -674,7 +674,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>this = simplex_setallx ( this , x )</term>
+        <term>this = optimoptimsimplex_setallx ( this , x )</term>
 
         <listitem>
           <para>Set all the coordinates of all the vertices. The vertex #k is
@@ -701,7 +701,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>this = simplex_setfv ( this , ive , fv )</term>
+        <term>this = optimsimplex_setfv ( this , ive , fv )</term>
 
         <listitem>
           <para>Set the function value at given index and // returns an
@@ -736,7 +736,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>this = simplex_setn ( this , n )</term>
+        <term>this = optimsimplex_setn ( this , n )</term>
 
         <listitem>
           <para>Set the dimension of the space of the simplex.</para>
@@ -762,7 +762,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>this = simplex_setnbve ( this , nbve )</term>
+        <term>this = optimsimplex_setnbve ( this , nbve )</term>
 
         <listitem>
           <para>Set the number of vertices of the simplex.</para>
@@ -788,7 +788,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>this = simplex_setve ( this , ive , fv , x )</term>
+        <term>this = optimsimplex_setve ( this , ive , fv , x )</term>
 
         <listitem>
           <para>Sets the coordinates of the vertex and the function value at
@@ -831,7 +831,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>this = simplex_setx ( this , ive , x )</term>
+        <term>this = optimsimplex_setx ( this , ive , x )</term>
 
         <listitem>
           <para>Set the coordinates of the vertex at given index, as a column
@@ -866,7 +866,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>simplex = simplex_getall ( this )</term>
+        <term>simplex = optimsimplex_getall ( this )</term>
 
         <listitem>
           <para>Returns all the coordinates of all the vertices and the
@@ -908,7 +908,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>fv = simplex_getallfv ( this )</term>
+        <term>fv = optimsimplex_getallfv ( this )</term>
 
         <listitem>
           <para>Returns all the function values of all the vertices, as a
@@ -936,7 +936,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>x = simplex_getallx ( this )</term>
+        <term>x = optimsimplex_getallx ( this )</term>
 
         <listitem>
           <para>Returns all the coordinates of all the vertices.</para>
@@ -965,7 +965,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>fv = simplex_getfv ( this , ive )</term>
+        <term>fv = optimsimplex_getfv ( this , ive )</term>
 
         <listitem>
           <para>Returns the function value at given index</para>
@@ -991,7 +991,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>n = simplex_getn ( this )</term>
+        <term>n = optimsimplex_getn ( this )</term>
 
         <listitem>
           <para>Returns the dimension of the space of the simplex</para>
@@ -1009,7 +1009,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>n = simplex_getnbve ( this )</term>
+        <term>n = optimsimplex_getnbve ( this )</term>
 
         <listitem>
           <para>Returns the number of vertices in the simplex.</para>
@@ -1027,7 +1027,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>vertex = simplex_getve ( this , ive )</term>
+        <term>vertex = optimsimplex_getve ( this , ive )</term>
 
         <listitem>
           <para>Returns the vertex at given index as a tlist, with fields n, x
@@ -1054,7 +1054,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>x = simplex_getx ( this , ive )</term>
+        <term>x = optimsimplex_getx ( this , ive )</term>
 
         <listitem>
           <para>Returns the coordinates of the vertex at given index, as a
@@ -1081,7 +1081,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>sicenter = simplex_center ( this )</term>
+        <term>sicenter = optimsimplex_center ( this )</term>
 
         <listitem>
           <para>Returns the center of the given simplex</para>
@@ -1099,7 +1099,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>simplex_check ( this )</term>
+        <term>optimsimplex_check ( this )</term>
 
         <listitem>
           <para>Check the consistency of the internal data. Generates an error
@@ -1118,7 +1118,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>[ this , data ] = simplex_computefv ( this , fun , data )</term>
+        <term>[ this , data ] = optimsimplex_computefv ( this , fun , data )</term>
 
         <listitem>
           <para>Set the values of the function at vertices points.</para>
@@ -1171,7 +1171,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>df = simplex_deltafv ( this )</term>
+        <term>df = optimsimplex_deltafv ( this )</term>
 
         <listitem>
           <para>Returns the vector of difference of function values with
@@ -1190,7 +1190,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>dfm = simplex_deltafvmax ( this )</term>
+        <term>dfm = optimsimplex_deltafvmax ( this )</term>
 
         <listitem>
           <para>Returns the difference of function value between the high and
@@ -1212,7 +1212,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>m = simplex_dirmat ( this )</term>
+        <term>m = optimsimplex_dirmat ( this )</term>
 
         <listitem>
           <para>Returns the n x n matrix of simplex directions i.e. the matrix
@@ -1232,7 +1232,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>sd = simplex_fvmean ( this )</term>
+        <term>sd = optimsimplex_fvmean ( this )</term>
 
         <listitem>
           <para>Returns the mean of the function value on the simplex.</para>
@@ -1250,7 +1250,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>sd = simplex_fvstdev ( this )</term>
+        <term>sd = optimsimplex_fvstdev ( this )</term>
 
         <listitem>
           <para>Returns the standard deviation of the function value on the
@@ -1269,7 +1269,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>[ g , data ] = simplex_gradientfv ( this , fun , method , data
+        <term>[ g , data ] = optimsimplex_gradientfv ( this , fun , method , data
         )</term>
 
         <listitem>
@@ -1337,7 +1337,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>[ ns , data ] = simplex_oriented ( this , fun , data )</term>
+        <term>[ ns , data ] = optimsimplex_oriented ( this , fun , data )</term>
 
         <listitem>
           <para>Returns a new oriented simplex, in sorted order. The new
@@ -1394,7 +1394,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>simplex_print ( this )</term>
+        <term>optimsimplex_print ( this )</term>
 
         <listitem>
           <para>Display the current simplex, with coordinates and function
@@ -1413,7 +1413,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>[ r , data ] = simplex_reflect ( this , fun , data )</term>
+        <term>[ r , data ] = optimsimplex_reflect ( this , fun , data )</term>
 
         <listitem>
           <para>Returns a new simplex by reflexion of current simplex, by
@@ -1468,7 +1468,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>[ this , data ] = simplex_shrink ( this , fun , sigma , data
+        <term>[ this , data ] = optimsimplex_shrink ( this , fun , sigma , data
         )</term>
 
         <listitem>
@@ -1533,7 +1533,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>ssize = simplex_size ( this , method )</term>
+        <term>ssize = optimsimplex_size ( this , method )</term>
 
         <listitem>
           <para>Returns the size of the simplex.</para>
@@ -1542,7 +1542,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
           requires 2 nested loops over the vertices.</para>
 
           <para>The sigmaminus (resp. sigmamplus) size is the minimum (resp.
-          maximum) length of the vector from the given vertex to the first
+          maximum) length of the vector from each vertex to the first
           vertex. It requires one loop over the vertices.</para>
 
           <para>The "Nash" size is the sum of the norm of the length of the
@@ -1572,7 +1572,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>this = simplex_sort ( this )</term>
+        <term>this = optimsimplex_sort ( this )</term>
 
         <listitem>
           <para>Sorts the simplex with increasing function value order so that
@@ -1591,7 +1591,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>str = simplex_tostring ( this )</term>
+        <term>str = optimsimplex_tostring ( this )</term>
 
         <listitem>
           <para>Returns the current simplex as a string.</para>
@@ -1609,7 +1609,7 @@ cen = simplex_xbar ( this , iexcl )</synopsis>
       </varlistentry>
 
       <varlistentry>
-        <term>cen = simplex_xbar ( this , iexcl )</term>
+        <term>cen = optimsimplex_xbar ( this , iexcl )</term>
 
         <listitem>
           <para>Returns the center of n vertices, by excluding the vertex with
@@ -1653,11 +1653,11 @@ coords = [
 0.0 1.0 0.0
 0.0 0.0 1.0
 ];
-s1 = simplex_new ( coords );
-computed = simplex_getallx ( s1 );
-computed = simplex_getn(s1);
-computed = simplex_getnbve (s1);
-s1 = simplex_destroy(s1);
+s1 = optimsimplex_new ( coords );
+computed = optimsimplex_getallx ( s1 );
+computed = optimsimplex_getn(s1);
+computed = optimsimplex_getnbve (s1);
+s1 = optimsimplex_destroy(s1);
     </programlisting>
   </refsection>
 
@@ -1680,10 +1680,10 @@ endfunction
 
 mydude = tlist(["T_MYSTUFF","nb"]);
 mydude.nb = 0;
-s1 = simplex_new ();
-[ s1 , mydude ] = simplex_randbounds ( s1 , x0 = [-1.2 1.0], fun = mycostf, ...
+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 = simplex_destroy ( s1 );
+s1 = optimsimplex_destroy ( s1 );
 
     </programlisting>
   </refsection>