Fix many common typos 68/5568/2
Sylvestre Ledru [Sun, 4 Dec 2011 21:34:11 +0000 (22:34 +0100)]
Change-Id: Ib42dc5f7941623e994b8fd007536e494545bf254

82 files changed:
scilab/modules/api_scilab/help/en_US/api_scilab.xml
scilab/modules/atoms/help/en_US/atomsIsInstalled.xml
scilab/modules/cacsd/help/en_US/csim.xml
scilab/modules/cacsd/help/en_US/findBD.xml
scilab/modules/cacsd/help/en_US/m_circle.xml
scilab/modules/cacsd/help/en_US/nehari.xml
scilab/modules/cacsd/help/en_US/repfreq.xml
scilab/modules/call_scilab/help/en_US/TerminateScilab.xml
scilab/modules/core/help/en_US/macr2lst.xml
scilab/modules/core/help/en_US/scilab.xml
scilab/modules/development_tools/help/en_US/assert/assert_checkfilesequal.xml
scilab/modules/development_tools/help/en_US/assert/assert_generror.xml
scilab/modules/differential_equations/help/en_US/bvode.xml
scilab/modules/differential_equations/help/en_US/ode.xml
scilab/modules/dynamic_link/help/en_US/G_make.xml
scilab/modules/elementary_functions/help/en_US/bitwise/bitcmp.xml
scilab/modules/fileio/help/en_US/fileparts.xml
scilab/modules/fileio/help/en_US/get_absolute_file_path.xml
scilab/modules/fileio/help/en_US/io.xml
scilab/modules/fileio/help/en_US/listvarinfile.xml
scilab/modules/fileio/help/en_US/mfscanf.xml
scilab/modules/genetic_algorithms/help/en_US/selection_ga_elitist.xml
scilab/modules/genetic_algorithms/help/en_US/selection_ga_random.xml
scilab/modules/graphics/help/en_US/2d_plot/LineSpec.xml
scilab/modules/graphics/help/en_US/2d_plot/grayplot_properties.xml
scilab/modules/graphics/help/en_US/2d_plot/histplot.xml
scilab/modules/graphics/help/en_US/2d_plot/plot.xml
scilab/modules/graphics/help/en_US/3d_plot/surf.xml
scilab/modules/graphics/help/en_US/3d_plot/surface_properties.xml
scilab/modules/graphics/help/en_US/GlobalProperty.xml
scilab/modules/graphics/help/en_US/axes_operations/plotframe.xml
scilab/modules/graphics/help/en_US/bar_histogram/bar.xml
scilab/modules/graphics/help/en_US/bar_histogram/barh.xml
scilab/modules/graphics/help/en_US/datatips/datatipInitStruct.xml
scilab/modules/graphics/help/en_US/datatips/datatips.xml
scilab/modules/graphics/help/en_US/graphics_entities.xml
scilab/modules/gui/help/en_US/unsetmenu.xml
scilab/modules/gui/help/en_US/x_choose.xml
scilab/modules/gui/help/en_US/x_choose_modeless.xml
scilab/modules/interpolation/help/en_US/cshep2d.xml
scilab/modules/interpolation/help/en_US/lsq_splin.xml
scilab/modules/interpolation/help/en_US/splin.xml
scilab/modules/interpolation/help/en_US/splin2d.xml
scilab/modules/io/help/en_US/unix_g.xml
scilab/modules/javasci/help/en_US/v1/Scilab.xml
scilab/modules/m2sci/help/en_US/get_contents_infer.xml
scilab/modules/m2sci/help/en_US/m2sci_equivalents/f/fopen.xml
scilab/modules/m2sci/help/en_US/m2sci_equivalents/p/pow2.xml
scilab/modules/m2sci/help/en_US/matfile2sci.xml
scilab/modules/matio/help/en_US/loadmatfile.xml
scilab/modules/matio/help/en_US/savematfile.xml
scilab/modules/optimization/help/en_US/leastsq.xml
scilab/modules/optimization/help/en_US/lsqrsolve.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/neldermead_overview.xml
scilab/modules/optimization/help/en_US/neldermead/nmplot.xml
scilab/modules/optimization/help/en_US/neldermead/optimset.xml
scilab/modules/optimization/help/en_US/qp_solve.xml
scilab/modules/optimization/help/en_US/qpsolve.xml
scilab/modules/optimization/help/en_US/readmps.xml
scilab/modules/optimization/help/en_US/semidefprog/vec2list.xml
scilab/modules/output_stream/help/en_US/printf_conversion.xml
scilab/modules/parallel/help/en_US/parallel_run.xml
scilab/modules/randlib/help/en_US/grand.xml
scilab/modules/signal_processing/help/en_US/fft.xml
scilab/modules/sparse/help/en_US/decomposition/lufact.xml
scilab/modules/special_functions/help/en_US/bessel.xml
scilab/modules/spreadsheet/help/en_US/xls_open.xml
scilab/modules/statistics/help/en_US/samplef.xml
scilab/modules/string/help/en_US/grep.xml
scilab/modules/string/help/en_US/strsplit.xml
scilab/modules/umfpack/help/en_US/condestsp.xml
scilab/modules/xcos/help/en_US/batch_functions/xcosValidateCompareBlock.xml
scilab/modules/xcos/help/en_US/palettes/Continuous_pal/PID.xml
scilab/modules/xcos/help/en_US/palettes/Demonstrationsblocks_pal/PDE.xml
scilab/modules/xcos/help/en_US/palettes/Matrix_pal/MATRESH.xml
scilab/modules/xcos/help/en_US/palettes/Portaction_pal/OUTIMPL_f.xml
scilab/modules/xcos/help/en_US/palettes/Sources_pal/SAWTOOTH_f.xml
scilab/modules/xcos/help/en_US/programming_scicos_blocks/c_computational_functions/C_struct.xml
scilab/modules/xcos/help/en_US/scilab_data_structures/diagram/scicos_diagram.xml
scilab/modules/xml/help/en_US/xmlXPath.xml

index 298997c..e12943a 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry version="5.0-subset Scilab" xml:id="api_scilab" xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns5="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="api_scilab" xml:lang="en">
   <info>
     <pubdate>$LastChangedDate$</pubdate>
   </info>
-
   <refnamediv>
     <refname>api_scilab</refname>
-
     <refpurpose>api_scilab is the Scilab interface to read/write data from/to Scilab memory </refpurpose>
   </refnamediv>
-
   <refsection>
     <title>Description</title>
-
     <para>In the previous versions of Scilab, there was no clear or easy way to extend Scilab or to use it as an embedded application.</para>
-<para>Since Scilab 5.2.0, these issues have been tackled by API Scilab. Its provides a new consistent, documented and easy way API.
+    <para>Since Scilab 5.2.0, these issues have been tackled by API Scilab. Its provides a new consistent, documented and easy way API.
 </para>
-
     <para>This API provides functions to read/write data from/to Scilab memory.</para>
-<para>  It provides many advantages:</para>
-          <itemizedlist>
-            <listitem>
-<para>Management of all Scilab data types</para></listitem>
-<listitem>
-<para>Consistency over all data types</para></listitem>
-<listitem>
-<para>Error management</para></listitem>
-<listitem>
-<para>Fully documented</para></listitem>
-<listitem>
-<para>Fully tested by unitary tests</para></listitem>
-<listitem>
-<para>Straight and named access (See the <link linkend="call_scilab">call_scilab API</link>) to variables.</para></listitem>
-<listitem>
-<para>And it will be maintained over future versions of Scilab</para></listitem>
-</itemizedlist>
-
-<para>Usually, this API is used to extend Scilab capabilities but can be used in other contexts</para>
-
-          <itemizedlist>
-            <listitem>
-<para>Libraires or C/C++ functions: Many librairies have been developped on the free/Open source or proprietary markets. This library can be loaded and used in a high level language like Scilab. API Scilab provides the capabilities to interact with such libraries.
+    <para>  It provides many advantages:</para>
+    <itemizedlist>
+      <listitem>
+        <para>Management of all Scilab data types</para>
+      </listitem>
+      <listitem>
+        <para>Consistency over all data types</para>
+      </listitem>
+      <listitem>
+        <para>Error management</para>
+      </listitem>
+      <listitem>
+        <para>Fully documented</para>
+      </listitem>
+      <listitem>
+        <para>Fully tested by unitary tests</para>
+      </listitem>
+      <listitem>
+        <para>Straight and named access (See the <link linkend="call_scilab">call_scilab API</link>) to variables.</para>
+      </listitem>
+      <listitem>
+        <para>And it will be maintained over future versions of Scilab</para>
+      </listitem>
+    </itemizedlist>
+    <para>Usually, this API is used to extend Scilab capabilities but can be used in other contexts</para>
+    <itemizedlist>
+      <listitem>
+        <para>Libraires or C/C++ functions: Many librairies have been developed on the free/Open source or proprietary markets. This library can be loaded and used in a high level language like Scilab. API Scilab provides the capabilities to interact with such libraries.
 </para>
-            </listitem>
-            <listitem>
-<para>Scilab can be used as computing engine from a third party software. This feature is called <link linkend="call_scilab">call_scilab</link> when Scilab is used from C/C++ code or  <link linkend="javasci">javasci</link> when used from Java. Access to variable is done through their names (named variable).
+      </listitem>
+      <listitem>
+        <para>Scilab can be used as computing engine from a third party software. This feature is called <link linkend="call_scilab">call_scilab</link> when Scilab is used from C/C++ code or  <link linkend="javasci">javasci</link> when used from Java. Access to variable is done through their names (named variable).
 </para>
-            </listitem>
-</itemizedlist>
-   <para>Note that old APIs (stackX.h) will not be available after Scilab 6.0 (included).</para>
+      </listitem>
+    </itemizedlist>
+    <para>Note that old APIs (stackX.h) will not be available after Scilab 6.0 (included).</para>
   </refsection>
-
   <refsection>
     <title>See Also - API_Scilab</title>
-
     <simplelist type="inline">
-      <member>
-<link linkend="boolean_reading_API">boolean reading API</link>,
+      <member><link linkend="boolean_reading_API">boolean reading API</link>,
       </member>
-      <member>
-<link linkend="boolean_writing_API">boolean writing API</link>,
+      <member><link linkend="boolean_writing_API">boolean writing API</link>,
       </member>
-      <member>
-<link linkend="bsparse_reading_API">bsparse reading API</link>,
+      <member><link linkend="bsparse_reading_API">bsparse reading API</link>,
       </member>
-      <member>
-<link linkend="bsparse_writing_API">bsparse writing API</link>,
+      <member><link linkend="bsparse_writing_API">bsparse writing API</link>,
       </member>
-      <member>
-<link linkend="Common_getvaraddr_API">Common getvaraddr API</link>,
+      <member><link linkend="Common_getvaraddr_API">Common getvaraddr API</link>,
       </member>
-      <member>
-<link linkend="Common_getvardimension_API">Common getvardimension API</link>,
+      <member><link linkend="Common_getvardimension_API">Common getvardimension API</link>,
       </member>
-      <member>
-<link linkend="Common_getvartype_API">Common getvartype API</link>,
+      <member><link linkend="Common_getvartype_API">Common getvartype API</link>,
       </member>
-      <member>
-<link linkend="Common_iscomplex_API">Common iscomplex API</link>,
+      <member><link linkend="Common_iscomplex_API">Common iscomplex API</link>,
       </member>
-      <member>
-<link linkend="Common_isvarmatrixtype_API">Common isvarmatrixtype API</link>,
+      <member><link linkend="Common_isvarmatrixtype_API">Common isvarmatrixtype API</link>,
       </member>
-      <member>
-<link linkend="Double_management_reading_API">Double management reading API</link>,
+      <member><link linkend="Double_management_reading_API">Double management reading API</link>,
       </member>
-      <member>
-<link linkend="Double_management_writing_API">Double management writing API</link>,
+      <member><link linkend="Double_management_writing_API">Double management writing API</link>,
       </member>
-      <member>
-<link linkend="Integer_management_reading_API">Integer management reading API</link>,
+      <member><link linkend="Integer_management_reading_API">Integer management reading API</link>,
       </member>
-      <member>
-<link linkend="Integer_management_writing_API">Integer management writing API</link>,
+      <member><link linkend="Integer_management_writing_API">Integer management writing API</link>,
       </member>
-      <member>
-<link linkend="int_getmatrixofintegerprecision_API">getmatrixofintegerprecision API</link>,
+      <member><link linkend="int_getmatrixofintegerprecision_API">getmatrixofintegerprecision API</link>,
       </member>
-      <member>
-<link linkend="Pointer_reading_API">Pointer reading API</link>,
+      <member><link linkend="Pointer_reading_API">Pointer reading API</link>,
       </member>
-      <member>
-<link linkend="Pointer_writing_API">Pointer writing API</link>,
+      <member><link linkend="Pointer_writing_API">Pointer writing API</link>,
       </member>
-      <member>
-<link linkend="poly_getpolyvariablename_API">poly getpolyvariablename API</link>,
+      <member><link linkend="poly_getpolyvariablename_API">poly getpolyvariablename API</link>,
       </member>
-      <member>
-<link linkend="Polynomial_management_reading_API">Polynomial management reading API</link>,
+      <member><link linkend="Polynomial_management_reading_API">Polynomial management reading API</link>,
       </member>
-      <member>
-<link linkend="Polynomial_management_writing_API">Polynomial management writing API</link>,
+      <member><link linkend="Polynomial_management_writing_API">Polynomial management writing API</link>,
       </member>
-      <member>
-<link linkend="Sparse_management_reading_API">Sparse management reading API</link>,
+      <member><link linkend="Sparse_management_reading_API">Sparse management reading API</link>,
       </member>
-      <member>
-<link linkend="Sparse_management_writing_API">Sparse management writing_API</link>,
+      <member><link linkend="Sparse_management_writing_API">Sparse management writing_API</link>,
       </member>
-      <member>
-<link linkend="String_management_reading_API">String management reading API</link>,
+      <member><link linkend="String_management_reading_API">String management reading API</link>,
       </member>
       <member>
-<link linkend="String_management_writing_API">String management writing API</link>
-</member>
+        <link linkend="String_management_writing_API">String management writing API</link>
+      </member>
     </simplelist>
   </refsection>
-
   <refsection>
     <title>See Also - API_Scilab list management</title>
-
     <simplelist type="inline">
       <member>
-<link linkend="list_boolean_reading_API">list boolean reading API</link>
+        <link linkend="list_boolean_reading_API">list boolean reading API</link>
       </member>
       <member>
-<link linkend="list_boolean_writing_API">list boolean writing API</link>
+        <link linkend="list_boolean_writing_API">list boolean writing API</link>
       </member>
       <member>
-<link linkend="list_bsparse_reading_API">list bsparse reading API</link>
+        <link linkend="list_bsparse_reading_API">list bsparse reading API</link>
       </member>
       <member>
-<link linkend="list_bsparse_writing_API">list bsparse writing API</link>
+        <link linkend="list_bsparse_writing_API">list bsparse writing API</link>
       </member>
       <member>
-<link linkend="list_createlist_API">list_createlist API</link>
+        <link linkend="list_createlist_API">list_createlist API</link>
       </member>
       <member>
-<link linkend="list_double_reading_API">list double reading API</link>
+        <link linkend="list_double_reading_API">list double reading API</link>
       </member>
       <member>
-<link linkend="list_double_writing_API">list double writing API</link>
+        <link linkend="list_double_writing_API">list double writing API</link>
       </member>
       <member>
-<link linkend="list_getlistitemaddress_API">list getlistitemaddress API</link>
+        <link linkend="list_getlistitemaddress_API">list getlistitemaddress API</link>
       </member>
       <member>
-<link linkend="list_getlistitemnumber_API">list getlistitemnumber API</link>
+        <link linkend="list_getlistitemnumber_API">list getlistitemnumber API</link>
       </member>
       <member>
-<link linkend="list_integer_reading_API">list integer reading API</link>
+        <link linkend="list_integer_reading_API">list integer reading API</link>
       </member>
       <member>
-<link linkend="list_integer_writing_API">list integer writing API</link>
+        <link linkend="list_integer_writing_API">list integer writing API</link>
       </member>
       <member>
-<link linkend="list_pointer_reading_API">list pointer reading API</link>
+        <link linkend="list_pointer_reading_API">list pointer reading API</link>
       </member>
       <member>
-<link linkend="list_pointer_writing_API">list pointer writing API</link>
+        <link linkend="list_pointer_writing_API">list pointer writing API</link>
       </member>
       <member>
-<link linkend="list_poly_reading_API">list poly reading API</link>
+        <link linkend="list_poly_reading_API">list poly reading API</link>
       </member>
       <member>
-<link linkend="list_poly_writing_API">list poly writing API</link>
+        <link linkend="list_poly_writing_API">list poly writing API</link>
       </member>
       <member>
-<link linkend="list_sparse_reading_API">list sparse reading API</link>
+        <link linkend="list_sparse_reading_API">list sparse reading API</link>
       </member>
       <member>
-<link linkend="list_sparse_writing_API">list sparse writing API</link>
+        <link linkend="list_sparse_writing_API">list sparse writing API</link>
       </member>
       <member>
-<link linkend="list_string_reading_API">list string reading API</link>
+        <link linkend="list_string_reading_API">list string reading API</link>
       </member>
       <member>
-<link linkend="list_string_writing_API">list string writing API</link>
-</member>
+        <link linkend="list_string_writing_API">list string writing API</link>
+      </member>
     </simplelist>
   </refsection>
-
   <refsection>
     <title>See Also - call_scilab</title>
-
     <simplelist type="inline">
       <member>
-       <link linkend="call_scilab">Call_Scilab</link>
+        <link linkend="call_scilab">Call_Scilab</link>
       </member>
       <member>
-       <link linkend="compile_and_run_call_scilab">Compile and run with call_scilab</link>
+        <link linkend="compile_and_run_call_scilab">Compile and run with call_scilab</link>
       </member>
       <member>
-       <link linkend="DoubleManagement_callscilab">Matrix Management</link>
+        <link linkend="DoubleManagement_callscilab">Matrix Management</link>
       </member>
       <member>
-       <link linkend="BooleanManagement_callscilab">Boolean Management</link>
+        <link linkend="BooleanManagement_callscilab">Boolean Management</link>
       </member>
       <member>
-       <link linkend="ComplexManagement_callscilab">Complex Management</link>
+        <link linkend="ComplexManagement_callscilab">Complex Management</link>
       </member>
       <member>
-       <link linkend="StringManagement_callscilab">String Management</link>
+        <link linkend="StringManagement_callscilab">String Management</link>
       </member>
     </simplelist>
   </refsection>
-
   <refsection>
     <title>Authors</title>
-
     <para>Sylvestre Ledru</para>
   </refsection>
 </refentry>
index ee033a4..8422735 100644 (file)
   <refsection>
     <title>Arguments</title>
     <variablelist>
-                       
-                       <!-- 1st input parameter -->
-                       
-                       <varlistentry>
+      <!-- 1st input parameter -->
+      <varlistentry>
         <term>modules</term>
         <listitem>
-                                       
           <para>
                                                mx1, mx2 Matrix of strings:
                                        </para>
-                                       
-                                       <informaltable border="1">
-                                               
-                                               <!-- Technical name -->
-                                               
-                                               <tr>
-                                                       <td>
-                                                               <emphasis>1st Col.</emphasis>
-                                                       </td>
-                                                       <td>
-                                                               <emphasis role="strong">Technical name</emphasis>
-                                                       </td>
-                                                       <td>
+          <informaltable border="1">
+            <!-- Technical name -->
+            <tr>
+              <td>
+                <emphasis>1st Col.</emphasis>
+              </td>
+              <td>
+                <emphasis role="strong">Technical name</emphasis>
+              </td>
+              <td>
                                                                Mandatory
                                                        </td>
-                                                       <td>
+              <td>
                                                        </td>
-                                               </tr>
-                                               
-                                               <!-- Version -->
-                                               
-                                               <tr>
-                                                       <td>
-                                                               <emphasis>2nd Col.</emphasis>
-                                                       </td>
-                                                       <td>
-                                                               <emphasis role="strong">Version</emphasis>
-                                                       </td>
-                                                       <td>
+            </tr>
+            <!-- Version -->
+            <tr>
+              <td>
+                <emphasis>2nd Col.</emphasis>
+              </td>
+              <td>
+                <emphasis role="strong">Version</emphasis>
+              </td>
+              <td>
                                                                Optionnal
                                                        </td>
-                                                       <td>
+              <td>
                                                                If this field is empty or is not present,
                                                                module's version is ignored.
                                                        </td>
