Deleted vectorized computation feature. Deleted neldermead_contour. Fixed the demos.
[scilab.git] / scilab / modules / optimization / help / en_US / lmitool.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - INRIA
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <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="lmitool">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>lmitool</refname>
19     <refpurpose> tool for solving linear matrix inequations</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>lmitool()
24
25 lmitool(filename)
26
27 txt=lmitool(probname,varlist,datalist)</synopsis>
28   </refsynopsisdiv>
29   <refsection>
30     <title>Parameters</title>
31     <variablelist>
32       <varlistentry>
33         <term>filename</term>
34         <listitem>
35           <para>a string referring to a <literal>.sci</literal> function</para>
36         </listitem>
37       </varlistentry>
38       <varlistentry>
39         <term>probname</term>
40         <listitem>
41           <para>a string containing the name of the problem</para>
42         </listitem>
43       </varlistentry>
44       <varlistentry>
45         <term>varlist</term>
46         <listitem>
47           <para>a string containing the names of the unknown matrices (separated by commas if there are more than one)</para>
48         </listitem>
49       </varlistentry>
50       <varlistentry>
51         <term>datalist</term>
52         <listitem>
53           <para> a string containing the names of  data matrices (separated by commas if there are more than one)</para>
54         </listitem>
55       </varlistentry>
56       <varlistentry>
57         <term>txt</term>
58         <listitem>
59           <para>a string providing information on what the user should do next</para>
60         </listitem>
61       </varlistentry>
62     </variablelist>
63   </refsection>
64   <refsection>
65     <title>Description</title>
66     <para><literal>lmitool()</literal> or <literal>lmitool(filename)</literal> is used to define 
67     interactively a LMI problem.
68     In the non interactive mode,
69     <literal>txt=lmitool(probname,varlist,datalist)</literal>
70     generates a file in the current directory. The name of this file 
71     is obtained by adding <literal>.sci</literal> to the end of <literal>probname</literal>. 
72     This file is the skeleton of a solver function and the corresponding 
73     evaluation function needed by <literal>lmisolver</literal>.</para>
74   </refsection>
75   <refsection>
76     <title>See Also</title>
77     <simplelist type="inline">
78       <member>
79         <link linkend="lmisolver">lmisolver</link>
80       </member>
81     </simplelist>
82   </refsection>
83 </refentry>