File: lmitool.xml

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (83 lines) | stat: -rw-r--r-- 3,015 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * 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" xml:id="lmitool">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>
  <refnamediv>
    <refname>lmitool</refname>
    <refpurpose> tool for solving linear matrix inequations</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>lmitool()

lmitool(filename)

txt=lmitool(probname,varlist,datalist)</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Parameters</title>
    <variablelist>
      <varlistentry>
        <term>filename</term>
        <listitem>
          <para>a string referring to a <literal>.sci</literal> function</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>probname</term>
        <listitem>
          <para>a string containing the name of the problem</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>varlist</term>
        <listitem>
          <para>a string containing the names of the unknown matrices (separated by commas if there are more than one)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>datalist</term>
        <listitem>
          <para> a string containing the names of  data matrices (separated by commas if there are more than one)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>txt</term>
        <listitem>
          <para>a string providing information on what the user should do next</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Description</title>
    <para><literal>lmitool()</literal> or <literal>lmitool(filename)</literal> is used to define 
    interactively a LMI problem.
    In the non interactive mode,
    <literal>txt=lmitool(probname,varlist,datalist)</literal>
    generates a file in the current directory. The name of this file 
    is obtained by adding <literal>.sci</literal> to the end of <literal>probname</literal>. 
    This file is the skeleton of a solver function and the corresponding 
    evaluation function needed by <literal>lmisolver</literal>.</para>
  </refsection>
  <refsection>
    <title>See Also</title>
    <simplelist type="inline">
      <member>
        <link linkend="lmisolver">lmisolver</link>
      </member>
    </simplelist>
  </refsection>
</refentry>