-                                               </tr>
-                                               
-                                               <!-- Section -->
-                                               
-                                               <tr>
-                                                       <td>
-                                                               <emphasis>3rd Col.</emphasis>
-                                                       </td>
-                                                       <td>
-                                                               <emphasis role="strong">Section</emphasis>
-                                                       </td>
-                                                       <td>
+            </tr>
+            <!-- Section -->
+            <tr>
+              <td>
+                <emphasis>3rd Col.</emphasis>
+              </td>
+              <td>
+                <emphasis role="strong">Section</emphasis>
+              </td>
+              <td>
                                                                Optionnal
                                                        </td>
-                                                       <td>
+              <td>
                                                                If this field is empty or is not present,
                                                                module's section is ignored.
                                                        </td>
-                                               </tr>
-                                               
-                                       </informaltable>
-                               </listitem>
+            </tr>
+          </informaltable>
+        </listitem>
       </varlistentry>
-                       
-                       <!-- 2nd input parameter -->
-                       
-                       <varlistentry>
+      <!-- 2nd input parameter -->
+      <varlistentry>
         <term>section</term>
         <listitem>
           <para>
                                                This argument controls the list of searched modules.
                                        </para>
-          <para>
-                                               <literal>section</literal> is a single-string and its value should be :
+          <para><literal>section</literal> is a single-string and its value should be :
                                        </para>
           <itemizedlist>
             <listitem>
-              <para>
-                                                               <literal>"all"</literal>: atomsIsInstalled() searchs external
+              <para><literal>"all"</literal>: atomsIsInstalled() searches external
                                                                modules installed in both "user" and "allusers" sections.
                                                        </para>
             </listitem>
             <listitem>
-              <para>
-                                                               <literal>"allusers"</literal>: atomsIsInstalled() searchs external
+              <para><literal>"allusers"</literal>: atomsIsInstalled() searches external
                                                                modules installed in the "allusers" section.
                                                        </para>
             </listitem>
             <listitem>
-              <para>
-                                                               <literal>"user"</literal>: atomsIsInstalled() searchs external
+              <para><literal>"user"</literal>: atomsIsInstalled() searches external
                                                                modules installed in the "user" section.
                                                        </para>
             </listitem>
           </itemizedlist>
-                                       <para>
+          <para>
                                                The default value is "all".
                                        </para>
         </listitem>
-                       </varlistentry>
-                       
+      </varlistentry>
       <varlistentry>
         <term>res</term>
         <listitem>
   <!-- ===================================================================== -->
   <refsection>
     <title>Examples</title>
-    <programlisting role="example">
-<![CDATA[
+    <programlisting role="example"><![CDATA[
 atomsSetConfig("Verbose","True");
 atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
 
@@ -183,14 +164,13 @@ atomsIsInstalled(["toolbox_5" "1.0" ; "toolbox_4" "1.0" ; "toolbox_5" "1.1"],"al
 // Some cleaning ...
 atomsRepositoryDel("http://scene2.test.atoms.scilab.org");
 atomsRemove("toolbox_2");
-]]>
-               </programlisting>
+]]></programlisting>
   </refsection>
   <!-- ===================================================================== -->
   <!-- See also -->
   <!-- ===================================================================== -->
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="atomsInstall">atomsInstall</link>
index cf435c2..6dee677 100644 (file)
@@ -86,7 +86,7 @@
     (here <literal>sl</literal> is assumed SISO without direct feed-through and
     <literal>x0=0</literal>)</para>
     <para>
-    5. a vector giving the values of u correponding to each t value.</para>
+    5. a vector giving the values of u corresponding to each t value.</para>
   </refsection>
   <refsection>
     <title>Examples</title>
@@ -110,7 +110,7 @@ clf();plot2d([t',t'],[(csim(input,t,w))',0*t'])
 ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="syslin">syslin</link>
index 148e0b3..ebe4f8e 100644 (file)
       <varlistentry>
         <term>B</term>
         <listitem>
-          <para>optionnal, input matrix of the given system</para>
+          <para>optional, input matrix of the given system</para>
         </listitem>
       </varlistentry>
       <varlistentry>
       <varlistentry>
         <term>D</term>
         <listitem>
-          <para>optionnal, direct feedthrough of the given system</para>
+          <para>optional, direct feedthrough of the given system</para>
         </listitem>
       </varlistentry>
       <varlistentry>
       <varlistentry>
         <term>tol</term>
         <listitem>
-          <para>optionnal, tolerance used for estimating the rank of
+          <para>optional, tolerance used for estimating the rank of
   matrices. If  tol &gt; 0,  then the given value of  tol  is used as
   a lower bound for the reciprocal condition number; an m-by-n matrix
   whose estimated condition number is less than  1/tol  is considered
       <varlistentry>
         <term>printw</term>
         <listitem>
-          <para>optionnal, switch for printing the warning messages.</para>
+          <para>optional, switch for printing the warning messages.</para>
           <variablelist>
             <varlistentry>
               <term>=  </term>
     matrices B and D of a discrete-time system, using SLICOT routine 
     IB01CD.
   </para>
-    <programlisting role = ""><![CDATA[ 
+    <programlisting role=""><![CDATA[ 
    [x0,Br,V,rcnd] = findBD(1,1,1,A,C,Y,U)
 [x0,Br,Dr,V,rcnd] = findBD(1,1,2,A,C,Y,U)
       [Br,V,rcnd] = findBD(2,1,1,A,C,Y,U)
     <para>
     The model structure is :
   </para>
-    <programlisting role = ""><![CDATA[ 
+    <programlisting role=""><![CDATA[ 
 x(k+1) = Ax(k) + Bu(k),   k >= 1,
 y(k)   = Cx(k) + Du(k),
  ]]></programlisting>
@@ -309,7 +309,7 @@ clf();plot2d((1:nsmp)',[Y',Y1'])
 ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="inistate">inistate</link>
index 5bf8560..b7b3354 100644 (file)
@@ -49,10 +49,10 @@ m_circle(gain)</synopsis>
     plane (Re,Im).</para>
     <para>The default value for <literal>gain</literal> is:</para>
     <para>
-    <literal>[-12 -8 -6 -5 -4 -3 -2 -1.4 -1 -.5 0.25 0.5 0.7 1 1.4 2 2.3 3 4 5 6 8 12]</literal>
+      <literal>[-12 -8 -6 -5 -4 -3 -2 -1.4 -1 -.5 0.25 0.5 0.7 1 1.4 2 2.3 3 4 5 6 8 12]</literal>
     </para>
     <para><literal>m_circle</literal> is used with <literal>nyquist</literal>.</para>
-   <para>This function is superseeded by the <link linkend="hallchart">hallchart</link> function.</para>
+    <para>This function is superseded by the <link linkend="hallchart">hallchart</link> function.</para>
   </refsection>
   <refsection>
     <title>Examples</title>
@@ -70,7 +70,7 @@ m_circle([-8 -6 -4]);
 ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="nyquist">nyquist</link>
index ee83829..9fc07c0 100644 (file)
@@ -16,7 +16,7 @@
   </info>
   <refnamediv>
     <refname>nehari</refname>
-    <refpurpose>Nehari approximant of continous time dynamical systems</refpurpose>
+    <refpurpose>Nehari approximant of continuous time dynamical systems</refpurpose>
   </refnamediv>
   <refsynopsisdiv>
     <title>Calling Sequence</title>
@@ -51,7 +51,7 @@
     <para><literal>R</literal> = linear system in state-space representation (<literal>syslin</literal> list).</para>
     <para><literal>R</literal> is strictly proper and <literal>- R~</literal> is stable 
     (i.e. <literal>R</literal> is anti stable).</para>
-    <programlisting role = ""><![CDATA[ 
+    <programlisting role=""><![CDATA[ 
 || R - X ||oo = min || R - Y ||oo
               Y in Hoo
  ]]></programlisting>
index 255fc3f..f463689 100644 (file)
@@ -31,7 +31,7 @@
       <varlistentry>
         <term>sys</term>
         <listitem>
-          <para> <literal>syslin</literal> list : SIMO linear system</para>
+          <para><literal>syslin</literal> list : SIMO linear system</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -82,7 +82,7 @@
     <para>
     If <literal>step</literal> is not given, the output parameter <literal>frq</literal> is calculated by <literal>frq=calfrq(sys,fmin,fmax)</literal>.</para>
     <para>
-    Vector <literal>frq</literal> is splitted into regular parts with the <literal>split</literal> vector.
+    Vector <literal>frq</literal> is split into regular parts with the <literal>split</literal> vector.
     <literal>frq(splitf(k):splitf(k+1)-1)</literal> has no critical frequency. 
     <literal>sys</literal> has a pole in the range <literal>[frq(splitf(k)),frq(splitf(k)+1)]</literal> and 
     no poles outside.</para>
@@ -107,7 +107,7 @@ repf(2)-x
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="bode">bode</link>
index f384efb..ceb01e8 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry version="5.0-subset Scilab" xml:id="TerminateScilab" xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns5="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="TerminateScilab" xml:lang="en">
   <info>
     <pubdate>$LastChangedDate$</pubdate>
   </info>
-
   <refnamediv>
     <refname>TerminateScilab</refname>
-
     <refpurpose>Stops and terminates Scilab engine in Call Scilab</refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <synopsis>BOOL TerminateScilab(char *ScilabQuit);</synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Description</title>
-
-    <para>This fonction stops the Scilab engine. It is strongly recommanded to
+    <para>This fonction stops the Scilab engine. It is strongly recommended to
     call this function at the end when using Call Scilab .</para>
-
     <para>BOOL is just a simple typedef on int (<literal>typedef int
     BOOL</literal>). TRUE is defined on 1 (<literal>#define TRUE 1</literal>)
     and FALSE is defined on 0 (<literal>#define FALSE 0</literal>).</para>
   </refsection>
-
   <refsection>
     <title>Arguments</title>
-
     <variablelist>
       <varlistentry>
         <term>ScilabQuit</term>
-
         <listitem>
           <para>a standard C char* containing the path to Scilab quit script
           (scilab.quit)</para>
-
           <para>If ScilabStartup is NULL, Scilab will use the default path
           (detected from SCIpath).</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>returns</term>
-
         <listitem>
           <para>1 (TRUE) if the operation is successfull.</para>
-
           <para>0 (FALSE) if an error during initialization occured.</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Examples</title>
-
     <programlisting role="example"><![CDATA[ 
 // A simple TerminateScilab example
 if ( TerminateScilab(NULL) == FALSE ) {
@@ -81,44 +60,40 @@ if ( TerminateScilab(NULL) == FALSE ) {
 }
  ]]></programlisting>
   </refsection>
-
   <refsection role="see also">
-<title>See Also</title>
-
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
-       <link linkend="call_scilab">Call_Scilab</link>
+        <link linkend="call_scilab">Call_Scilab</link>
       </member>
       <member>
-       <link linkend="api_scilab">api Scilab</link>
+        <link linkend="api_scilab">api Scilab</link>
       </member>
       <member>
-       <link linkend="compile_and_run_call_scilab">Compile and run with call_scilab</link>
+        <link linkend="compile_and_run_call_scilab">Compile and run with call_scilab</link>
       </member>
       <member>
-       <link linkend="StartScilab">StartScilab</link>
+        <link linkend="StartScilab">StartScilab</link>
       </member>
       <member>
-       <link linkend="SendScilabJob">SendScilabJob</link>
+        <link linkend="SendScilabJob">SendScilabJob</link>
       </member>
       <member>
-       <link linkend="DoubleManagement_callscilab">Double Management</link>
+        <link linkend="DoubleManagement_callscilab">Double Management</link>
       </member>
       <member>
-       <link linkend="BooleanManagement_callscilab">Boolean Management</link>
+        <link linkend="BooleanManagement_callscilab">Boolean Management</link>
       </member>
       <member>
-       <link linkend="ComplexManagement_callscilab">Complex Management</link>
+        <link linkend="ComplexManagement_callscilab">Complex Management</link>
       </member>
       <member>
-       <link linkend="StringManagement_callscilab">String Management</link>
+        <link linkend="StringManagement_callscilab">String Management</link>
       </member>
     </simplelist>
   </refsection>
-
   <refsection>
     <title>Authors</title>
-
     <para>Sylvestre Ledru</para>
   </refsection>
 </refentry>
index 70f4e68..76700c8 100644 (file)
         <td>100*fun, #rhs, #lhs, fin</td>
       </tr>
     </informaltable>
-    <para>The <link linkend="fun2string">fun2string</link> function can be used to generate the intial code.</para>
+    <para>The <link linkend="fun2string">fun2string</link> function can be used to generate the initial code.</para>
   </refsection>
   <refsection>
     <title>Examples</title>
@@ -180,7 +180,7 @@ fun2string(L)
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="macrovar">macrovar</link>
index 5f93740..0228e46 100644 (file)
@@ -284,7 +284,7 @@ scilab -l ja_JP
         <term>-verbose:jni / -Xcheck:jni</term>
         <listitem>
           <para>These options enable more checks and output from the JNI
-          calls. These options are usefull in case of debugging and are
+          calls. These options are useful in case of debugging and are
           disabled by default since they decreases performances.</para>
         </listitem>
       </varlistentry>
index e312ad3..54bc344 100644 (file)
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
  * 
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-
-<refentry version="5.0-subset Scilab" xml:id="assert_checkfilesequal" xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns3="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
-
-
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="assert_checkfilesequal" xml:lang="en">
   <refnamediv>
     <refname>assert_checkfilesequal</refname>
     <refpurpose>Check that two files are equal.</refpurpose>
   </refnamediv>
-
-
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
     <synopsis>
@@ -38,7 +25,6 @@
 
     </synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Parameters</title>
     <variablelist>
@@ -74,7 +60,6 @@
       </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Description</title>
     <para>
     </para>
     <para>
       If the files are not equal,
-      <itemizedlist>
-        <listitem><para>if the errmsg output variable is not used, an error is generated,</para></listitem>
-        <listitem><para>if the errmsg output variable is used, no error is generated.</para></listitem>
-      </itemizedlist>
+      <itemizedlist><listitem><para>if the errmsg output variable is not used, an error is generated,</para></listitem><listitem><para>if the errmsg output variable is used, no error is generated.</para></listitem></itemizedlist>
     </para>
     <para>
       If the comparison function compfun is a function, it should have header areequal = compfun ( txtcomp , txtref )
     <para>
     </para>
   </refsection>
-
   <refsection>
     <title>Examples</title>
-    <programlisting role="example">
-      <![CDATA[
+    <programlisting role="example"><![CDATA[
 //
 // Prepare data for the tests
 // fileref1 : three lines of text.
@@ -147,7 +127,7 @@ flag = assert_checkfilesequal ( filecomp2 , fileref1 )
 // fileref2 == filecomp3, given that comment lines are ignored.
 // fileref2 <> filecomp4, given that comment lines are ignored.
 // Notice that the comments are inserted at different positions in the files:
-// sometimes at the begining, sometimes in the middle.
+// sometimes at the beginning, sometimes in the middle.
 fileref2 = fullfile(TMPDIR,"fileref2.txt");
 txt = [
 "// bla 2"
@@ -208,10 +188,8 @@ endfunction
 // A test which fails
 [flag,errmsg] = assert_checkfilesequal ( filecomp4 , fileref2 , mycompfun )
 
-   ]]>
-    </programlisting>
+   ]]></programlisting>
   </refsection>
-
   <refsection>
     <title>Authors</title>
     <simplelist type="vert">
index 5b20d5f..3a9975c 100644 (file)
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
  * 
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-
-<refentry version="5.0-subset Scilab" xml:id="assert_generror" xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns3="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
-
-
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="assert_generror" xml:lang="en">
   <refnamediv>
     <refname>assert_generror</refname>
     <refpurpose>Generates an error.</refpurpose>
   </refnamediv>
-
-
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
     <synopsis>
@@ -37,7 +24,6 @@
 
     </synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Parameters</title>
     <variablelist>
@@ -55,7 +41,6 @@
       </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Description</title>
     <para>
       This function is called by the assert_check* function each time an error
       produced by the wrong match between expected and computed outputs is generated.
       In the case where a assert_check* function receives a wrong number of input arguments,
-      a wrong number of ouput arguments, a wrong type of input argument or a wrong content
+      a wrong number of output arguments, a wrong type of input argument or a wrong content
       of input arguments, the regular error function is called.
       This function can be customized to modify the behaviour of the assert_check* functions.
     </para>
     <para>
     </para>
   </refsection>
-
   <refsection>
     <title>Examples</title>
-    <programlisting role="example">
-      <![CDATA[
+    <programlisting role="example"><![CDATA[
 // Both these calls generate an error
 assert_generror ( "oups" );
 assert_generror ( "oups" , 123456789 );
@@ -112,10 +95,8 @@ funcprot(0);
 assert_generror = olderrorfunction;
 funcprot(back);
 
-   ]]>
-    </programlisting>
+   ]]></programlisting>
   </refsection>
-
   <refsection>
     <title>Authors</title>
     <simplelist type="vert">
index 2d3c994..3e3888d 100644 (file)
@@ -1959,7 +1959,7 @@ disp(norm(yex(x)-z(1,:)),'norm(yex(x)-z(1,:))= ')
   <refsection>
     <title>Used Functions</title>
     <para>This function is based on the Fortran routine
-    <literal>colnew</literal> developped by</para>
+    <literal>colnew</literal> developed by</para>
     <para>U. Ascher, Department of Computer Science, University of British
     Columbia, Vancouver, B.C. V6T 1W5, Canada</para>
     <para>G. Bader, institut f. Angewandte mathematik university of
@@ -1993,7 +1993,7 @@ disp(norm(yex(x)-z(1,:)),'norm(yex(x)-z(1,:))= ')
       <listitem>
         <para>U. Ascher, J. Christiansen and R.D. russell, colsys - a
         collocation code for boundary value problems, lecture notes comp.sc.
-        76, springer verlag, b. childs et. al. (eds.) (1979), 164-185.</para>
+        76, springer verlag, b. children et. al. (eds.) (1979), 164-185.</para>
       </listitem>
       <listitem>
         <para>C. Deboor and R. Weiss, solveblok: a package for solving almost
index c770a65..8e9d463 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry version="5.0-subset Scilab" xml:id="ode" xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns5="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="ode" xml:lang="en">
   <info>
     <pubdate>$LastChangedDate$</pubdate>
   </info>
-
   <refnamediv>
     <refname>ode</refname>
-
     <refpurpose>ordinary differential equation solver</refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-
     <synopsis>
       y=ode(y0,t0,t,f)
       [y,w,iw]=ode([type,]y0,t0,t [,rtol [,atol]],f [,jac] [,w,iw])
       y=ode("discrete",y0,k0,kvect,f)
     </synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Arguments</title>
-
     <variablelist>
       <varlistentry>
         <term>y0</term>
-
         <listitem>
           <para>real vector or matrix, the initial conditions.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>t0</term>
-
         <listitem>
           <para>
             real scalar, the initial time.
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>t</term>
-
         <listitem>
           <para>
             real vector, the times at which the solution is computed.
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>f</term>
-
         <listitem>
           <para>
             function, external, string or list, the right hand side of
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>type</term>
-
         <listitem>
           <para>
           a string, the solver to use. The available solvers are "adams",
         </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>rtol</term>
-
         <listitem>
           <para>
             real constant or real vector of the same size as <literal>y</literal>, the relative tolerance.
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>atol</term>
-
         <listitem>
           <para>
             real constant or real vectors of the same size as <literal>y</literal>, the absolute tolerance.
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>jac</term>
-
         <listitem>
           <para>a function, external, string or list, the Jacobian of the function f.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>w,iw</term>
-
         <listitem>
           <para>real vectors.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>ng</term>
-
         <listitem>
           <para>integer.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>g</term>
-
         <listitem>
           <para>external (function or character string or list).</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>k0</term>
-
         <listitem>
           <para>integer (initial time).</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>kvect</term>
-
         <listitem>
           <para>integer vector.</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Description</title>
-
-    <para>
-      <literal>ode</literal> solves explicit Ordinary Different Equations defined by:
+    <para><literal>ode</literal> solves explicit Ordinary Different Equations defined by:
     </para>
-
     <para>
       <latex>
         \begin{eqnarray}
         \end{eqnarray}
       </latex>
     </para>
-
     <para>
       It is an interface to various solvers, in particular to ODEPACK.
     </para>
-
     <para>
       In this help, we only describe the use of <literal>ode</literal> for
       standard explicit ODE systems.
     </para>
-
     <para>
       The simplest call of <literal>ode</literal> is:
       <literal>y=ode(y0,t0,t,f)</literal> where <literal>y0</literal> is the
       matrix of solution vectors
       <literal>y=[y(t(1)),y(t(2)),...]</literal>.
     </para>
-
     <para>
       The input argument <literal>f</literal> defines the right hand side of the
       first order differential equation. This argument is a function with a specific header.
     </para>
-
     <itemizedlist>
       <listitem>
         <para>
           If <literal>f</literal> is a Scilab function, its calling sequence
           must be
         </para>
-        <screen>
-          <![CDATA[ 
+        <screen><![CDATA[ 
 ydot = f(t,y)
- ]]>
-        </screen>
+ ]]></screen>
         <para>
           where <literal>t</literal> is a real scalar (the time) and
           <literal>y</literal> a real vector (the state) and
           <literal>ydot</literal>a real vector (the first order derivative dy/dt).
         </para>
       </listitem>
-
       <listitem>
         <para>
           If <literal>f</literal> is a string, it is 
@@ -230,43 +181,35 @@ ydot = f(t,y)
           we call <literal>ode(y0,t0,t,"fex")</literal>, then the
           subroutine <literal>fex</literal> is called.
         </para>
-
         <para>
           The Fortran routine must have the header:
         </para>
-        <screen>
-          <![CDATA[ 
+        <screen><![CDATA[ 
 fex(n,t,y,ydot)
- ]]>
-        </screen>
+ ]]></screen>
         <para>
           where <literal>n</literal> an integer, <literal>t</literal>
           a double precision scalar, <literal>y</literal> and <literal>ydot</literal> double precision
           vectors.
         </para>
-
         <para>
           The C function must have the header:
         </para>
-        <screen>
-          <![CDATA[ 
+        <screen><![CDATA[ 
 fex(int *n,double *t,double *y,double *ydot)
- ]]>
-        </screen>
+ ]]></screen>
         <para>
           where <literal>t</literal> is the time, <literal>y</literal> the
           state and <literal>ydot</literal> is the state derivative
           (dy/dt).
         </para>
-
         <para>
-          This external can be build in a OS independant way using
+          This external can be build in a OS independent way using
           <link linkend="ilib_for_link">ilib_for_link</link> and dynamically
           linked to Scilab by the <link linkend="link">link</link>
           function.
         </para>
       </listitem>
-
       <listitem>
         <para>
           It may happen that the simulator <literal>f</literal> needs extra
@@ -282,7 +225,6 @@ fex(int *n,double *t,double *y,double *ydot)
         </para>
       </listitem>
     </itemizedlist>
-
     <para>
       The function <literal>f</literal> can return a p-by-q matrix instead of a vector.
       With this matrix notation, we
@@ -293,7 +235,6 @@ fex(int *n,double *t,double *y,double *ydot)
       and the result of <literal>ode</literal> is the <literal>p-by-q(T+1)</literal> matrix
       <literal>[Y(t_0),Y(t_1),...,Y(t_T)]</literal>.
     </para>
-
     <para>
       The tolerances <literal>rtol</literal> and <literal>atol</literal> are
       threshold for relative and absolute estimated errors. The estimated
@@ -309,7 +250,6 @@ fex(int *n,double *t,double *y,double *ydot)
       <literal>rtol=1.d-3</literal> and <literal>atol=1.d-4</literal> for
       <literal>"rfk"</literal> and <literal>"fix"</literal>.
     </para>
-
     <para>
       For stiff problems, it is better to give the Jacobian of the RHS
       function as the optional argument <literal>jac</literal>.
@@ -317,7 +257,6 @@ fex(int *n,double *t,double *y,double *ydot)
       Fortran subroutine or a C function (character string) with specified
       calling sequence or a list.
     </para>
-
     <itemizedlist>
       <listitem>
         <para>
@@ -328,41 +267,30 @@ fex(int *n,double *t,double *y,double *ydot)
           <literal>J(k,i) = dfk/dxi</literal> where <literal>fk</literal> is the kth component of f.
         </para>
       </listitem>
-
       <listitem>
         <para>
           If <literal>jac</literal> is a character string it refers to the
           name of a Fortran subroutine or a C function.
         </para>
-
         <para>
           The Fortran routine must have the header:
         </para>
-
-        <screen>
-          <![CDATA[ 
+        <screen><![CDATA[ 
 subroutine fex(n,t,y,ml,mu,J,nrpd) 
 integer n,ml,mu,nrpd
 double precision t,y(*),J(*)
- ]]>
-        </screen>
-
+ ]]></screen>
         <para>
           The C function must have the header:
         </para>
-
-        <screen>
-          <![CDATA[ 
+        <screen><![CDATA[ 
 void fex(int *n,double *t,double *y,int *ml,int *mu,double *J,int *nrpd,)
- ]]>
-        </screen>
-
+ ]]></screen>
         <para>
           In most cases you have not to refer <literal>ml</literal>, <literal>mu</literal> and
           <literal>nrpd</literal>.
         </para>
       </listitem>
-
       <listitem>
         <para>
           If <literal>jac</literal> is a list the same conventions as for
@@ -370,40 +298,31 @@ void fex(int *n,double *t,double *y,int *ml,int *mu,double *J,int *nrpd,)
         </para>
       </listitem>
     </itemizedlist>
-
     <para>
       Optional arguments <literal>w</literal> and
       <literal>iw</literal> are vectors for storing information returned by
-      the integration routine (see <link
-        linkend="ode_optional_output">ode_optional_output</link> for details).
+      the integration routine (see <link linkend="ode_optional_output">ode_optional_output</link> for details).
       When these vectors are provided in RHS of <literal>ode</literal> the
       integration re-starts with the same parameters as in its previous
       stop.
     </para>
-
     <para>
       More options can be given to ODEPACK solvers by using
-      <literal>%ODEOPTIONS</literal> variable. See <link
-        linkend="odeoptions">odeoptions</link>.
+      <literal>%ODEOPTIONS</literal> variable. See <link linkend="odeoptions">odeoptions</link>.
     </para>
   </refsection>
-
   <refsection>
     <title>The solvers</title>
-
     <para>
       The type of problem solved and
       the method used depend on the value of the first optional argument
       <literal>type</literal> which can be one of the following strings:
     </para>
-
     <variablelist>
       <varlistentry>
         <term>&lt;not given&gt;:</term>
-
         <listitem>
-          <para>
-            <literal>lsoda</literal> solver of package ODEPACK is called
+          <para><literal>lsoda</literal> solver of package ODEPACK is called
             by default. It automatically selects between nonstiff
             predictor-corrector Adams method and stiff Backward Differentiation
             Formula (BDF) method. It uses nonstiff method initially and
@@ -412,10 +331,8 @@ void fex(int *n,double *t,double *y,int *ml,int *mu,double *J,int *nrpd,)
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>"adams":</term>
-
         <listitem>
           <para>
             This is for nonstiff problems. <literal>lsode</literal> solver
@@ -423,10 +340,8 @@ void fex(int *n,double *t,double *y,int *ml,int *mu,double *J,int *nrpd,)
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>"stiff":</term>
-
         <listitem>
           <para>
             This is for stiff problems. <literal>lsode</literal> solver of
@@ -434,18 +349,14 @@ void fex(int *n,double *t,double *y,int *ml,int *mu,double *J,int *nrpd,)
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>"rk":</term>
-
         <listitem>
           <para>Adaptive Runge-Kutta of order 4 (RK4) method.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>"rkf":</term>
-
         <listitem>
           <para>
             The Shampine and Watts program based on Fehlberg's Runge-Kutta
@@ -456,10 +367,8 @@ void fex(int *n,double *t,double *y,int *ml,int *mu,double *J,int *nrpd,)
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>"fix":</term>
-
         <listitem>
           <para>
             Same solver as "rkf", but the user interface is very simple,
@@ -469,10 +378,8 @@ void fex(int *n,double *t,double *y,int *ml,int *mu,double *J,int *nrpd,)
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>"root":</term>
-
         <listitem>
           <para>
             ODE solver with rootfinding capabilities. The
@@ -483,10 +390,8 @@ void fex(int *n,double *t,double *y,int *ml,int *mu,double *J,int *nrpd,)
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>"discrete":</term>
-
         <listitem>
           <para>
             Discrete time simulation. See help on ode_discrete for more
@@ -496,20 +401,15 @@ void fex(int *n,double *t,double *y,int *ml,int *mu,double *J,int *nrpd,)
       </varlistentry>
     </variablelist>
   </refsection>
-
-
   <refsection>
     <title>Examples</title>
-
     <para>
       In the following example, we solve the Ordinary Differential Equation
       <literal>dy/dt=y^2-y sin(t)+cos(t)</literal> with the initial
       condition <literal>y(0)=0</literal>.
       We use the default solver.
     </para>
-
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function ydot=f(t,y)
        ydot=y^2-y*sin(t)+cos(t)
 endfunction
@@ -518,16 +418,14 @@ t0=0;
 t=0:0.1:%pi;
 y=ode(y0,t0,t,f);
 plot(t,y)
- ]]>
-    </programlisting>
+ ]]></programlisting>
     <para>
       In the following example, we solve the equation <literal>dy/dt=A*y</literal>.
       The exact solution is <literal>y(t)=expm(A*t)*y(0)</literal>, where 
       <literal>expm</literal> is the matrix exponential. 
       The unknown is the 2-by-1 matrix y(t).
     </para>
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function ydot=f(t,y)
     ydot=A*y
 endfunction 
@@ -541,8 +439,7 @@ t=1;
 ode("stiff",y0,t0,t,f,Jacobian)
 // Compare with exact solution:
 expm(A*t)*y0
- ]]>
-    </programlisting>
+ ]]></programlisting>
     <para>
       In the following example, we solve the ODE <literal>dx/dt = A x(t) + B u(t)</literal>
       with <literal>u(t)=sin(omega*t)</literal>.
@@ -550,8 +447,7 @@ expm(A*t)*y0
       <literal>A</literal>, <literal>u</literal>, <literal>B</literal>,
       <literal>omega</literal> are passed to function <literal>f</literal> in a list.
     </para>
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function xdot=linear(t,x,A,u,B,omega)
     xdot=A*x+B*u(t,omega)
 endfunction
@@ -565,15 +461,13 @@ y0=[1;0];
 t0=0;
 t=[0.1,0.2,0.5,1];
 ode(y0,t0,t,list(linear,A,u,B,omega))
- ]]>
-    </programlisting>
+ ]]></programlisting>
     <para>
       In the following example, we solve the Riccati differential equation 
       <literal>dX/dt=A'*X + X*A - X'*B*X + C</literal> where initial 
       condition <literal>X(0)</literal> is the 2-by-2 identity matrix.
     </para>
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function Xdot=ric(t,X,A,B,C)
     Xdot=A'*X+X*A-X'*B*X+C
 endfunction  
@@ -584,9 +478,7 @@ y0=eye(A);
 t0=0;
 t=0:0.1:%pi;
 X=ode(y0,t0,t,list(ric,A,B,C))
- ]]>
-    </programlisting>
-
+ ]]></programlisting>
     <para>
       In the following example, we solve the differential equation 
       <literal>dY/dt=A*Y</literal> where the unknown <literal>Y(t)</literal> 
@@ -594,8 +486,7 @@ X=ode(y0,t0,t,list(ric,A,B,C))
       The exact solution is <literal>Y(t)=expm(A*t)</literal>, where 
       <literal>expm</literal> is the matrix exponential.
     </para>
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function ydot=f(t,y,A)
     ydot=A*y;
 endfunction
@@ -607,18 +498,14 @@ ode(y0,t0,t,list(f,A))
 // Compare with the exact solution:
 expm(A*t)
 ode("adams",y0,t0,t,f)
- ]]>
-    </programlisting>
+ ]]></programlisting>
   </refsection>
-
   <refsection>
     <title>With a compiler</title>
-
     <para>
       The following example requires a C compiler.
     </para>
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 // ---------- Simple one dimension ODE (C coded external)
 ccode=['#include <math.h>'
        'void myode(int *n,double *t,double *y,double *ydot)'
@@ -634,55 +521,42 @@ t0=0;
 t=0:0.1:%pi;
 y=ode(y0,t0,t,'myode');
 
- ]]>
-    </programlisting>
+ ]]></programlisting>
   </refsection>
-
   <refsection role="see also">
     <title>See Also</title>
-
     <simplelist type="inline">
       <member>
         <link linkend="ode_discrete">ode_discrete</link>
       </member>
-
       <member>
         <link linkend="ode_root">ode_root</link>
       </member>
-
       <member>
         <link linkend="dassl">dassl</link>
       </member>
-
       <member>
         <link linkend="impl">impl</link>
       </member>
-
       <member>
         <link linkend="odedc">odedc</link>
       </member>
-
       <member>
         <link linkend="odeoptions">odeoptions</link>
       </member>
-
       <member>
         <link linkend="csim">csim</link>
       </member>
-
       <member>
         <link linkend="ltitr">ltitr</link>
       </member>
-
       <member>
         <link linkend="rtitr">rtitr</link>
       </member>
     </simplelist>
   </refsection>
-
   <refsection>
     <title>Authors</title>
-
     <itemizedlist>
       <listitem>
         <para>
@@ -691,20 +565,16 @@ y=ode(y0,t0,t,'myode');
       </listitem>
     </itemizedlist>
   </refsection>
-
   <refsection>
     <title>Bibliography</title>
-
     <para>
       Alan C. Hindmarsh, "lsode and lsodi, two new initial value ordinary
       differential equation solvers", ACM-Signum newsletter, vol. 15, no. 4
       (1980), pp. 10-11.
     </para>
   </refsection>
-
   <refsection>
     <title>Used Functions</title>
-
     <para>
       The associated routines can be found in SCI/modules/differential_equations/src/fortran directory:
       lsode.f lsoda.f lsodar.f
index 219e3f0..c2729af 100644 (file)
@@ -54,7 +54,7 @@
     Of course <literal>G_make</literal> will work if apropriate Makefiles are 
     provided in the current Scilab directory.
     </para>
-    <para><literal>G_make</literal> can be used to provide OS independant call to addinter.</para>
+    <para><literal>G_make</literal> can be used to provide OS independent call to addinter.</para>
   </refsection>
   <refsection>
     <title>Examples</title>
@@ -76,12 +76,14 @@ end
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="addinter">addinter</link>
       </member>
-      <member><link linkend="api_scilab">api_scilab</link></member>
+      <member>
+        <link linkend="api_scilab">api_scilab</link>
+      </member>
     </simplelist>
   </refsection>
 </refentry>
index 546e341..2390a8c 100644 (file)
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
  * 
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  * 
  -->
-
-<refentry 
-          version="5.0-subset Scilab" 
-          xml:id="bitcmp" 
-          xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns3="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
-
-
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="bitcmp" xml:lang="en">
   <refnamediv>
     <refname>bitcmp</refname>
     <refpurpose>bitwise complement</refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
     <synopsis>
       y = bitcmp(x,n)
     </synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Parameters</title>
     <variablelist>
@@ -76,7 +61,6 @@
       </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Description</title>
     <para>
       which is the integer corresponding to the complementary of the binary
       form of <literal>x</literal>.
     </para>
-
     <para>
       The integer <literal>n</literal> sets the maximum number of bits.
     </para>
-
     <para>
       If the bits number of the <literal>x</literal> binary representation is less than the
       bitmax number (8,16 or 32) then the bits '1' are added to the
       complementary.
     </para>
   </refsection>
-
   <refsection>
     <title>Examples</title>
-    <programlisting role="example">
-      <![CDATA[
+    <programlisting role="example"><![CDATA[
 // 13 is (1101)_2
-// We insert zeros in the begining to get a 8-bit number:
+// We insert zeros in the beginning to get a 8-bit number:
 // (00001101)_2
 // The 8-bits complement is then (11110010)_2
 // which is 242
@@ -112,10 +92,8 @@ expected = 242
 // The input argument can be an unsigned int
 bitcmp(uint8(99),8)
 expected = 156
-   ]]>
-    </programlisting>
+   ]]></programlisting>
   </refsection>
-
   <refsection>
     <title>Authors</title>
     <simplelist type="vert">
@@ -124,5 +102,4 @@ expected = 156
       <member>Copyright (C) 2008 - INRIA - Pierre MARECHAL</member>
     </simplelist>
   </refsection>
-
 </refentry>
index c6ba707..2c55358 100644 (file)
@@ -36,7 +36,7 @@ value=fileparts(fullpath,sel)</synopsis>
       <varlistentry>
         <term>sel</term>
         <listitem>
-          <para>a optional character string selector, with posible values:
+          <para>a optional character string selector, with possible values:
        'path' 'fname' or 'extension'</para>
         </listitem>
       </varlistentry>
@@ -81,7 +81,7 @@ fileparts('SCI/etc/scilab.start','extension')
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="pathconvert">pathconvert</link>
index 956aa14..90ab100 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry version="5.0-subset Scilab" xml:id="get_absolute_file_path"
-          xml:lang="en" xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns3="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="get_absolute_file_path" xml:lang="en">
   <info>
     <pubdate>$LastChangedDate: 2006-10-10 17:02:59 +0200 (mar., 10 oct.
     2006)$</pubdate>
   </info>
-
   <refnamediv>
     <refname>get_absolute_file_path</refname>
-
     <refpurpose>Given an absolute pathname of a file opened in
     scilab.</refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-
     <synopsis>pathname = get_absolute_file_path(filename)</synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Arguments</title>
-
     <variablelist>
       <varlistentry>
         <term>filename</term>
-
         <listitem>
           <para>A character string : filename</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>pathname</term>
-
         <listitem>
           <para>A character string : the absolute pathname</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Description</title>
-
     <para>Given the absolute pathname of a file already opened in
     scilab.</para>
-
-    <para>get_absolute_file_path searchs, in scilab's internal list of files
+    <para>get_absolute_file_path searches, in scilab's internal list of files
     currently opened, filename and returns its path.</para>
-
     <para>"get_absolute_file_path" seek, in the internal list of the files of
     scilab currently opened, " filename" and it gives his path.</para>
-
     <para>if file not opened , it will return a error.</para>
-
     <para>WARNING : in previous version (scilab 5.0.x) current directory was
     returned if file was not found.</para>
-
     <para>This function can be used to find from where (path) is executed a
     scilab script.</para>
   </refsection>
-
   <refsection>
     <title>Examples</title>
-
     <programlisting role="example"><![CDATA[ 
 // exec this script
 
@@ -89,23 +65,22 @@ disp(get_absolute_file_path('test.sce'));
 mclose(a);
  ]]></programlisting>
   </refsection>
-
   <refsection role="see also">
-<title>See Also</title>
-
+    <title>See Also</title>
     <simplelist type="inline">
-      <member><link
-      linkend="getshortpathname">getshortpathname</link></member>
-
-      <member><link linkend="getlongpathname">getlongpathname</link></member>
-
-      <member><link linkend="pwd">pwd</link></member>
+      <member>
+        <link linkend="getshortpathname">getshortpathname</link>
+      </member>
+      <member>
+        <link linkend="getlongpathname">getlongpathname</link>
+      </member>
+      <member>
+        <link linkend="pwd">pwd</link>
+      </member>
     </simplelist>
   </refsection>
-
   <refsection>
     <title>Authors</title>
-
     <para>Allan CORNET</para>
   </refsection>
 </refentry>
index 57f0698..288a9c9 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry version="5.0-subset Scilab" xml:id="percentio" xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns3="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="percentio" xml:lang="en">
   <info>
     <pubdate>$LastChangedDate$</pubdate>
   </info>
-
   <refnamediv>
     <refname>%io</refname>
-
     <refpurpose>variable returns standard input and standard output (file
     descriptor).</refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-
     <synopsis>%io(1)
 %io(2)</synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Description</title>
-
     <para>%io(1) returns standard input (file descriptor 5).</para>
-
-    <para>%io(2) returns standard ouput (file descriptor 6).</para>
-
+    <para>%io(2) returns standard output (file descriptor 6).</para>
     <para>file descriptor 0 is the standard error.</para>
   </refsection>
-
   <refsection>
     <title>Examples</title>
-
     <programlisting role="example"><![CDATA[ 
 mfprintf(%io(2),'Scilab stdout (C)');
 mfprintf(0,'Scilab stderr (C)');
@@ -56,14 +40,18 @@ write(0,'Scilab stderr (Fortran');
 [units,typ,names]=file()
  ]]></programlisting>
   </refsection>
-
   <refsection role="see also">
-<title>See Also</title>
-
+    <title>See Also</title>
     <simplelist type="inline">
-      <member><link linkend="write">write</link></member>
-      <member><link linkend="mfprintf">mfprintf</link></member>
-      <member><link linkend="file">file</link></member>
+      <member>
+        <link linkend="write">write</link>
+      </member>
+      <member>
+        <link linkend="mfprintf">mfprintf</link>
+      </member>
+      <member>
+        <link linkend="file">file</link>
+      </member>
     </simplelist>
   </refsection>
 </refentry>
index 03f466c..6e1350b 100644 (file)
@@ -10,7 +10,7 @@
   <refsynopsisdiv>
     <title>Calling Sequence</title>
     <synopsis>listvarinfile(filename)
-[nams,typs,dims,vols]=listvarinfile(filename)</synopsis>
+[names,typs,dims,vols]=listvarinfile(filename)</synopsis>
   </refsynopsisdiv>
   <refsection>
     <title>Arguments</title>
@@ -77,7 +77,7 @@ listvarinfile("vals.dat")
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="whos">whos</link>
index 4bb4b3f..27e66ca 100644 (file)
@@ -157,7 +157,7 @@ mclose(u);
 
 u=mopen(TMPDIR+'/foo','r'); // open the file for reading
 //read the file line by line
-[n,a,b]=mfscanf(u,'%e %e') //first line using mutiple LHS syntax
+[n,a,b]=mfscanf(u,'%e %e') //first line using multiple LHS syntax
 l=mfscanf(u,'%e %e')       //second one using single LHS syntax
 //use niter to read 5 more lines
 l=mfscanf(5,u,'%e %e')  
index a3a0579..fdc77a0 100644 (file)
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - Yann COLLETTE <yann.collette@renault.com>
@@ -11,7 +10,6 @@
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="selection_ga_elitist">
   <info>
     <pubdate>4-Feb-2008</pubdate>
       <varlistentry>
         <term>Indiv1</term>
         <listitem>
-          <para>a first set of childs generated via crossover + mutation.
+          <para>a first set of children generated via crossover + mutation.
        </para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>Indiv2</term>
         <listitem>
-          <para>a second set of childs generated via crossover + mutation.
+          <para>a second set of children generated via crossover + mutation.
        </para>
         </listitem>
       </varlistentry>
     <itemizedlist>
       <listitem>
         <para>
-      This function performs the elitist selection function. We select the best individuals in the set of parents and childs individuals.
+      This function performs the elitist selection function. We select the best individuals in the set of parents and children individuals.
      </para>
       </listitem>
     </itemizedlist>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="selection_ga_random"> selection_ga_random </link>
index 4444f52..6b1da47 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry version="5.0-subset Scilab" xml:id="selection_ga_random"
-          xml:lang="en" xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns3="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="selection_ga_random" xml:lang="en">
   <info>
     <pubdate>4-Feb-2008</pubdate>
   </info>
-
   <refnamediv>
     <refname>selection_ga_random</refname>
-
     <refpurpose>A function which performs a random selection of
     individuals</refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-
     <synopsis>[Pop_out,FObj_Pop_out,Efficiency,MO_Total_FObj_out] = selection_ga_random(Pop_in,Indiv1,Indiv2,FObj_Pop_in,FObj_Indiv1,FObj_Indiv2,MO_Total_FObj_in,MO_FObj_Indiv1,MO_FObj_Indiv2,param)</synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Arguments</title>
-
     <variablelist>
       <varlistentry>
         <term>Pop_in</term>
-
         <listitem>
           <para>The initial population of individuals.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>Indiv1</term>
-
         <listitem>
-          <para>a first set of childs generated via crossover +
+          <para>a first set of children generated via crossover +
           mutation.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>Indiv2</term>
-
         <listitem>
-          <para>a second set of childs generated via crossover +
+          <para>a second set of children generated via crossover +
           mutation.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>FObj_Pop_in</term>
-
         <listitem>
           <para>a vector of objective function values associated to each
           individuals of Pop_in.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>FObj_Indiv1</term>
-
         <listitem>
           <para>a vector of objective function values associated to each
           individuals of Indiv1.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>FObj_Indiv2</term>
-
         <listitem>
           <para>a vector of objective function values associated to each
           individuals of Indiv2.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>MO_Total_FObj_in</term>
-
         <listitem>
           <para>a matrix of multi-objective function values associated to each
           individuals of Pop_in.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>MO_FObj_Indiv1</term>
-
         <listitem>
           <para>a matrix of multi-objective function values associated to each
           individuals of Indiv1.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>MO_FObj_Indiv2</term>
-
         <listitem>
           <para>a matrix of multi-objective function values associated to each
           individuals of Indiv2.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>param</term>
-
         <listitem>
           <para>a list of parameters. </para>
-
           <itemizedlist>
             <listitem>
               <para> 'pressure': the selection pressure coefficient. Each
           </itemizedlist>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>Pop_out</term>
-
         <listitem>
           <para>all the selected individuals in a population of size
           pop_size.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>FObj_Pop_out</term>
-
         <listitem>
           <para>all the objective function values associated to each
           individuals of Pop_out.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>Efficiency</term>
-
         <listitem>
           <para>all the efficiency values associated to each individuals of
           Pop_out.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>MO_Total_FObj_out</term>
-
         <listitem>
           <para>all the multi-objective function values associated to each
           individuals of Pop_out.</para>
       </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Description</title>
-
     <itemizedlist>
       <listitem>
         <para>This function performs the random selection function. We select
-        pop_size individuals in the set of parents and childs individuals at
+        pop_size individuals in the set of parents and children individuals at
         random.</para>
       </listitem>
     </itemizedlist>
   </refsection>
-
   <refsection role="see also">
-<title>See Also</title>
-
+    <title>See Also</title>
     <simplelist type="inline">
-      <member><link linkend="selection_ga_elitist"> selection_ga_elitist
-      </link></member>
-
-      <member><link linkend="mutation_ga_default"> mutation_ga_default
-      </link></member>
-
-      <member><link linkend="crossover_ga_default"> crossover_ga_default
-      </link></member>
-
-      <member><link linkend="init_ga_default"> init_ga_default
-      </link></member>
-
-      <member><link linkend="optim_ga"> optim_ga </link></member>
+      <member>
+        <link linkend="selection_ga_elitist"> selection_ga_elitist
+      </link>
+      </member>
+      <member>
+        <link linkend="mutation_ga_default"> mutation_ga_default
+      </link>
+      </member>
+      <member>
+        <link linkend="crossover_ga_default"> crossover_ga_default
+      </link>
+      </member>
+      <member>
+        <link linkend="init_ga_default"> init_ga_default
+      </link>
+      </member>
+      <member>
+        <link linkend="optim_ga"> optim_ga </link>
+      </member>
     </simplelist>
   </refsection>
-
   <refsection>
     <title>Authors</title>
-
     <variablelist>
       <varlistentry>
         <term>Yann COLLETTE</term>
-
         <listitem>
           <para>ycollet@freesurf.fr</para>
         </listitem>
index 7a8bb7e..d478914 100644 (file)
@@ -21,7 +21,7 @@
   </refnamediv>
   <refsection>
     <title>Description</title>
-    <para>The LineSpec is an optional argument that can be used inside a plot command to customize each new line aspect. It has to be given as a concatenated string containing information about color, line style or markers. It is very usefull to quickly specify such basic line properties.</para>
+    <para>The LineSpec is an optional argument that can be used inside a plot command to customize each new line aspect. It has to be given as a concatenated string containing information about color, line style or markers. It is very useful to quickly specify such basic line properties.</para>
     <para>To specify a red longdash-dot with diamond marker, the string can be 'r-.diam'. As you can see, a full complete spelling of each property value is not required but the string, which is a concatenation (in any order) of these three types of properties , must remain unambiguous. Furthermore, the string specification is not case sensitive.</para>
     <para>Here is a complete list of the <literal>LineSpec</literal> types you can
     specify (using <link linkend="plot">plot</link>).</para>
@@ -320,7 +320,7 @@ plot(t,sin(t),'ro-.',t,cos(t),'cya+',t,abs(sin(t)),'--mo')
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="GlobalProperty">GlobalProperty</link>
index 96a8a09..3c47f7e 100644 (file)
@@ -133,7 +133,7 @@ h=a.children
 
 h.data_mapping="direct";
    
-// A 2D ploting of a matrix using colors 
+// A 2D plotting of a matrix using colors 
 clf()
 a=get("current_axes");
 a.data_bounds=  [0,0;4,4];
@@ -149,7 +149,7 @@ end
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="set">set</link>
index d217aa1..12aee38 100644 (file)
@@ -60,7 +60,7 @@ histplot(x, data, &lt;opt_args&gt;)</synopsis>
     <title>Description</title>
     <para> This function plot a histogram of the <literal>data</literal> vector using the
         classes <literal>x</literal>. When the number <literal>n</literal> of classes is provided
-        instead of <literal>x</literal>, the classes are choosen equally spaced and
+        instead of <literal>x</literal>, the classes are chosen equally spaced and
         <emphasis>x(1) = min(data) &lt;  x(2) = x(1) + dx  &lt;  ...  &lt; x(n+1) = max(data)</emphasis>
         with <emphasis>dx = (x(n+1)-x(1))/n</emphasis>.
     </para>
index ba34936..5d35049 100644 (file)
@@ -131,7 +131,7 @@ plot(&lt;axes_handle&gt;,...)</synopsis>
         totally complete <literal>'diamondred--'</literal> (see
         <link linkend="LineSpec">LineSpec</link>).</para>
           <para>Note that the line style and color, marks color (and sizes) can
-        also be (re-)set throught the polyline entity properties (see
+        also be (re-)set through the polyline entity properties (see
         <link linkend="polyline_properties">polyline_properties</link>).</para>
         </listitem>
       </varlistentry>
@@ -148,7 +148,7 @@ plot(&lt;axes_handle&gt;,...)</synopsis>
         properties available via LineSpec and more : the marker color
         (foreground and background), the visibility, clipping and thickness of
         the curves. (see <link linkend="GlobalProperty">GlobalProperty</link>)</para>
-          <para>Note that all these properties can be (re-)set throught the
+          <para>Note that all these properties can be (re-)set through the
         polyline entity properties (see <link linkend="polyline_properties">polyline_properties</link>).</para>
         </listitem>
       </varlistentry>
@@ -349,7 +349,7 @@ plot(1:10,toto)
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="plot2d">plot2d</link>
index 1cb4414..2089e6a 100644 (file)
@@ -105,7 +105,7 @@ surf(&lt;axes_handle&gt;,...)</synopsis>
     </itemizedlist>
     <para>Color entry specification :</para>
     <para>As stated before, the surface is created over a rectangular grid
-    support. Let consider two independant variables <literal>i</literal> and
+    support. Let consider two independent variables <literal>i</literal> and
     <literal>j</literal> such as :</para>
     <para>
       <inlinemediaobject>
@@ -163,7 +163,7 @@ surf(&lt;axes_handle&gt;,...)</synopsis>
         color data, color data mapping, marker color (foreground and
         background), the visibility, clipping and thickness of the edges of
         the surface... (see <link linkend="GlobalProperty">GlobalProperty</link> )</para>
-          <para>Note that all these properties can be (re-)set throught the surface
+          <para>Note that all these properties can be (re-)set through the surface
         entity properties (see <link linkend="surface_properties">surface_properties</link>).</para>
         </listitem>
       </varlistentry>
@@ -269,7 +269,7 @@ xdel(winsid())
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="plot2d">plot2d</link>
index ce9c98c..a4a4b26 100644 (file)
@@ -24,7 +24,7 @@
     <title>Description</title>
     <para>The Surface entity is a leaf of the graphics entities hierarchy. Two
     classes appears under this type of entity : <literal>Plot3d</literal> and
-    <literal>Fac3d</literal> according to the ploting function or the way data is
+    <literal>Fac3d</literal> according to the plotting function or the way data is
     entered. <literal>Fac3d</literal> and <literal>Plo3d</literal> entities are similar
     but <literal>Fac3d</literal> is more complete and accept more options than
     <literal>Plot3d</literal>. To always have <literal>Fac3d</literal> entities, simply
           depending on the <literal>mark_style</literal> and the
           <literal>mark_foreground</literal> and
           <literal>mark_background</literal> properties.</para>
-       <para>
-         <inlinemediaobject>
-           <imageobject>
-             <imagedata fileref="../../images/marks.svg"/>
-           </imageobject>
-         </inlinemediaobject>
-       </para>
+          <para>
+            <inlinemediaobject>
+              <imageobject>
+                <imagedata fileref="../../images/marks.svg"/>
+              </imageobject>
+            </inlinemediaobject>
+          </para>
         </listitem>
       </varlistentry>
       <varlistentry>
         single value for each vertex. <literal>cdata_mapping</literal> determines
         wether those indices are scaled to map linearly into the current
         colormap (<literal>'scaled'</literal> mode) or point directly into this
-        colormap (<literal>'direct</literal>' mode). This property is usefull when
+        colormap (<literal>'direct</literal>' mode). This property is useful when
         <literal>color_flag</literal> equals <literal>2</literal>,<literal>3</literal> or
         <literal>4</literal>.</para>
         </listitem>
@@ -418,7 +418,7 @@ e.color_flag= 3; // interpolated shading mode (based on blue default color becau
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="set">set</link>
index dfa1426..6c28326 100644 (file)
     <para>The GlobalProperty is an optional argument that can be used inside a <link linkend="plot">plot</link> or <link linkend="surf">surf</link> command. It allows a global customization of all the new plotted lines (respectivly surfaces). It has to be given as a couple {PropertyName, PropertyValue}. Several couples can be set at the same time in a plot or surf call.</para>
     <para>PropertyName must be a string defining the property to set.The PropertyValue can be a real, integer or string (scalar or matrix) depending on the type of property used. For example, to specify a red (color) longdash-dot (line style) with diamond marker (marker), the sequence should be : 'Colo','red','LineSt','-.','Marker','diam'.</para>
     <para>As you can see, a full complete spelling of each property name and value is not required but those arguments, specified in any order, must remain unambiguous. Furthermore, the string specification is not case sensitive. GlobalProperty is predominant on all LineSpec previously stated.</para>
-
     <para>Here is a complete list of the <literal>PropertyName</literal> you can
     specify (using <link linkend="plot">plot</link> or <link linkend="surf">surf</link>) and their available
     associated <literal>PropertyValue</literal>. If not specified, those properties
     are available for both <literal>Polyline</literal> and <literal>Fac3d</literal>
     objects (created respectivly by plot or surf) and, as previously said,
     they are applied to the new created objects (lines or surfaces).</para>
-    <para>Sometimes, you may have two PropertyName correponding to one property :
+    <para>Sometimes, you may have two PropertyName corresponding to one property :
     the first one is the equivalent default Matlab name, the second is the
     default name used by Scilab (i.e.:<literal> Color or Foreground</literal> for a
     line, see below).</para>
@@ -55,7 +54,7 @@
         <literal>cdata_mapping</literal> determines wether those indices are scaled
         to map linearly into the current colormap (<literal>'scaled'</literal> mode)
         or point directly into this colormap (<literal>'direct</literal>' mode).
-        This property is usefull when <literal>color_flag</literal> equals
+        This property is useful when <literal>color_flag</literal> equals
         <literal>2</literal>,<literal>3</literal> or <literal>4</literal>. Note that this
         property exists only with <literal>Fac3d</literal> entities. Note also that
         <literal>plot3d</literal> has <literal>'direct'</literal> mode by default and
@@ -439,7 +438,7 @@ surf(Z,'edgeco','b','marker','d','markersiz',9,'markerfac','k','xdata',-50:-41)
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="LineSpec">LineSpec</link>
index 83c8294..f41bdd2 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry version="5.0-subset Scilab" xml:id="plotframe" xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns5="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="plotframe" xml:lang="en">
   <info>
     <pubdate>$LastChangedDate: 2008-03-26 09:50:39 +0100 (Wed, 26 Mar 2008)
     $</pubdate>
   </info>
-
   <refnamediv>
     <refname>plotframe</refname>
-
-    <refpurpose>plot a frame with scaling and grids. <emphasis
-    role="bold">This function is obsolete.</emphasis></refpurpose>
+    <refpurpose>plot a frame with scaling and grids. <emphasis role="bold">This function is obsolete.</emphasis></refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-
     <synopsis>plotframe(rect,tics,[arg_opt1,arg_opt2,arg_opt3])
 plotframe(rect,&lt;opts_args&gt;)</synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Arguments</title>
-
     <variablelist>
       <varlistentry>
         <term>rect</term>
-
         <listitem>
           <para>vector <literal>[xmin,ymin,xmax,ymax]</literal>.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>tics</term>
-
         <listitem>
           <para>vector <literal>[nx,mx,ny,my]</literal> where <literal>mx,
           nx</literal> (resp. <literal>my, ny</literal>) are the number of
           x-axis (resp. y-axis) intervals and subintervals.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>arg_optX</term>
-
         <listitem>
-          <para>optional arguments up to three and choosen among.</para>
-
+          <para>optional arguments up to three and chosen among.</para>
           <variablelist>
             <varlistentry>
               <term>flags</term>
-
               <listitem>
                 <para>vector <literal>[wantgrids,findbounds]</literal> where
                 <literal>wantgrids</literal> is a boolean variable
@@ -81,10 +61,8 @@ plotframe(rect,&lt;opts_args&gt;)</synopsis>
                 <literal>tics(4)</literal> are ignored.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>Captions</term>
-
               <listitem>
                 <para>vector of 3 strings
                 <literal>[title,x-leg,y-leg]</literal> corresponding
@@ -92,10 +70,8 @@ plotframe(rect,&lt;opts_args&gt;)</synopsis>
                 x-axis and the y-axis. Warning: the upper-case "C" is important.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>subwin</term>
-
               <listitem>
                 <para>a vector of size 4 defining the sub window. The sub
                 window is specified with the parameter
@@ -108,41 +84,29 @@ plotframe(rect,&lt;opts_args&gt;)</synopsis>
           </variablelist>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>&lt;opts_args&gt;</term>
-
         <listitem>
-          <para>This represents a sequence of statements <emphasis
-          role="bold">key1=value1</emphasis>,<emphasis role="bold">
-          key2=value2</emphasis>,... where <emphasis
-          role="bold">key1</emphasis>, <emphasis
-          role="bold">key2</emphasis>,... can be one of the following:
-          <emphasis role="bold">tics</emphasis>, <emphasis
-          role="bold">flags</emphasis>, <emphasis
-          role="bold">captions</emphasis> ou <emphasis
-          role="bold">subwin</emphasis>. These arguments have the same meaning
+          <para>This represents a sequence of statements <emphasis role="bold">key1=value1</emphasis>,<emphasis role="bold">
+          key2=value2</emphasis>,... where <emphasis role="bold">key1</emphasis>, <emphasis role="bold">key2</emphasis>,... can be one of the following:
+          <emphasis role="bold">tics</emphasis>, <emphasis role="bold">flags</emphasis>, <emphasis role="bold">captions</emphasis> ou <emphasis role="bold">subwin</emphasis>. These arguments have the same meaning
           as the ones used in the first form of the routine.</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Description</title>
-
     <para><literal>plotframe</literal> is used with 2D plotting functions
-    <link linkend="plot2d">plot2d</link>, <link
-    linkend="plot2d1">plot2d1</link>,... to set a graphics frame. It must be
+    <link linkend="plot2d">plot2d</link>, <link linkend="plot2d1">plot2d1</link>,... to set a graphics frame. It must be
     used before <literal>plot2d</literal> which should be invoked with the
     "000" superposition mode.</para>
-
-    <para><emphasis role="bold">This function is obsolete.</emphasis></para>
+    <para>
+      <emphasis role="bold">This function is obsolete.</emphasis>
+    </para>
   </refsection>
-
   <refsection>
     <title>Examples</title>
-
     <programlisting role="example"><![CDATA[ 
 x=[-0.3:0.8:27.3]';
 y=rand(x);
@@ -161,16 +125,18 @@ plotframe(rect,flags=[%f,%t],tics=tics,..
 plot2d(x,y,5,"000")
  ]]></programlisting>
   </refsection>
-
   <refsection role="see also">
-<title>See Also</title>
-
+    <title>See Also</title>
     <simplelist type="inline">
-      <member><link linkend="plot2d">plot2d</link></member>
-
-      <member><link linkend="graduate">graduate</link></member>
-
-      <member><link linkend="xsetech">xsetech</link></member>
+      <member>
+        <link linkend="plot2d">plot2d</link>
+      </member>
+      <member>
+        <link linkend="graduate">graduate</link>
+      </member>
+      <member>
+        <link linkend="xsetech">xsetech</link>
+      </member>
     </simplelist>
   </refsection>
 </refentry>
index 8b8b058..33f8860 100644 (file)
@@ -58,7 +58,7 @@ bar([h],x,y [,width [,color [,style]]])</synopsis>
       <varlistentry>
         <term>color</term>
         <listitem>
-          <para>(optional), a string (default: 'blue'), specifing the inside
+          <para>(optional), a string (default: 'blue'), specifying the inside
                                        color bar.</para>
         </listitem>
       </varlistentry>
@@ -123,7 +123,7 @@ bar(x,y,0.2,'green');
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="barh">barh</link>
index 18b369c..52edd3b 100644 (file)
@@ -58,7 +58,7 @@ barh([h],x,y [,width [,color [,style]]])</synopsis>
       <varlistentry>
         <term>color</term>
         <listitem>
-          <para>(optional), a string (default: 'blue'), specifing the inside
+          <para>(optional), a string (default: 'blue'), specifying the inside
                                        color bar.</para>
         </listitem>
       </varlistentry>
@@ -122,7 +122,7 @@ barh(x,y,0.2,'green');
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="bar">bar</link>
index b05a49f..1c83194 100644 (file)
     </variablelist>
     <para>
       Others fields can be added by the programmer to the datatips
-      data structure throught the <literal>datatipInitStruct</literal>
+      data structure through the <literal>datatipInitStruct</literal>
       <literal>varargin</literal> optional arguments.
     </para>
   </refsection>
index 1555d23..dbc97d3 100644 (file)
@@ -8,7 +8,7 @@
  * are also available at    
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 -->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg"  xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en_US" xml:id="datatips">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en_US" xml:id="datatips">
   <info>
     <pubdate>$LastChangedDate: 19-02-2010 $</pubdate>
   </info>
     <refname>datatips</refname>
     <refpurpose>Tool for placing and editing tips along the plotted curves.</refpurpose>
   </refnamediv>
   <refsection>
-  <title>Description</title>
+    <title>Description</title>
     <para>
       With this tool, it is possible to place, move and modify tips on
       the curves (polylines). This can be done by program or interactively. The
       commonly used mode is the interactive one:
     </para>
     <para>
-     The datatips mode can be enabled by <link linkend="datatipToggle"
-     >datatipToggle()</link> or using the
+     The datatips mode can be enabled by <link linkend="datatipToggle">datatipToggle()</link> or using the
      <literal>Edit/Start datatip manager</literal> or clicking on the
-     toolbar icon <inlinemediaobject>
-       <imageobject>
-         <imagedata fileref="../../../../gui/images/icons/datatips.png"/>
-       </imageobject>
-      </inlinemediaobject> of the desired graphic window.
+     toolbar icon <inlinemediaobject><imageobject><imagedata fileref="../../../../gui/images/icons/datatips.png"/></imageobject></inlinemediaobject> of the desired graphic window.
     </para>
-     <para>Once enabled, a simple left click on a curve will add a tip
-     ( a small box with informations on the current point) at the
+    <para>Once enabled, a simple left click on a curve will add a tip
+     ( a small box with information on the current point) at the
      nearest datapoint of the curve. By default each curve can have a
      single tip but it is possible to allow multiple datatips using
      the right click contextual menu.
       To move a tip, press left button on the small square mark on
       the curve, wait a little and drag it to the desired location.
     </para>
-  
     <para>
       Right click on the tip mark opens a contextual dialog. This
       dialog allows in particular to customize the information
       displayed in all the datatips of the associated curve.
     </para>
-
-   <para>
+    <para>
       Middle click on the tip mark opens a contextual dialog that
       allows to manage the orientation of the selected tip.
     </para>
-
-
   </refsection>
   <refsection>
     <title>Examples</title>
@@ -84,9 +74,9 @@
      ]]></programlisting>
     <para>
       <inlinemediaobject>
-       <imageobject>
-         <imagedata fileref="../../images/datatips.svg"/>
-       </imageobject>
+        <imageobject>
+          <imagedata fileref="../../images/datatips.svg"/>
+        </imageobject>
       </inlinemediaobject>
     </para>
     <programlisting role="example"><![CDATA[
      ]]></programlisting>
     <para>
       <inlinemediaobject>
-       <imageobject>
-         <imagedata fileref="../../images/datatips4.svg"/>
-       </imageobject>
+        <imageobject>
+          <imagedata fileref="../../images/datatips4.svg"/>
+        </imageobject>
       </inlinemediaobject>
     </para>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
-        <link linkend="datatipToggle" >datatipToggle</link>
+        <link linkend="datatipToggle">datatipToggle</link>
       </member>
       <member>
         <link linkend="datatipInitStruct">datatipInitStruct</link>
       <member>
         <link linkend="datatipCreate">datatipCreate</link>
       </member>
-     <member>
+      <member>
         <link linkend="datatipMove">datatipMove</link>
       </member>
       <member>
       <member>Serge Steer, INRIA</member>
     </simplelist>
   </refsection>
 </refentry>
index fe3eabc..969e5c1 100644 (file)
@@ -23,7 +23,7 @@
     <title>Description</title>
     <para> In Scilab,
     graphics window and the drawing it contains are represented by hierchical
-    entities. The hierachy top level is the Figure. Each Figure defines at
+    entities. The hierarchy top level is the Figure. Each Figure defines at
     least one child of type Axes. Each Axes entity contains a set of leaf
     entities which are the basic graphics objects like Polylines, Rectangles,
     Arcs, Segs,... It can also contain an Compound type which are recursive
@@ -227,7 +227,7 @@ plot2d(x,x^3)  //the drawing are sent to the initial figure
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="set">set</link>
index fcaeaf2..6dcea1b 100644 (file)
@@ -38,7 +38,7 @@ unsetmenu(gwin,button,[nsub])</synopsis>
   <refsection>
     <title>Description</title>
     <para>
-    The function allows the user to desactivate  buttons or menus created by
+    The function allows the user to deactivate  buttons or menus created by
     <literal>addmenu</literal> in the main or graphics windows command panels.</para>
   </refsection>
   <refsection>
@@ -50,7 +50,7 @@ unsetmenu('File',2)
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="delmenu">delmenu</link>
index 71971b9..0592277 100644 (file)
@@ -35,7 +35,7 @@
       <varlistentry>
         <term>num</term>
         <listitem>
-          <para>integer, choosen item number or 0 if dialog resumed with "Cancel" button</para>
+          <para>integer, chosen item number or 0 if dialog resumed with "Cancel" button</para>
         </listitem>
       </varlistentry>
     </variablelist>
@@ -56,7 +56,7 @@ n = x_choose(['item1';'item2';'item3'],['that is a comment'],'Return')
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="x_choose_modeless">x_choose_modeless</link>
index 0a1fb85..c3bede5 100644 (file)
@@ -32,7 +32,7 @@
       <varlistentry>
         <term>num</term>
         <listitem>
-          <para>integer, choosen item number or 0 if dialog resumed with "Cancel" button</para>
+          <para>integer, chosen item number or 0 if dialog resumed with "Cancel" button</para>
         </listitem>
       </varlistentry>
     </variablelist>
@@ -50,7 +50,7 @@ n = x_choose_modeless(['item1';'item2';'item3'],['that is a comment'],'Return')
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="x_choose">x_choose</link>
index 9e11c9a..67fd47f 100644 (file)
@@ -1,55 +1,38 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<refentry version="5.0-subset Scilab" xml:id="cshep2d" xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns5="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="cshep2d" xml:lang="en">
   <info>
     <pubdate>$LastChangedDate$</pubdate>
   </info>
-
   <refnamediv>
     <refname>cshep2d</refname>
-
     <refpurpose>bidimensional cubic shepard (scattered)
     interpolation</refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-
     <synopsis>tl_coef = cshep2d(xyz)</synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Arguments</title>
-
     <variablelist>
       <varlistentry>
         <term>xyz</term>
-
         <listitem>
           <para>a n x 3 matrix of the (no gridded) interpolation points (the i
           th row given the (x,y) coordinates then the altitude z of the i th
           interpolation point)</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>tl_coef</term>
-
         <listitem>
           <para>a tlist scilab structure (of type cshep2d)</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Description</title>
-
     <para>This function is useful to define a 2d interpolation function when
     the interpolation points are not on a grid (you may use it in this case
     but <link linkend="splin2d">splin2d</link> is better for that purpose).
     <emphasis>s(xi,yi)=zi</emphasis> for all <emphasis>i=1,..,n</emphasis>
     (<emphasis>(xi,yi,zi)</emphasis> being the i th row of
     <literal>xyz</literal>).</para>
-
     <para>The evaluation of <emphasis>s</emphasis> at some points must be done
     by the <link linkend="eval_cshep2d">eval_cshep2d</link> function.</para>
   </refsection>
-
   <refsection>
     <title>Remark</title>
-
     <para>The function works if <emphasis role="bold">n &gt;= 10</emphasis>,
     if the nodes are not all colinears (i.e. the <emphasis>(x,y)</emphasis>
     coordinates of the interpolation points are not on the same straight
     points with the same <emphasis>(x,y)</emphasis> coordinates). An error is
     issued if these conditions are not respected.</para>
   </refsection>
-
   <refsection>
     <title>Examples</title>
-
     <programlisting role="example"><![CDATA[ 
-// interpolation of cos(x)cos(y) with randomly choosen interpolation points
+// interpolation of cos(x)cos(y) with randomly chosen interpolation points
 n = 150; // nb of interpolation points
 xy = grand(n,2,"unf",0,2*%pi);
 z = cos(xy(:,1)).*cos(xy(:,2));
@@ -93,28 +71,26 @@ Z = eval_cshep2d(X,Y, tl_coef);
 clf()
 plot3d(xx,xx,Z,flag=[2 6 4])
 param3d1(xy(:,1),xy(:,2),list(z,-9), flag=[0 0])
-xtitle("Cubic Shepard Interpolation of cos(x)cos(y) with randomly choosen interpolation points")
+xtitle("Cubic Shepard Interpolation of cos(x)cos(y) with randomly chosen interpolation points")
 legends("interpolation points",-9,1)
 show_window()
  ]]></programlisting>
   </refsection>
-
   <refsection role="see also">
-<title>See Also</title>
-
+    <title>See Also</title>
     <simplelist type="inline">
-      <member><link linkend="splin2d">splin2d</link></member>
-
-      <member><link linkend="eval_cshep2d">eval_cshep2d</link></member>
+      <member>
+        <link linkend="splin2d">splin2d</link>
+      </member>
+      <member>
+        <link linkend="eval_cshep2d">eval_cshep2d</link>
+      </member>
     </simplelist>
   </refsection>
-
   <refsection>
     <title>Authors</title>
-
     <simplelist type="vert">
       <member>Robert J. Renka</member>
-
       <member>B. Pincon (scilab interface)</member>
     </simplelist>
   </refsection>
index ba4d79d..08b0888 100644 (file)
@@ -50,7 +50,7 @@
     <emphasis>s</emphasis> for the data <literal>xd, yd, wd</literal> (in the
     following <emphasis>m</emphasis> is supposed to be the length of these
     vectors) and from a choice of the spline breakpoints <literal>x</literal>
-    (for instance if you want n breakpoints uniformly choosen you may use
+    (for instance if you want n breakpoints uniformly chosen you may use
     <literal>x=linspace(min(xd),max(xd),n))</literal>). If
     <emphasis>S</emphasis> is the space of all cubic splines functions with
     breakpoints <emphasis>x1 &lt; x2 &lt; ... &lt; xn</emphasis> then the
@@ -65,7 +65,7 @@
     <para>for all <emphasis>f in S</emphasis>, i.e. realizes the minimum of
     the sum of the squared errors over all functions of
     <emphasis>S</emphasis>.</para>
-    <para>The spline <emphasis>s</emphasis> is completly defined by the
+    <para>The spline <emphasis>s</emphasis> is completely defined by the
     triplet <literal>(x,y,d)</literal> (<literal>y</literal> and
     <literal>d</literal> are the vectors of the spline ordinates and first
     derivatives at the xi 's : <emphasis>yi=s(xi)</emphasis> and
@@ -95,7 +95,7 @@
   <refsection>
     <title>Examples</title>
     <programlisting role="example"><![CDATA[ 
-// this is an artifical example where the data xd and yd
+// this is an artificial example where the data xd and yd
 // are build from a perturbed sin function
 a = 0; b = 2*%pi;
 sigma = 0.1;  // standard deviation of the gaussian noise
index c8c159a..6b1def0 100644 (file)
@@ -57,7 +57,7 @@
     <emphasis>s</emphasis> which interpolates the <emphasis>(xi,yi)</emphasis>
     points, ie, we have <emphasis>s(xi)=yi</emphasis> for all
     <emphasis>i=1,..,n</emphasis>. The resulting spline <emphasis>s</emphasis>
-    is completly defined by the triplet <literal>(x,y,d)</literal> where
+    is completely defined by the triplet <literal>(x,y,d)</literal> where
     <literal>d</literal> is the vector with the derivatives at the
     <literal>xi</literal>: <emphasis>s'(xi)=di</emphasis> (this is called the
     <emphasis>Hermite</emphasis> form). The evaluation of the spline at some
index f3d81f2..6c77662 100644 (file)
     function is periodic.</para>
     <para>The <emphasis role="bold">natural</emphasis>, <emphasis role="bold">monotone</emphasis>, <emphasis role="bold">fast</emphasis> (or
     <emphasis role="bold">fast_periodic</emphasis>) type may be useful in some
-    cases, for instance to limit oscillations (<emphasis role="bold">monotone</emphasis> being the most powerfull for that).</para>
+    cases, for instance to limit oscillations (<emphasis role="bold">monotone</emphasis> being the most powerful for that).</para>
     <para>To get the coefficients of the bi-cubic patches in a more friendly
     way you can use <literal>c = hypermat([4,4,nx-1,ny-1],C)</literal> then
     the coefficient <emphasis>(k,l)</emphasis> of the patch
index ae5018f..fb5d391 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry version="5.0-subset Scilab" xml:id="unix_g" xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns4="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="unix_g" xml:lang="en">
   <info>
     <pubdate>$LastChangedDate: 2008-03-26 09:50:39 +0100 (mer., 26 mars 2008)
     $</pubdate>
   </info>
-
   <refnamediv>
     <refname>unix_g</refname>
-
     <refpurpose>shell (sh) command execution, output redirected to a
     variable</refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-
     <synopsis>rep=unix_g(cmd)
 [rep,stat]=unix_g(cmd)
 [rep,stat,stderr]=unix_g(cmd)</synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Arguments</title>
-
     <variablelist>
       <varlistentry>
         <term>cmd</term>
-
         <listitem>
           <para>a character string</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>rep</term>
-
         <listitem>
           <para>a column vector of character strings (standard output)</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>stat</term>
-
         <listitem>
           <para>a integer, the error status. stat=0 if no error occured</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>err</term>
-
         <listitem>
           <para>a column vector of character strings (standard error)</para>
         </listitem>
-      </varlistentry>      
-      
+      </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Description</title>
-
     <para>Sends a string <literal>cmd</literal> to Unix for execution by the
     sh shell. The standard output is redirected to scilab variable
     <literal>rep</literal>. The standard error is redirected to scilab
-    variable err or displays if you had only 2 ouput arguments. Unix execution
+    variable err or displays if you had only 2 output arguments. Unix execution
     errors are trapped; *NOTE* that only the last shell command error is
     reported when a list of command separated by ";" is sent: this is not
     recommended.</para>
   </refsection>
-
   <refsection>
     <title>Examples</title>
-
     <programlisting role="example"><![CDATA[ 
 function d=DIR(path)
   path=pathconvert(path,%t,%t)
@@ -104,18 +80,21 @@ endfunction
 DIR('SCI/etc')
  ]]></programlisting>
   </refsection>
-
   <refsection role="see also">
-<title>See Also</title>
-
+    <title>See Also</title>
     <simplelist type="inline">
-      <member><link linkend="unix_s">unix_s</link></member>
-
-      <member><link linkend="unix_w">unix_w</link></member>
-
-      <member><link linkend="unix_x">unix_x</link></member>
-
-      <member><link linkend="unix">unix</link></member>
+      <member>
+        <link linkend="unix_s">unix_s</link>
+      </member>
+      <member>
+        <link linkend="unix_w">unix_w</link>
+      </member>
+      <member>
+        <link linkend="unix_x">unix_x</link>
+      </member>
+      <member>
+        <link linkend="unix">unix</link>
+      </member>
     </simplelist>
   </refsection>
 </refentry>
index c2f6296..2e2e67f 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry version="5.0-subset Scilab" xml:id="javasci.Scilab" xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns5="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="javasci.Scilab" xml:lang="en">
   <info>
     <pubdate>$LastChangedDate$</pubdate>
   </info>
-
   <refnamediv>
     <refname>javasci.Scilab (deprecated)</refname>
-
     <refpurpose>This class provides the basic methods to execute Scilab code
     and scripts. Deprecated: Please use <link linkend="javasci">Javasci v2</link></refpurpose>
   </refnamediv>
-
   <refsection>
     <title>Description</title>
-
-    <para>This class is static. Since the Scilab environnement is persistant,
+    <para>This class is static. Since the Scilab environnement is persistent,
     all variables will remain accessible with the Java application.</para>
-
-    <para><emphasis role="bold">Method Summary :</emphasis></para>
-
+    <para>
+      <emphasis role="bold">Method Summary :</emphasis>
+    </para>
     <itemizedlist>
       <listitem>
         <para><emphasis><literal>public static void
         Events()</literal></emphasis> - Execute a Scilab event</para>
       </listitem>
-
       <listitem>
         <para><emphasis><literal>public static boolean
         HaveAGraph()</literal></emphasis> -Check if there is any scilab
         graphic window open (return True if it is the case).</para>
       </listitem>
-
       <listitem>
         <para><emphasis><literal>public static boolean Exec(String
         job)</literal></emphasis> - Execute a job in scilab. return true if
         there is no error.</para>
-               <para>Note that the given expression must be consistent by itself. Then, a serie of <literal>Exec</literal> defining a function will not work. Please consider calling it with a single string instruction or using a temporary file with the method <literal>ExecuteScilabScript</literal>.</para>
-               <para>For example: <literal>Scilab.Exec("function foo(); disp('bar'); endfunction");</literal> will work when <literal>Scilab.Exec("function foo();"); Scilab.Exec("disp('bar');"); Scilab.Exec("endfunction;");</literal> will not work since each statement being processed independently</para>
+        <para>Note that the given expression must be consistent by itself. Then, a serie of <literal>Exec</literal> defining a function will not work. Please consider calling it with a single string instruction or using a temporary file with the method <literal>ExecuteScilabScript</literal>.</para>
+        <para>For example: <literal>Scilab.Exec("function foo(); disp('bar'); endfunction");</literal> will work when <literal>Scilab.Exec("function foo();"); Scilab.Exec("disp('bar');"); Scilab.Exec("endfunction;");</literal> will not work since each statement being processed independently</para>
       </listitem>
-
       <listitem>
         <para><emphasis><literal>public static native boolean ExistVar(String
         VarName) </literal></emphasis>- Detect if VarName exists in Scilab.
         return true if Varname exist.</para>
       </listitem>
-
       <listitem>
         <para><emphasis><literal>public static native int TypeVar(String
         VarName)</literal></emphasis> - Return Scilab type of VarName. See
         <link linkend="type">type</link></para>
       </listitem>
-
       <listitem>
         <para><emphasis><literal>public static native int
         GetLastErrorCode()</literal></emphasis> - Return last Error code. See
         <link linkend="lasterror">lasterror</link></para>
       </listitem>
-
       <listitem>
         <para><emphasis><literal>public static boolean
         ExecuteScilabScript(String scilabscriptfilename)
         </literal></emphasis>- Execute a scilab script (.sce) return true if
         there is no error.</para>
       </listitem>
-
       <listitem>
         <para><emphasis><literal>public static native boolean
         Finish()</literal></emphasis> - Terminate scilab (call scilab.quit ,
       </listitem>
     </itemizedlist>
   </refsection>
-
   <refsection>
     <title>Examples</title>
-
     <programlisting role="java"><![CDATA[ 
 // A Scilab / Java example 
 // Filename: ScilabExample.java
@@ -113,33 +94,37 @@ public class ScilabExample {
 }
  ]]></programlisting>
   </refsection>
-
   <refsection role="see also">
-<title>See Also</title>
-
+    <title>See Also</title>
     <simplelist type="inline">
-    <member>
+      <member>
         Browse <link type="remote" linkend="javasci/javadoc/index.html">the documentation of Javasci v2.</link>
        </member>
-      <member><link linkend="compile_and_run_javasci_v1">Compile and run with Javasci v1</link></member>
-
-      <member><link linkend="SciDouble">SciDouble</link></member>
-
-      <member><link linkend="SciDoubleArray">SciDoubleArray</link></member>
-
-      <member><link linkend="SciString">SciString</link></member>
-
-      <member><link linkend="SciStringArray">SciStringArray</link></member>
-
-      <member><link linkend="type">type</link></member>
-
-      <member><link linkend="lasterror">lasterror</link></member>
+      <member>
+        <link linkend="compile_and_run_javasci_v1">Compile and run with Javasci v1</link>
+      </member>
+      <member>
+        <link linkend="SciDouble">SciDouble</link>
+      </member>
+      <member>
+        <link linkend="SciDoubleArray">SciDoubleArray</link>
+      </member>
+      <member>
+        <link linkend="SciString">SciString</link>
+      </member>
+      <member>
+        <link linkend="SciStringArray">SciStringArray</link>
+      </member>
+      <member>
+        <link linkend="type">type</link>
+      </member>
+      <member>
+        <link linkend="lasterror">lasterror</link>
+      </member>
     </simplelist>
   </refsection>
-
   <refsection>
     <title>Authors</title>
-
     <para>A.C</para>
   </refsection>
 </refentry>
index 11187c2..e8689cc 100644 (file)
   <refsection>
     <title>Description</title>
     <para>
-    This functions searches for inference informations of a given
+    This functions searches for inference information of a given
     index in the contents of a Cell or a Struct taken in account the
     <literal>*</literal>. If no information has been found, returned values
     are infer=infer() and pos=0.
     </para>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="Infer">Infer</link>
index 90c4169..9bfcf14 100644 (file)
@@ -55,7 +55,7 @@ Matlab offers two permissions options not supported by Scilab: <emphasis role="b
         <term>Input values:</term>
         <listitem>
           <para>
-In Matlab, <emphasis role="bold">fopen('all')</emphasis> lists all opened files, in Scilab, this type of call for <emphasis role="bold">fopen</emphasis> does not exist. You can also use <emphasis role="bold">fopen</emphasis> in Matlab to get informations on a file identifier (<emphasis role="bold">fopen(fid)</emphasis>), this case is not implemented in Scilab.
+In Matlab, <emphasis role="bold">fopen('all')</emphasis> lists all opened files, in Scilab, this type of call for <emphasis role="bold">fopen</emphasis> does not exist. You can also use <emphasis role="bold">fopen</emphasis> in Matlab to get information on a file identifier (<emphasis role="bold">fopen(fid)</emphasis>), this case is not implemented in Scilab.
 </para>
         </listitem>
       </varlistentry>
index 7a1baaa..e18610d 100644 (file)
@@ -55,7 +55,7 @@ There is not equivalent function for <emphasis role="bold">pow2</emphasis> in Sc
         <term>X=pow2(F,E)</term>
         <listitem>
           <para>
-In this case, Matlab <emphasis role="bold">pow2()</emphasis> ignores imaginary part of input arguments. An equivalent expression for this use of <emphasis role="bold">pow2</emphasis> is: <emphasis role="bold">F.* 2 .^ E </emphasis>(Note that 2 must be preceeded and followed by a white space).
+In this case, Matlab <emphasis role="bold">pow2()</emphasis> ignores imaginary part of input arguments. An equivalent expression for this use of <emphasis role="bold">pow2</emphasis> is: <emphasis role="bold">F.* 2 .^ E </emphasis>(Note that 2 must be preceded and followed by a white space).
 </para>
         </listitem>
       </varlistentry>
index 6091a1a..1eb8322 100644 (file)
@@ -48,7 +48,7 @@
     converted into the Scilab equivalents.</para>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="loadmatfile">loadmatfile</link>
@@ -67,7 +67,7 @@
   </refsection>
   <refsection>
     <title>Bibliography</title>
-    <para>This function has been developped according to the document  "MAT-File Format":
-><ulink url="http://www.mathworks.com/access/helpdesk/help/pdf_doc/matlab/matfile_format.pdf">Mat-File Format</ulink></para>
+    <para>This function has been developed according to the document  "MAT-File Format":
+&gt;<ulink url="http://www.mathworks.com/access/helpdesk/help/pdf_doc/matlab/matfile_format.pdf">Mat-File Format</ulink></para>
   </refsection>
 </refentry>
index 864eed3..a3a56b6 100644 (file)
@@ -81,7 +81,7 @@ disp(B)
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="load">load</link>
@@ -109,7 +109,7 @@ disp(B)
   </refsection>
   <refsection>
     <title>Bibliography</title>
-    <para>This function has been developped following the "MAT-File Format"
+    <para>This function has been developed following the "MAT-File Format"
   description: 
 <literal><ulink url="http://www.mathworks.com/access/helpdesk/help/pdf_doc/matlab/matfile_format.pdf">Mat-File Format</ulink></literal></para>
   </refsection>
index f19253e..b6df744 100644 (file)
@@ -143,7 +143,7 @@ disp(B)
  ]]></programlisting>
   </refsection>
   <refsection role="see also">
-<title>See Also</title>
+    <title>See Also</title>
     <simplelist type="inline">
       <member>
         <link linkend="load">load</link>
@@ -168,7 +168,7 @@ disp(B)
   </refsection>
   <refsection>
     <title>Bibliography</title>
-    <para>This function has been developped following the "MAT-File Format"
+    <para>This function has been developed following the "MAT-File Format"
   description: 
 <literal><ulink url="http://www.mathworks.com/access/helpdesk/help/pdf_doc/matlab/matfile_format.pdf">Mat-File Format</ulink></literal></para>
   </refsection>
index bd0aa00..80670c1 100644 (file)
@@ -446,7 +446,7 @@ xsup = [%inf, %inf];
     <para>
                Now we want to define fun and dfun in Fortran, then in C. 
           Note that the "compile and link to scilab" method used here
-          is believed to be OS independant (but there are some requirements, 
+          is believed to be OS independent (but there are some requirements, 
           in particular you need a C and a fortran compiler, and they must 
           be compatible with the ones used to build your scilab binary).
            </para>
index 845e9ba..63c6fa4 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry version="5.0-subset Scilab" xml:id="lsqrsolve" xml:lang="en"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns4="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="lsqrsolve" xml:lang="en">
   <info>
     <pubdate>$LastChangedDate: 2008-04-15 18:15:23 +0200 (Tue, 15 Apr 2008)
     $</pubdate>
   </info>
-
   <refnamediv>
     <refname>lsqrsolve</refname>
-
     <refpurpose>minimize the sum of the squares of nonlinear functions,
     levenberg-marquardt algorithm</refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-
     <synopsis>[x [,v [,info]]]=lsqrsolve(x0,fct,m [,stop [,diag]])
 [x [,v [,info]]]=lsqrsolve(x0,fct,m ,fjac [,stop [,diag]])</synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Arguments</title>
-
     <variablelist>
       <varlistentry>
         <term>x0</term>
-
         <listitem>
           <para>real vector of size <literal>n </literal>(initial estimate of
           the solution vector).</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>fct</term>
-
         <listitem>
           <para>external (i.e function or list or string).</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>m</term>
-
         <listitem>
           <para>integer, the number of functions. <literal>m</literal> must be
           greater than or equal to <literal>n</literal>.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>fjac</term>
-
         <listitem>
           <para>external (i.e function or list or string).</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>stop</term>
-
         <listitem>
           <para>optional vector
           <literal>[ftol,xtol,gtol,maxfev,epsfcn,factor]</literal> the default
           value is <literal>[1.d-8,1.d-8,1.d-5,1000,0,100]</literal></para>
-
           <variablelist>
             <varlistentry>
               <term>ftol</term>
-
               <listitem>
                 <para>A positive real number,termination occurs when both the
                 actual and predicted relative reductions in the sum of squares
                 the sum of squares.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>xtol</term>
-
               <listitem>
                 <para>A positive real number, termination occurs when the
                 relative error between two consecutive iterates is at most
                 solution.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>gtol</term>
-
               <listitem>
                 <para>A nonnegative input variable. termination occurs when
                 the cosine of the angle between <literal>fct</literal>(x) and
                 columns of the jacobian.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>maxfev</term>
-
               <listitem>
                 <para>A positive integer, termination occurs when the number
                 of calls to <literal>fct</literal> is at least maxfev by the
                 end of an iteration.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>epsfcn</term>
-
               <listitem>
                 <para>A positive real number, used in determining a suitable
                 step length for the forward-difference approximation. this
                 the order of the machine precision.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>factor</term>
-
               <listitem>
                 <para>A positive real number, used in determining the initial
                 step bound. this bound is set to the product of factor and the
           </variablelist>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>diag</term>
-
         <listitem>
           <para>is an array of length <literal>n</literal>.
           <literal>diag</literal> must contain positive entries that serve as
           multiplicative scale factors for the variables.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>x :</term>
-
         <listitem>
           <para>real vector (final estimate of the solution vector).</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>v :</term>
-
         <listitem>
           <para>real vector (value of <literal>fct(x)</literal>).</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>info</term>
-
         <listitem>
           <para>termination indicator</para>
-
           <variablelist>
             <varlistentry>
               <term>0</term>
-
               <listitem>
                 <para>improper input parameters.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>1</term>
-
               <listitem>
                 <para>algorithm estimates that the relative error between
                 <literal>x</literal> and the solution is at most
                 <literal>tol</literal>.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>2</term>
-
               <listitem>
                 <para>number of calls to <literal>fcn</literal> reached</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>3</term>
-
               <listitem>
                 <para><literal>tol</literal> is too small. No further
                 improvement in the approximate solution <literal>x</literal>
                 is possible.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>4</term>
-
               <listitem>
                 <para>iteration is not making good progress.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>5</term>
-
               <listitem>
                 <para>number of calls to <literal>fcn</literal> has reached or
                 exceeded <literal>maxfev</literal></para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>6</term>
-
               <listitem>
                 <para><literal>ftol</literal> is too small. no further
                 reduction in the sum of squares is possible.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>7</term>
-
               <listitem>
                 <para><literal>xtol</literal> is too small. no further
                 improvement in the approximate solution<literal>x</literal> is
                 possible.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>8</term>
-
               <listitem>
                 <para><literal>gtol</literal> is too small.
                 <literal>fvec</literal> is orthogonal to the columns of the
       </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Description</title>
-
     <para>minimize the sum of the squares of m nonlinear functions in n
     variables by a modification of the levenberg-marquardt algorithm. the user
     must provide a subroutine which calculates the functions. the jacobian is
     then calculated by a forward-difference approximation.</para>
-
     <para>minimize <literal>sum(fct(x,m).^2)</literal> where
     <literal>fct</literal> is function from <literal>R^n</literal> to
     <literal>R^m</literal></para>
-
     <para><literal>fct</literal> should be :</para>
-
     <itemizedlist>
       <listitem>
         <para>a Scilab function whose calling sequence is
         <literal>v=fct(x,m)</literal> given <literal>x</literal> and
         <literal>m</literal>.</para>
       </listitem>
-
       <listitem>
         <para>a character string which refers to a C or Fortran routine which
         must be linked to Scilab.</para>
-
         <para>Fortran calling sequence should be
         <literal>fct(m,n,x,v,iflag)</literal> where <literal>m</literal>,
         <literal>n</literal>, <literal>iflag</literal> are integers,
         <literal>x</literal> a double precision vector of size
         <literal>n</literal> and <literal>v</literal> a double precision
         vector of size <literal>m</literal>.</para>
-
         <para>C calling sequence should be <literal>fct(int *m, int *n, double
         x[],double v[],int *iflag)</literal></para>
       </listitem>
     </itemizedlist>
-
     <para><literal>fjac</literal> is an external which returns
     <literal>v=d(fct)/dx (x)</literal>. it should be :</para>
-
     <variablelist>
       <varlistentry>
         <term>a Scilab function</term>
-
         <listitem>
           <para>whose calling sequence is <literal>J=fjac(x,m)</literal> given
           <literal>x</literal> and <literal>m</literal>.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>a character string</term>
-
         <listitem>
           <para>it refers to a C or Fortran routine which must be linked to
           Scilab.</para>
-
           <para>Fortran calling sequence should be
           <literal>fjac(m,n,x,jac,iflag)</literal> where <literal>m</literal>,
           <literal>n</literal>, <literal>iflag</literal> are integers,
           <literal>x</literal> a double precision vector of size
           <literal>n</literal> and <literal>jac</literal> a double precision
           vector of size <literal>m*n</literal>.</para>
-
           <para>C calling sequence should be <literal>fjac(int *m, int *n,
           double x[],double v[],int *iflag)</literal></para>
         </listitem>
       </varlistentry>
     </variablelist>
-
-    <para>return -1 in iflag to stop the algoritm if the function or jacobian
+    <para>return -1 in iflag to stop the algorithm if the function or jacobian
     could not be evaluated.</para>
   </refsection>
-
   <refsection>
     <title>Examples</title>
-
     <programlisting role="example"><![CDATA[ 
 // A simple example with lsqrsolve 
 a=[1,7;
@@ -405,24 +328,25 @@ abc
 norm(v)
  ]]></programlisting>
   </refsection>
-
   <refsection role="see also">
-<title>See Also</title>
-
+    <title>See Also</title>
     <simplelist type="inline">
-      <member><link linkend="external">external</link></member>
-
-      <member><link linkend="qpsolve">qpsolve</link></member>
-
-      <member><link linkend="optim">optim</link></member>
-
-      <member><link linkend="fsolve">fsolve</link></member>
+      <member>
+        <link linkend="external">external</link>
+      </member>
+      <member>
+        <link linkend="qpsolve">qpsolve</link>
+      </member>
+      <member>
+        <link linkend="optim">optim</link>
+      </member>
+      <member>
+        <link linkend="fsolve">fsolve</link>
+      </member>
     </simplelist>
   </refsection>
-
   <refsection>
     <title>Used Functions</title>
-
     <para>lmdif, lmder from minpack, Argonne National Laboratory.</para>
   </refsection>
 </refentry>
index aa2b694..d33612c 100644 (file)
@@ -3,29 +3,16 @@
  * Copyright (C) 2008-2009 - INRIA - Michael Baudin
  * Copyright (C) 2009-2011 - DIGITEO - Michael Baudin
 -->
-<refentry
-          version="5.0-subset Scilab"
-          xml:id="fminsearch"
-          xml:lang="fr"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns4="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
-
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="fminsearch" xml:lang="fr">
   <refnamediv>
     <refname>fminsearch</refname>
-
     <refpurpose>
       Computes the unconstrained minimimum of given function with
       the Nelder-Mead algorithm.
     </refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>SYNOPSIS</title>
-
     <synopsis>
       x = fminsearch ( costf , x0 )
       x = fminsearch ( costf , x0 , options )
       [x,fval,exitflag,output] = fminsearch ( costf , x0 , options )
     </synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Description</title>
-
     <para>
       This function searches for the unconstrained minimum of a given cost
       function.
     </para>
-
     <para>
       The provided algorithm is a direct search algorithm, i.e. an
       algorithm which does not use the derivative of the cost function. It is
       where each vertex is associated with one point and one function value.
       This algorithm is the Nelder-Mead algorithm.
     </para>
-
     <para>
       See the demonstrations, in the Optimization section, for an overview
       of this component.
     </para>
-
     <para>
       See the "Nelder-Mead User's Manual" on Scilab's wiki and on the
       Scilab forge for further informations.
     </para>
   </refsection>
-
   <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
       function.
     </para>
   </refsection>
-
   <refsection>
     <title>Arguments</title>
-
     <variablelist>
       <varlistentry>
         <term>costf</term>
-
         <listitem>
           <para>
             a function or a list, the objective function.
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>x0</term>
-
         <listitem>
           <para>a matrix of doubles, the initial guess.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>options</term>
-
         <listitem>
           <para>
             A struct which contains configurable options of the algorithm
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>x</term>
-
         <listitem>
           <para>The minimum.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>fval</term>
-
         <listitem>
           <para>The minimum function value.</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>exitflag</term>
-
         <listitem>
           <para>The flag associated with exist status of the algorithm.</para>
-
           <para>The following values are available.</para>
-
           <variablelist>
             <varlistentry>
               <term>-1</term>
-
               <listitem>
                 <para>
                   The maximum number of iterations has been
                 </para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>0</term>
-
               <listitem>
                 <para>
                   The maximum number of function evaluations has been
                 </para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>1</term>
-
               <listitem>
                 <para>
                   The tolerance on the simplex size and function value
           </variablelist>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>output</term>
-
         <listitem>
           <para>
             A struct which stores detailed information about the exit of
             the algorithm. This struct contains the following fields.
           </para>
-
           <variablelist>
             <varlistentry>
               <term>output.algorithm</term>
-
               <listitem>
                 <para>
                   A string containing the definition of the algorithm
                 </para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>output.funcCount</term>
-
               <listitem>
                 <para>The number of function evaluations.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>output.iterations</term>
-
               <listitem>
                 <para>The number of iterations.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>output.message</term>
-
               <listitem>
                 <para>A string containing a termination message.</para>
               </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
-
   <refsection>
     <title>The cost function</title>
-
     <para>
       The <literal>costf</literal> argument to configure the cost function. The cost
       function is used to compute the objective function value <literal>f</literal>.
       The cost function must have the following header :
     </para>
-
     <screen>
       f = costf ( x )
     </screen>
-
     <para>where</para>
-
     <variablelist>
       <varlistentry>
         <term>x</term>
-
         <listitem>
           <para>the current point</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>f</term>
-
         <listitem>
           <para>the value of the cost function</para>
         </listitem>
       </varlistentry>
-
     </variablelist>
-
     <para>
       It might happen that the function requires additionnal arguments to be evaluated.
       In this case, we can use the following feature.
       where the input arguments <literal>a1, a2, ...</literal>
       are automatically appended at the end of the calling sequence.
     </para>
-
   </refsection>
-
   <refsection>
     <title>Options</title>
-
     <para>
       In this section, we describe the options input argument which have
       an effect on the algorithm used by fminsearch.
     </para>
-
     <para>
       The options input argument is a data structure which drives the
       behaviour of fminsearch. It allows to handle several options in a
       consistent and simple interface, without the problem of managing many
       input arguments.
     </para>
-
     <para>
       These options must be set with the <link linkend="optimset">optimset</link> function.
       See the <link linkend="optimset">optimset</link> help for details
       of the options managed by this function.
     </para>
-
     <para>
       The fminsearch function is sensitive to the following
       options.
     </para>
-
     <variablelist>
       <varlistentry>
         <term>options.MaxIter</term>
-
         <listitem>
           <para>
             The maximum number of iterations. The default is 200 * n,
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>options.MaxFunEvals</term>
-
         <listitem>
           <para>
             The maximum number of evaluations of the cost function. The
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>options.TolFun</term>
-
         <listitem>
           <para>
             The absolute tolerance on function value. The default value is
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>options.TolX</term>
-
         <listitem>
           <para>
             The absolute tolerance on simplex size. The default value is
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>options.Display</term>
-
         <listitem>
           <para>
             The verbose level.
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>options.OutputFcn</term>
-
         <listitem>
           <para>
             The output function, or a list of output functions. The default
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>options.PlotFcns</term>
-
         <listitem>
           <para>
             The plot function, or a list of plotput functions. The default
           </para>
         </listitem>
       </varlistentry>
-
     </variablelist>
   </refsection>
-
   <refsection>
     <title>Termination criteria</title>
-
     <para>
       In this section, we describe the termination criteria used by
       fminsearch.
     </para>
-
     <para>The criteria is based on the following variables:</para>
-
     <variablelist>
       <varlistentry>
         <term>ssize</term>
-
         <listitem>
           <para>the current simplex size,</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>shiftfv</term>
-
         <listitem>
           <para>
             the absolute value of the difference of function value between
         </listitem>
       </varlistentry>
     </variablelist>
-
     <para>If both the following conditions</para>
-
     <programlisting role="example">
       ssize &lt; options.TolX
     </programlisting>
-
     <para>and</para>
-
     <programlisting role="example">
       shiftfv &lt; options.TolFun
     </programlisting>
-
     <para>are true, then the iterations stop.</para>
-
     <para>
       The size of the simplex is computed using the "sigmaplus" method of
       the optimsimplex component. The "sigmamplus" size is the maximum length of
       the vertices of the simplex.
     </para>
   </refsection>
-
   <refsection>
     <title>The initial simplex</title>
-
     <para>
       The fminsearch algorithm uses a special initial simplex, which is an
       heuristic depending on the initial guess. The strategy chosen by
       details.
     </para>
   </refsection>
-
   <refsection>
     <title>The number of iterations</title>
-
     <para>
       In this section, we present the default values for the number of
       iterations in fminsearch.
     </para>
-
     <para>
-      The <emphasis>options</emphasis> input argument is an optionnal data
+      The <emphasis>options</emphasis> input argument is an optional 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
       evaluations in this experiment is also roughly 100n.
     </para>
   </refsection>
-
   <refsection>
     <title>Output and plot functions</title>
-
     <para>
       The <link linkend="optimset">optimset</link> function can be used to
       configure one or more output and plot functions.
     <para>
       The output function is expected to have the following header:
     </para>
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 stop = myoutputfun ( x , optimValues , state )
- ]]>
-    </programlisting>
+ ]]></programlisting>
     <para>
       The input arguments <literal>x</literal>, <literal>optimValues</literal>
       and <literal>state</literal> are described in detail in the <link linkend="optimset">optimset</link>
@@ -508,53 +404,39 @@ stop = myoutputfun ( x , optimValues , state )
       used during the current iteration and can be equal to one
       of the following strings
     </para>
-
     <itemizedlist>
-
       <listitem>
         <para>"" (the empty string),</para>
       </listitem>
-
       <listitem>
         <para>"initial simplex",</para>
       </listitem>
-
       <listitem>
         <para>"expand",</para>
       </listitem>
-
       <listitem>
         <para>"reflect",</para>
       </listitem>
-
       <listitem>
         <para>"contract inside",</para>
       </listitem>
-
       <listitem>
         <para>"contract outside".</para>
       </listitem>
-
     </itemizedlist>
-
     <para>
       The plot function is expected to have the following header:
     </para>
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 myplotfun ( x , optimValues , state )
- ]]>
-    </programlisting>
+ ]]></programlisting>
     <para>
       where the input arguments <literal>x</literal>, <literal>optimValues</literal>
       and <literal>state</literal> have the same definition as for the output function.
     </para>
-
   </refsection>
-
   <refsection>
     <title>Example</title>
-
     <para>
       In the following example, we use the fminsearch function to compute
       the minimum of the Rosenbrock function. We first define the function
@@ -563,20 +445,15 @@ myplotfun ( x , optimValues , state )
       In this particular case, 85 iterations are performed and 159 function
       evaluations are
     </para>
-
-    <programlisting role="example">
-      <![CDATA[ 
+    <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>
+ ]]></programlisting>
   </refsection>
-
   <refsection>
     <title>Example with customized options</title>
-
     <para>
       In the following example, we configure the absolute tolerance
       on the size of the simplex to a larger value, so that the algorithm
@@ -590,21 +467,16 @@ endfunction
       In this particular case, the number of iterations is 70
       with 130 function evaluations.
     </para>
-
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function y = banana (x)
   y = 100*(x(2)-x(1)^2)^2 + (1-x(1))^2;
 endfunction
 opt = optimset ( "TolX" , 1.e-2 );
 [x , fval , exitflag , output] = fminsearch ( banana , [-1.2 1] , opt )
- ]]>
-    </programlisting>
+ ]]></programlisting>
   </refsection>
-
   <refsection>
     <title>Example with a pre-defined plot function</title>
-
     <para>
       In the following example, we want to produce a graphic of the
       progression of the algorithm, so that we can include that graphic
@@ -630,40 +502,30 @@ opt = optimset ( "TolX" , 1.e-2 );
       in order to create one graphic, representing the function value depending on
       the number of iterations.
     </para>
-
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function y = banana (x)
   y = 100*(x(2)-x(1)^2)^2 + (1-x(1))^2;
 endfunction
 opt = optimset ( "PlotFcns" , optimplotfval );
 [x fval] = fminsearch ( banana , [-1.2 1] , opt );
- ]]>
-    </programlisting>
-
+ ]]></programlisting>
     <para>
       In the previous example, we could replace the "optimplotfval"
       function with "optimplotx" or "optimplotfunccount" and obtain different
       results. In fact, we can get all the figures at the same time, by
       setting the  "PlotFcns" to a list of functions, as in the following example.
     </para>
-
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function y = banana (x)
   y = 100*(x(2)-x(1)^2)^2 + (1-x(1))^2;
 endfunction
 myfunctions = list ( optimplotfval , optimplotx , optimplotfunccount );
 opt = optimset ( "PlotFcns" , myfunctions );
 [x fval] = fminsearch ( banana , [-1.2 1] , opt );
- ]]>
-    </programlisting>
-
+ ]]></programlisting>
   </refsection>
-
   <refsection>
     <title>Example with a customized output function</title>
-
     <para>
       In the following example, we want to produce intermediate
       outputs of the algorithm. We define the <literal>outfun</literal>
@@ -681,9 +543,7 @@ opt = optimset ( "PlotFcns" , myfunctions );
       and the plot function (associated with the "PlotFcns" option).
       See the <link linkend="optimset">optimset</link> for more details on this feature.
     </para>
-
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function y = banana (x)
   y = 100*(x(2)-x(1)^2)^2 + (1-x(1))^2;
 endfunction
@@ -693,19 +553,14 @@ function stop = outfun ( x , optimValues , state )
 endfunction
 opt = optimset ( "OutputFcn" , outfun);
 [x fval] = fminsearch ( banana , [-1.2 1] , opt );
- ]]>
-    </programlisting>
-
+ ]]></programlisting>
   </refsection>
-
   <refsection>
     <title>Example with customized "Display"</title>
-
     <para>
       The "Display" option allows to get some input about the intermediate
       steps of the algorithm as well as to be warned in case of a convergence problem.
     </para>
-
     <para>
       In the following example, we present what happens in case of a convergence problem.
       We set the number of iterations to 10, instead of the
@@ -713,56 +568,44 @@ opt = optimset ( "OutputFcn" , outfun);
       criteria.
       Therefore, the convergence criteria is not met and the maximum number of iterations is reached.
     </para>
-
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function y = banana (x)
   y = 100*(x(2)-x(1)^2)^2 + (1-x(1))^2;
 endfunction
 opt = optimset ( "MaxIter" , 10 );
 [x fval] = fminsearch ( banana , [-1.2 1] , opt );
- ]]>
-    </programlisting>
-
+ ]]></programlisting>
     <para>
       Since the default value of the "Display" option is "notify", a message is generated,
       which warns the user about a possible convergence problem.
       The previous script produces the following output.
     </para>
-
     <programlisting role="example">
       Exiting: Maximum number of iterations has been exceeded
       - increase MaxIter option.
       Current function value: 4.1355598
     </programlisting>
-
     <para>
       Notice that if the "Display" option is now set to "off", no message is displayed at all.
       Therefore, the user should be warned that turning the Display "off" should be used
       at your own risk...
     </para>
-
     <para>
       In the following example, we present how to display intermediate steps
       used by the algorithm. We simply set the "Display" option to the "iter" value.
     </para>
-
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function y = banana (x)
   y = 100*(x(2)-x(1)^2)^2 + (1-x(1))^2;
 endfunction
 opt = optimset ( "Display" , "iter" );
 [x fval] = fminsearch ( banana , [-1.2 1] , opt );
- ]]>
-    </programlisting>
-
+ ]]></programlisting>
     <para>
       The previous script produces the following output. It allows to see the number of function
       evaluations, the minimum function value and which type of simplex step is used
       for the iteration.
     </para>
-
     <programlisting role="example">
       Iteration   Func-count     min f(x)         Procedure
       0            3             24.2
@@ -773,19 +616,14 @@ opt = optimset ( "Display" , "iter" );
       5           11        4.3813601         contract inside
       etc...
     </programlisting>
-
   </refsection>
-
   <refsection>
     <title>Example with customized output</title>
-
     <para>
       In this section, we present an example where all the fields from the <literal>optimValues</literal>
       data structure are used to print a message at each iteration.
     </para>
-
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function stop = outfun ( x , optimValues , state )
   fc = optimValues.funccount;
   fv = optimValues.fval;
@@ -796,13 +634,10 @@ function stop = outfun ( x , optimValues , state )
 endfunction
 opt = optimset ( "OutputFcn" , outfun );
 [x fval] = fminsearch ( banana , [-1.2 1] , opt );
- ]]>
-    </programlisting>
-
+ ]]></programlisting>
     <para>
       The previous script produces the following output.
     </para>
-
     <programlisting role="example">
       3 2.420000e+001 0 --
       3 2.005000e+001 1 -initial simplex-
@@ -816,12 +651,9 @@ opt = optimset ( "OutputFcn" , outfun );
       159 8.177661e-010 85 -contract inside-
       159 8.177661e-010 85 --
     </programlisting>
-
   </refsection>
-
   <refsection>
     <title>Passing extra parameters</title>
-
     <para>
       In the following example, we solve a modified Rosenbrock test case.
       Notice that the objective function has two extra parameters
@@ -830,9 +662,7 @@ opt = optimset ( "OutputFcn" , outfun );
       where the first element is the function and the
       remaining elements are the extra parameters.
     </para>
-
-    <programlisting role="example">
-      <![CDATA[ 
+    <programlisting role="example"><![CDATA[ 
 function y = bananaext (x,a,b)
   y = a*(x(2)-x(1)^2)^2 + (b-x(1))^2;
 endfunction
@@ -841,13 +671,10 @@ b = 12;
 xopt = [12  144]
 fopt = 0
 [x fval] = fminsearch ( list(bananaext,a,b) , [10 100] )
- ]]>
-    </programlisting>
+ ]]></programlisting>
   </refsection>
-
   <refsection>
     <title>Some advices</title>
-
     <para>
       In this section, we present some practical advices with respect
       to the Nelder-Mead method. A deeper analysis is provided
@@ -857,7 +684,6 @@ fopt = 0
       that may happen with this algorithm.
     </para>
     <itemizedlist>
-
       <listitem>
         <para>
           We should consider the <link linkend="optim">optim</link> function before
@@ -878,7 +704,6 @@ fopt = 0
           well.
         </para>
       </listitem>
-
       <listitem>
         <para>
           We should not expected a fast convergence with
@@ -887,7 +712,6 @@ fopt = 0
           parameters increases.
         </para>
       </listitem>
-
       <listitem>
         <para>
           The default tolerances are set to pretty loose values.
@@ -899,7 +723,6 @@ fopt = 0
           of the cost function with this algorithm.
         </para>
       </listitem>
-
       <listitem>
         <para>
           Although the algorithm practically converges in many situations,
@@ -913,7 +736,6 @@ fopt = 0
           chance that this point is a "good" solution.
         </para>
       </listitem>
-
       <listitem>
         <para>
           Taking into account for bounds constraints or non-linear inequality
@@ -926,61 +748,48 @@ fopt = 0
           also fail and a more powerful solver is necessary.
         </para>
       </listitem>
-
     </itemizedlist>
   </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>
       "Nelder Mead's User Manual", Consortium Scilab - Digiteo, Michael
       Baudin, 2010
     </para>
   </refsection>
-
   <refsection>
     <title>TODO</title>
-
     <itemizedlist>
       <listitem>
         <para>
@@ -988,30 +797,22 @@ fopt = 0
           plot during the optimization.
         </para>
       </listitem>
-
     </itemizedlist>
   </refsection>
-
   <refsection>
     <title>Authors</title>
-
     <para>Michael Baudin - INRIA - 2008-2009</para>
-
     <para>Michael Baudin - DIGITEO - 2009-2011</para>
   </refsection>
-
   <refsection>
     <title>Acknowledgements</title>
-
     <para>
       Michael Baudin would like to thank Lixing Han, who kindly sent his
       PhD thesis.
     </para>
   </refsection>
-
   <refsection role="see also">
     <title>See Also</title>
-
     <simplelist type="inline">
       <member>
         <link linkend="optim">optim</link>
index c647fa8..6eb6fd3 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<refentry
-          version="5.0-subset Scilab"
-          xml:id="neldermead"
-          xml:lang="fr"
-          xmlns="http://docbook.org/ns/docbook"
-          xmlns:xlink="http://www.w3.org/1999/xlink"
-          xmlns:svg="http://www.w3.org/2000/svg"
-          xmlns:ns4="http://www.w3.org/1999/xhtml"
-          xmlns:mml="http://www.w3.org/1998/Math/MathML"
-          xmlns:db="http://docbook.org/ns/docbook">
-
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="neldermead" xml:lang="fr">
   <refnamediv>
     <refname>neldermead</refname>
-
     <refpurpose>
       Provides direct search optimization algorithms.
     </refpurpose>
   </refnamediv>
-
   <refsynopsisdiv>
     <title>SYNOPSIS</title>
-
     <synopsis>
       newobj = neldermead_new ()
       this = neldermead_destroy (this)
       stop = neldermead_defaultoutput(state, data)
     </synopsis>
   </refsynopsisdiv>
-
   <refsection>
     <title>Description</title>
-
     <para>
       This class provides several direct search optimization algorithms
       based on the simplex method.
     </para>
-
     <para>
       The optimization problem to solve is the minimization of a cost
       function, with bounds and nonlinear constraints
     </para>
-
     <screen>
       min f(x)
       l_i &lt;= x_i &lt;= h_i, i = 1,n
       g_i(x) &gt;= 0, i = 1,nbineq
     </screen>
-
     <para>where</para>
-
     <variablelist>
       <varlistentry>
         <term>n</term>
-
         <listitem>
           <para>number of variables</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>nbineq</term>
-
         <listitem>
           <para>number of inequality constraints</para>
         </listitem>
       </varlistentry>
     </variablelist>
-
     <para>
       The provided algorithms are direct search algorithms, i.e.
       algorithms which do not use the derivative of the cost function. They are
       where each vertex is associated with one point and one function
       value.
     </para>
-
     <para>The following algorithms are available :</para>
-
     <variablelist>
       <varlistentry>
         <term>Spendley, Hext and Himsworth fixed shape simplex method</term>
-
         <listitem>
           <para>
             This algorithm solves an unconstrained optimization problem
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>Nelder and Mead variable shape simplex method</term>
-
         <listitem>
           <para>
             This algorithm solves an unconstrained optimization problem
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>Box complex method</term>
-
         <listitem>
           <para>
             This algorithm solves an constrained optimization problem with
         </listitem>
       </varlistentry>
     </variablelist>
-
     <para>
       See the demonstrations, in the Optimization section, for an overview
       of this component.
     </para>
-
     <para>
       See the "Nelder-Mead User's Manual" on Scilab's wiki and on the
       Scilab forge for further informations.
     </para>
   </refsection>
-
   <refsection>
     <title>Design</title>
-
     <para>
-      The neldermead component is built on top of the <link
-    linkend="optimbase">optimbase</link> and <link
-    linkend="optimsimplex">optimsimplex</link> components.
+      The neldermead component is built on top of the <link linkend="optimbase">optimbase</link> and <link linkend="optimsimplex">optimsimplex</link> components.
     </para>
   </refsection>
-
   <refsection>
     <title>Functions</title>
-
     <para>The following functions are available.</para>
-
     <variablelist>
       <varlistentry>
         <term xml:id="neldermead_new">newobj = neldermead_new ()</term>
-
         <listitem>
           <para>Creates a new neldermead object.</para>
-
           <variablelist>
             <varlistentry>
               <term>newobj</term>
-
               <listitem>
                 <para>The new object.</para>
               </listitem>
           </variablelist>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term xml:id="neldermead_destroy">this = neldermead_destroy (this)</term>
-
         <listitem>
           <para>Destroy the given object.</para>
-
           <variablelist>
             <varlistentry>
               <term>this</term>
-
               <listitem>
                 <para>The current object.</para>
               </listitem>
           </variablelist>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term xml:id="neldermead_configure">this = neldermead_configure (this,key,value)</term>
-
         <listitem>
           <para>
             Configure the current object with the given value for the
             given key.
           </para>
-
           <variablelist>
             <varlistentry>
               <term>this</term>
-
               <listitem>
                 <para>The current object.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>key</term>
-
               <listitem>
                 <para>
                   the key to configure. The following keys are
                   available.
                 </para>
-
                 <para>
                   <emphasis>Basic.</emphasis>
                 </para>
-
                 <variablelist>
-
                   <varlistentry>
                     <term>-numberofvariables</term>
                     <listitem>
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-function</term>
                     <listitem>
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-x0</term>
                     <listitem>
                       </para>
                     </listitem>
                   </varlistentry>
-
                 </variablelist>
-
                 <para>
                   <emphasis>Output.</emphasis>
                 </para>
-
                 <variablelist>
-
                   <varlistentry>
                     <term>-outputcommand</term>
                     <listitem>
                       <para>
                         a function or a list, a function which is called back for output.
                       </para>
-
                       <para>
                         The default output function is empty, meaning that there is
                         no output.
                       </para>
-
                       <para>
                         See below for the details of the communication
                         between the optimization system and the output command
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-storehistory</term>
                     <listitem>
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-verbose</term>
                     <listitem>
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-verbosetermination</term>
                     <listitem>
                       </para>
                     </listitem>
                   </varlistentry>
-
                 </variablelist>
-
                 <para>
                   <emphasis>Bounds and constraints.</emphasis>
                 </para>
-
                 <variablelist>
                   <varlistentry>
                     <term>-boundsmin</term>
-
                     <listitem>
                       <para>
                         a n-by-1 matrix of doubles, the minimum bounds for the parameters
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-boundsmax</term>
-
                     <listitem>
                       <para>
                         a n-by-1 matrix of doubles, the maximum bounds for the parameters
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-nbineqconst</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, integer value,
                       </para>
                     </listitem>
                   </varlistentry>
-
                 </variablelist>
-
                 <para>
                   <emphasis>Initialization.</emphasis>
                 </para>
-
                 <variablelist>
                   <varlistentry>
                     <term>-simplex0method</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of strings, the method to use to compute the initial
                         guess associated with the -x0 option. The following
                         methods are available :
                       </para>
-
                       <variablelist>
                         <varlistentry>
                           <term>"given"</term>
-
                           <listitem>
                             <para>
                               the coordinates associated with the -coords0
                               option are used to compute the initial simplex, with
                               arbitrary number of vertices.
                             </para>
-
                             <para>
                               This allow the user to setup the initial
                               simplex by a specific method which is not provided
                               specific behaviour of the algorithm an be reproduced
                               (for example the Mac Kinnon test case).
                             </para>
-
                             <para>
                               The given matrix is expected to have n rows
                               and k columns, where n is the dimension of the
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"axes"</term>
-
                           <listitem>
                             <para>
                               the simplex is computed from the coordinate
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"spendley"</term>
-
                           <listitem>
                             <para>
                               the simplex is computed so that it is regular
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"pfeffer"</term>
-
                           <listitem>
                             <para>
                               the simplex is computed from a heuristic, in
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"randbounds"</term>
-
                           <listitem>
                             <para>
                               the simplex is computed from the bounds and a
                       </variablelist>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-coords0</term>
-
                     <listitem>
                       <para>
                         a nbve-by-n matrix of doubles, where nbve is the number of vertices and n is
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-simplex0length</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, the length to use when the initial simplex is
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-simplex0deltausual</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, the relative delta for non-zero parameters in
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-simplex0deltazero</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, the absolute delta for non-zero parameters in
                       </para>
                     </listitem>
                   </varlistentry>
-
                 </variablelist>
-
                 <para>
                   <emphasis>Termination.</emphasis>
                 </para>
-
                 <variablelist>
-
                   <varlistentry>
                     <term>-maxfunevals</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, integer value,
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-maxiter</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, integer value,
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-tolfunabsolute</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, the absolute tolerance for the function value
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-tolfunrelative</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, the relative tolerance for the function value
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-tolfunmethod</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of booleans, set to %t to enable termination with
                         tolerance on function value (default tolfunmethod = %f).
                       </para>
-
                       <para>
                         If this criteria is triggered, the
                         status of the optimization is set to "tolf".
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-tolxabsolute</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, the absolute tolerance
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-tolxrelative</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, the relative
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-tolxmethod</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of booleans, set to %t to enable the tolerance on x in the
                         termination criteria (default tolxmethod = %t).
                       </para>
-
                       <para>
                         If this criteria is triggered, the
                         status of the optimization is set to "tolx".
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-tolsimplexizemethod</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of booleans, set to %f to disable the tolerance on the simplex
                         triggered, the status of the optimization is set to
                         "tolsize".
                       </para>
-
                       <para>
                         When this criteria is enabled, the values of the
                         options -tolsimplexizeabsolute and
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-tolsimplexizeabsolute</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, the absolute tolerance on the
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-tolsimplexizerelative</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, the relative tolerance on the
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-tolssizedeltafvmethod</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of booleans, set to %t to enable the termination criteria based
                         If this criteria is triggered, the status of the
                         optimization is set to "tolsizedeltafv".
                       </para>
-
                       <para>
                         This termination criteria uses the values of the
                         options -tolsimplexizeabsolute and -toldeltafv. This
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-toldeltafv</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, the absolute tolerance on the difference between
                       </para>
                     </listitem>
                   </varlistentry>
-
                 </variablelist>
-
                 <para>
                   <emphasis>Algorithm.</emphasis>
                 </para>
-
                 <variablelist>
-
                   <varlistentry>
                     <term>-method</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of strings, the name of the algorithm to use (default method = "variable").
                         The following methods are available :
                       </para>
-
                       <variablelist>
                         <varlistentry>
                           <term>"fixed"</term>
-
                           <listitem>
                             <para>
                               the Spendley et al. fixed simplex shape
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"variable"</term>
-
                           <listitem>
                             <para>
                               the Nelder-Mead variable simplex shape
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"box"</term>
-
                           <listitem>
                             <para>
                               the Box complex algorithm. This algorithm
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"mine"</term>
-
                           <listitem>
                             <para>
                               the user-defined algorithm, associated with the
                             </para>
                           </listitem>
                         </varlistentry>
-
                       </variablelist>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-mymethod</term>
-
                     <listitem>
                       <para>
                         a function, a user-derined simplex algorithm. See below for
                       </para>
                     </listitem>
                   </varlistentry>
-
                 </variablelist>
-
                 <para>
                   <emphasis>Options of the "variable" algorithm.</emphasis>
                 </para>
-
                 <variablelist>
                   <varlistentry>
                     <term>-rho</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, the reflection coefficient. This parameter is used
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-chi</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, the expansion coefficient. This parameter is used
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-gamma</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, the contraction coefficient. This parameter is
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-sigma</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, the shrinkage coefficient. This parameter is used
                       </para>
                     </listitem>
                   </varlistentry>
-
                 </variablelist>
-
                 <para>
                   <emphasis>Option of "box" algorithm.</emphasis>
                 </para>
-
                 <variablelist>
-
-                 <varlistentry>
+                  <varlistentry>
                     <term>-scalingsimplex0</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of strings, the algorithm used to scale the initial simplex into
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-boxnbpoints</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, integer value, the number
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-boxineqscaling</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, in the interval [0,1], the scaling coefficient used to scale the trial
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-guinalphamin</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, the minimum value of alpha when scaling the vertices of the
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-boxreflect</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, the reflection factor in
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-boxtermination</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of booleans, set to %t to enable Box termination criteria (default boxtermination = %f).
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-boxtolf</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, the absolute tolerance on difference of function values in the
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-boxnbmatch</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, integer value,
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-boxboundsalpha</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, positive, the parameter used to project the vertices into the
                       </para>
                     </listitem>
                   </varlistentry>
-
                 </variablelist>
-
                 <para>
                   <emphasis>Auto-Restart.</emphasis>
                 </para>
-
                 <variablelist>
                   <varlistentry>
                     <term>-kelleystagnationflag</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of booleans, set to %t to enable the termination criteria using
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-kelleynormalizationflag</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of booleans, set to %f to disable the normalization of the
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-kelleystagnationalpha0</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, the parameter used in Kelley's stagnation
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-restartflag</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of booleans, set to %t to enable the automatic restart of the
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-restartdetection</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of strings, the method to detect if the automatic restart must
                         be performed (default restartdetection = "oneil").
                         The following methods are available:
                       </para>
-
                       <variablelist>
                         <varlistentry>
                           <term>"oneill"</term>
-
                           <listitem>
                             <para>
                               the factorial local optimality test by O'Neill
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"kelley"</term>
-
                           <listitem>
                             <para>
                               the sufficient decrease condition by O'Neill
                           </listitem>
                         </varlistentry>
                       </variablelist>
-
                       <para>The default method is "oneill".</para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-restartmax</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, the maximum number of restarts, when automatic
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-restarteps</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of doubles, the relative epsilon value used to check for
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-restartstep</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 or a n-by-1 matrix of doubles, positive, where n is the number of
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-restartsimplexmethod</term>
-
                     <listitem>
                       <para>
                         a 1-by-1 matrix of strings, the method to compute the initial simplex after a
                         restart (default restartsimplexmethod = "oriented"). The following methods are available.
                       </para>
-
                       <variablelist>
                         <varlistentry>
                           <term>"given"</term>
-
                           <listitem>
                             <para>
                               the coordinates associated with the -coords0
                               option are used to compute the initial simplex, with
                               arbitrary number of vertices.
                             </para>
-
                             <para>
                               This allow the user to setup the initial
                               simplex by a specific method which is not provided
                               specific behaviour of the algorithm an be reproduced
                               (for example the Mc Kinnon test case).
                             </para>
-
                             <para>
                               The given matrix is expected to have n rows
                               and k columns, where n is the dimension of the
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"axes"</term>
-
                           <listitem>
                             <para>
                               the simplex is computed from the coordinate
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"spendley"</term>
-
                           <listitem>
                             <para>
                               the simplex is computed so that it is regular
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"pfeffer"</term>
-
                           <listitem>
                             <para>
                               the simplex is computed from a heuristic, in
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"randbounds"</term>
-
                           <listitem>
                             <para>
                               the simplex is computed from the bounds and a
                             </para>
                           </listitem>
                         </varlistentry>
-
                         <varlistentry>
                           <term>"oriented"</term>
-
                           <listitem>
                             <para>
                               the simplex is computed so that it is
                           </listitem>
                         </varlistentry>
                       </variablelist>
-
                       <para>The default method is "oriented".</para>
                     </listitem>
                   </varlistentry>
-
-
                 </variablelist>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>value</term>
-
               <listitem>
                 <para>the value.</para>
               </listitem>
           </variablelist>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term xml:id="neldermead_cget">value = neldermead_cget (this,key)</term>
-
         <listitem>
           <para>
             Get the value for the given key. If the key is unknown,
             generates an error.
           </para>
-
           <variablelist>
             <varlistentry>
               <term>this</term>
-
               <listitem>
                 <para>The current object.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>key</term>
-
               <listitem>
                 <para>
                   the name of the key to quiery. The list of available
           </variablelist>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term xml:id="neldermead_get">value = neldermead_get ( this , key )</term>
-
         <listitem>
           <para>
             Get the value for the given key. If the key is unknown,
             generates an error.
           </para>
-
           <para>
             Most fields are available only after an optimization has
             been performed with one call to the neldermead_search
             method.
           </para>
-
           <variablelist>
             <varlistentry>
               <term>this</term>
-
               <listitem>
                 <para>The current object.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>key</term>
-
               <listitem>
                 <para>the key to get.</para>
-
                 <para>The following keys are available :</para>
-
                 <variablelist>
                   <varlistentry>
                     <term>-funevals</term>
-
                     <listitem>
                       <para>the number of function evaluations</para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-iterations</term>
-
                     <listitem>
                       <para>the number of iterations</para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-xopt</term>
-
                     <listitem>
                       <para>
                         the x optimum, as a n x 1 column vector, where n
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-fopt</term>
-
                     <listitem>
                       <para>the optimum cost function value</para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-historyxopt</term>
-
                     <listitem>
                       <para>
                         an array, with nbiter values, containing the
                         history of x during the iterations.
                       </para>
-
                       <para>
                         This array is available after optimization if the
                         history storing was enabled with the -storehistory
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-historyfopt</term>
-
                     <listitem>
                       <para>
                         an array, with nbiter values, containing the
                         history of the function value during the
                         iterations.
                       </para>
-
                       <para>
                         This array is available after optimization if the
                         history storing was enabled with the -storehistory
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-fx0</term>
-
                     <listitem>
                       <para>the function value for the initial guess</para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-status</term>
-
                     <listitem>
                       <para>
                         a string containing the status of the
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-historysimplex</term>
-
                     <listitem>
                       <para>
                         a matrix containing the history of the simplex
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-simplex0</term>
-
                     <listitem>
                       <para>
                         the initial simplex. This is a simplex object,
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-simplexopt</term>
-
                     <listitem>
                       <para>
                         the optimum simplex. This is a simplex object,
                       </para>
                     </listitem>
                   </varlistentry>
-
                   <varlistentry>
                     <term>-restartnb</term>
-
                     <listitem>
                       <para>the number of actual restarts performed.</para>
                     </listitem>
                   </varlistentry>
                 </variablelist>
-
               </listitem>
             </varlistentry>
           </variablelist>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term xml:id="neldermead_search">this = neldermead_search ( this )</term>
-
         <listitem>
           <para>
             Performs the optimization associated with the method
             associated with the -method option and find the optimum.
           </para>
-
           <variablelist>
             <varlistentry>
               <term>this</term>
-
               <listitem>
                 <para>The current object.</para>
               </listitem>
             </varlistentry>
           </variablelist>
-
           <para>
             If the -restartflag option is enabled, automatic restarts are
             performed, based on the -restartdetection option.
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term xml:id="neldermead_restart">this = neldermead_restart ( this )</term>
-
         <listitem>
           <para>
             Restarts the optimization by updating the simplex and
             performing a new search.
           </para>
-
           <variablelist>
             <varlistentry>
               <term>this</term>
-
               <listitem>
                 <para>The current object.</para>
               </listitem>
           </variablelist>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term xml:id="neldermead_function">[ this , result ] = neldermead_function ( this , x )</term>
-
         <listitem>
           <para>Call the cost function and return the value.</para>
-
           <variablelist>
             <varlistentry>
               <term>this</term>
-
               <listitem>
                 <para>The current object.</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>x</term>
-
               <listitem>
                 <para>the point where the function is to be evaluated</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>index</term>
-
               <listitem>
                 <para>
-                  optionnal, a flag to pass to the cost function (default
+                  optional, a flag to pass to the cost function (default
                   = 1). See the section "The cost function" for available values
                   of index.
                 </para>
           </variablelist>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term xml:id="neldermead_defaultoutput">stop = neldermead_defaultoutput(state, data)</term>
-
         <listitem>
           <para>
                  Prints messages at an iteration. 
                  </para>
         </listitem>
       </varlistentry>
-
     </variablelist>
   </refsection>
-
   <refsection>
     <title>The cost function</title>
-
     <para>
       The option <literal>-function</literal> allows to configure the cost function. The cost
       function is used to compute the objective function value <literal>f</literal>.
       must also compute the value of the nonlinear, positive, inequality constraints <literal>c</literal>.
       Depending of these options, the cost function can have one of the following headers :
     </para>
-
     <screen>
       [ f , index ] = costf ( x , index )
       [ f , c , index ] = costf ( x , index )
     </screen>
-
     <para>where</para>
-
     <variablelist>
       <varlistentry>
         <term>x</term>
-
         <listitem>
           <para>the current point, as a column vector</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>index</term>
-
         <listitem>
           <para>optional, an integer representing the value to compute</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>f</term>
-
         <listitem>
           <para>the value of the cost function</para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>c</term>
-
         <listitem>
           <para>the value of the non-linear, positive, inequality constraints</para>
         </listitem>
       </varlistentry>
-
     </variablelist>
-
     <para>
       The index input parameter tells to the cost function what is expected
       in the output arguments. It has the following meaning
     </para>
-
     <variablelist>
-
       <varlistentry>
         <term>index = 2</term>
         <listitem>
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>index = 5</term>
         <listitem>
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>index = 6</term>
         <listitem>
           </para>
         </listitem>
       </varlistentry>
-
     </variablelist>
-
     <para>
       In the most simplex case, there is no additionnal cost function argument and no nonlinear constraints.
       In this case, the cost function is expected to have the following header
     </para>
-
     <screen>
       [ f , index ]= myfunction ( x , index )
     </screen>
-
     <para>
       It might happen that the function requires additionnal arguments to be evaluated.
       In this case, we can use the following feature.
       where the input arguments <literal>a1, a2, ...</literal>
       are automatically appended at the end of the calling sequence.
     </para>
-
   </refsection>
-
   <refsection>
     <title>The output function</title>
-
     <para>
       The option -outputcommand allows to configure a command which is
       called back at the start of the optimization, at each iteration and at the
       end of the optimization.
     </para>
-
     <para>The output function must have the following header</para>
-
     <screen>
       stop = outputcmd(state, data)
     </screen>
-
     <para>where</para>
-
     <variablelist>
-
       <varlistentry>
         <term>state</term>
         <listitem>
           </para>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>data</term>
         <listitem>
           <para>a data structure containing at least the following entries</para>
-
           <variablelist>
             <varlistentry>
               <term>x</term>
-
               <listitem>
                 <para>the current optimum</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>fval</term>
-
               <listitem>
                 <para>the current function value</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>iteration</term>
-
               <listitem>
                 <para>the current iteration index</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>funccount</term>
-
               <listitem>
                 <para>the number of function evaluations</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>simplex</term>
-
               <listitem>
                 <para>the current simplex</para>
               </listitem>
             </varlistentry>
-
             <varlistentry>
               <term>step</term>
-
               <listitem>
                 <para>
                   the previous step in the algorithm. The following values
           </variablelist>
         </listitem>
       </varlistentry>
-
       <varlistentry>
         <term>stop</term>
         <listitem>
           </para>
         </listitem>
       </varlistentry>
-
     </variablelist>
-
     <para>
       It might happen that the output function requires additionnal arguments to be evaluated.
       In this case, we can use the following feature.
       where the input arguments <literal>a1, a2, ...</literal>
       are automatically appended at the end of the calling sequence.
     </para>
-
     <para>
       If the output function sets the <literal>stop</literal> variable to true,
       then the optimization alorithm stops and the status of the optimization is
       set to <literal>"userstop"</literal>.
     </para>
-
   </refsection>
-
   <refsection>
     <title>Termination</title>
-
     <para>
       The current component takes into account for several generic
       termination criterias.
     </para>
-
     <para>The following termination criterias are enabled by default :</para>
-
     <itemizedlist>
       <listitem>
         <para>-maxiter,</para>
       </listitem>
-
       <listitem>
         <para>-maxfunevals,</para>
       </listitem>
-
       <listitem>
         <para>-tolxmethod.</para>
       </listitem>
-
       <listitem>
         <para>-tolsimplexizemethod.</para>
       </listitem>
     </itemizedlist>
-
     <para>
       The optimization_terminate function uses a set of rules to compute
       if the termination occurs, which leads to an optimization status which is
       be a user-defined string, in the case where a user-defined termination
       function has been set.
     </para>
-
     <para>The following set of rules is examined in this order.</para>
-
     <itemizedlist>
       <listitem>
         <para>
           %f.
         </para>
       </listitem>
-
       <listitem>
         <para>
           The number of iterations is examined and compared to the
           <literal>-maxiter</literal> option : if the following condition
         </para>
-
         <screen>
           iterations &gt;= maxiter
         </screen>
-
         <para>
           is true, then the status is set to "maxiter" and terminate is
           set to %t.
         </para>
       </listitem>
-
       <listitem>
         <para>
           The number of function evaluations and compared to the
           <literal>-maxfunevals</literal> option is examined : if the following condition
         </para>
-
         <screen>
           funevals &gt;= maxfunevals
         </screen>
-
         <para>
           is true, then the status is set to <literal>"maxfuneval"</literal> and <literal>terminate</literal> is
           set to %t.
         </para>
       </listitem>
-
       <listitem>
         <para>
           The tolerance on function value is examined depending on the
           value of the <literal>-tolfunmethod</literal>.
         </para>
-
         <variablelist>
           <varlistentry>
             <term>%f</term>
-
             <listitem>
               <para>then the criteria is just ignored.</para>
             </listitem>
           </varlistentry>
-
           <varlistentry>
             <term>%t</term>
-
             <listitem>
               <para>if the following condition</para>
-
               <screen>
                 abs(currentfopt) &lt; tolfunrelative * abs(previousfopt) + tolfunabsolute
               </screen>
-
               <para>
                 is true, then the status is set to "tolf" and terminate is
                 set to %t.
             </listitem>
           </varlistentry>
         </variablelist>
-
         <para>
           The relative termination criteria on the function value works
           well if the function value at optimum is near zero. In that case, the
           This criteria is sensitive to the <literal>-tolfunrelative</literal>
           and <literal>-tolfunabsolute</literal> options.
         </para>
-
         <para>
           The absolute termination criteria on the function value works if
           the user has an accurate idea of the optimum function value.
         </para>
       </listitem>
-
       <listitem>
         <para>
           The tolerance on x is examined depending on the value of the
           -tolxmethod.
         </para>
-
         <variablelist>
           <varlistentry>
             <term>%f</term>
-
             <listitem>
               <para>then the criteria is just ignored.</para>
             </listitem>
           </varlistentry>
-
           <varlistentry>
             <term>%t</term>
-
             <listitem>
               <para>if the following condition</para>
-
               <screen>
                 norm(xopt - previousxopt) &lt; tolxrelative * norm(xopt) + tolxabsolute
               </screen>
-
-
               <para>
                 is true, then the status is set to <literal>"tolx"</literal> and <literal>terminate</literal> is
                 set to %t.
               </para>
-
             </listitem>
           </varlistentry>
         </variablelist>
-
         <para>
           This criteria is sensitive to the <literal>-tolxrelative</literal>
           and <literal>-tolxabsolute</literal> options.
         </para>
-
         <para>
           The relative termination criteria on x works well if x at
           optimum is different from zero. In that case, the condition measures
           the distance between two iterates.
         </para>
-
         <para>
           The absolute termination criteria on x works if the user has an
           accurate idea of the scale of the optimum x. If the optimum x is near
           more appropriate.
         </para>
       </listitem>
-
       <listitem>
         <para>
           The tolerance on simplex size is examined depending on
           the value of the <literal>-tolsimplexizemethod</literal> option.
         </para>
-
         <variablelist>
           <varlistentry>
             <term>%f</term>
-
             <listitem>
               <para>then the criteria is just ignored.</para>
             </listitem>
           </varlistentry>
-
           <varlistentry>
             <term>%t</term>
-
             <listitem>
               <para>if the following condition</para>
-
               <screen>
                 ssize &lt; tolsimplexizerelative * simplexsize0 + tolsimplexizeabsolute
               </screen>
-
               <para>
                 is true where <literal>simplexsize0</literal> is the size of the simplex at
                 iteration 0, then the <literal>status</literal> is set to <literal>"tolsize"</literal>
                 the <literal>-tolsimplexizerelative</literal> options.
               </para>
             </listitem>
-
-
           </varlistentry>
         </variablelist>
       </listitem>
-
-
       <listitem>
         <para>
           The absolute tolerance on simplex size and absolute difference
           of function value is examined depending on the value of the
           -tolssizedeltafvmethod option.
         </para>
-
         <variablelist>
           <varlistentry>
             <term>%f</term>
-
             <listitem>
               <para>then the criteria is just ignored.</para>
             </listitem>
           </varlistentry>
-
           <varlistentry>
             <term>%t</term>
-
             <listitem>
               <para>if both the following conditions</para>
-
               <screen>
                 ssize &lt; tolsimplexizeabsolute
               </screen>
-
               <screen>
                 shiftfv &lt; toldeltafv
               </screen>
-
               <para>
                 is true where <literal>ssize</literal> is the current simplex size and
                 <literal>shiftfv</literal> is the absolute value of the difference of function
           </varlistentry>
         </variablelist>
       </listitem>
-
       <listitem>
         <para>
           The stagnation condition based on Kelley sufficient decrease
           condition is examined depending on the value of the
           <literal>-kelleystagnationflag</literal> option.
         </para>
-
         <variablelist>
           <varlistentry>
             <term>%f</term>
-
             <listitem>
               <para>then the criteria is just ignored.</para>
             </listitem>
           </varlistentry>
-
           <varlistentry>
             <term>%t</term>
-
             <listitem>
               <para>if the following condition</para>
-
               <screen>
                 newfvmean &lt;= oldfvmean - alpha * sg' * sg
               </screen>
-
               <para>
                 is true where <literal>newfvmean</literal> (resp. <literal>oldfvmean</literal>) is the function
                 value average in the current iteration (resp. in the previous
           </varlistentry>
         </variablelist>
       </listitem>
-
       <listitem>
         <para>
           The termination condition suggested by Box
           is examined depending on the value of the
           -boxtermination option.
         </para>
-
         <variablelist>
           <varlistentry>
             <term>%f</term>
-
             <listitem>
               <para>then the criteria is just ignored.</para>
             </listitem>
           </varlistentry>
-
           <varlistentry>
             <term>%t</term>
-
             <listitem>
               <para>if both the following conditions</para>
-
               <screen>
                 shiftfv &lt; boxtolf
               </screen>
-
               <screen>
                 boxkount == boxnbmatch
               </screen>
-
               <para>
                 is true where <literal>shiftfv </literal>is the difference of function value
                 between the best and worst vertices, and <literal>boxkount</literal> is the number of
           </varlistentry>
         </variablelist>
       </listitem>
-
       <listitem>
         <para>
           The termination condition based on the variance of the function values in the simplex
           is examined depending on the value of the
           <literal>-tolvarianceflag</literal> option.
         </para>
-
         <variablelist>
           <varlistentry>
             <term>%f</term>
-
             <listitem>
               <para>then the criteria is just ignored.</para>
             </listitem>
           </varlistentry>
-
           <varlistentry>
             <term>%t</term>
-
             <listitem>
               <para>if the following condition</para>
-
               <screen>
                 var &lt; tolrelativevariance * variancesimplex0 + tolabsolutevariance
               </screen>
-
               <para>
                 is true whe