← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/xcos/help/en_US/palettes/Matrix_pal/MATLU.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/xcos/help/en_US/palettes/Matrix_pal/MATLU.xml
22
22
 * See the file ./license.txt
23
23
 -->
24
24
<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="MATLU">
25
 
  <refnamediv>
26
 
    <refname>MATLU</refname>
27
 
    <refpurpose>LU Factorization</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata align="center" fileref="../../../../images/palettes/MATLU.png" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_MATLU">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="MATLU">LU Factorization</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_MATLU">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_MATLU">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_MATLU">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_MATLU">Default properties</xref>
67
 
            </para>
68
 
          </listitem>
69
 
          <listitem>
70
 
            <para>
71
 
              <xref linkend="Interfacingfunction_MATLU">Interfacing function</xref>
72
 
            </para>
73
 
          </listitem>
74
 
          <listitem>
75
 
            <para>
76
 
              <xref linkend="Computationalfunction_MATLU">Computational function</xref>
77
 
            </para>
78
 
          </listitem>
79
 
          <listitem>
80
 
            <para>
81
 
              <xref linkend="Seealso_MATLU">See also</xref>
82
 
            </para>
83
 
          </listitem>
84
 
        </itemizedlist>
85
 
      </listitem>
86
 
    </itemizedlist>
87
 
  </refsection>
88
 
  <refsection id="Palette_MATLU">
89
 
    <title>Palette</title>
90
 
    <itemizedlist>
91
 
      <listitem>
92
 
        <para>
93
 
          <link linkend="Matrix_pal">Matrix operation palette</link>
94
 
        </para>
95
 
      </listitem>
96
 
    </itemizedlist>
97
 
  </refsection>
98
 
  <refsection id="Description_MATLU">
99
 
    <title>Description</title>
100
 
    <para>
101
 
      The MATLU Block outputs two matrices L and U, with row pivoting, from the LU factorization of a
102
 
      square input matrix. If A is the input matrix then:
103
 
      <para>
104
 
      </para>
105
 
      E*A=L*U where E is the permutation matrix, U an upper triangular matrix and L a lower triangular matrix.
106
 
    </para>
107
 
    <para>
108
 
      The equivalent function of this block in Scilab is <link linkend="lu">[l,u,e]=lu(A)</link>.
109
 
    </para>
110
 
    <para/>
111
 
  </refsection>
112
 
  <refsection id="Dialogbox_MATLU">
113
 
    <title>Dialog box</title>
114
 
    <para>
115
 
      <inlinemediaobject>
116
 
        <imageobject>
117
 
          <imagedata align="center" fileref="../../../../images/gui/MATLU_gui.gif" valign="middle"/>
118
 
        </imageobject>
119
 
      </inlinemediaobject>
120
 
    </para>
121
 
    <para/>
122
 
    <itemizedlist>
123
 
      <listitem>
124
 
        <para>
125
 
          <emphasis role="bold">Datatype(1=real double 2=Complex)</emphasis>
126
 
        </para>
127
 
        <para>
128
 
          It indicates the type of the output. It support only the two types double (1) and complex (2).
129
 
          If we input another entry in this label xcos will print the message "Datatype is not supported".
130
 
        </para>
131
 
        <para>Properties : Type 'vec' of size 1.</para>
132
 
      </listitem>
133
 
    </itemizedlist>
134
 
  </refsection>
135
 
  <refsection id="Defaultproperties_MATLU">
136
 
    <title>Default properties</title>
137
 
    <itemizedlist>
138
 
      <listitem>
139
 
        <para>
140
 
          <emphasis role="bold">always active:</emphasis> no
141
 
        </para>
142
 
      </listitem>
143
 
      <listitem>
144
 
        <para>
145
 
          <emphasis role="bold">direct-feedthrough:</emphasis> yes
146
 
        </para>
147
 
      </listitem>
148
 
      <listitem>
149
 
        <para>
150
 
          <emphasis role="bold">zero-crossing:</emphasis> no
151
 
        </para>
152
 
      </listitem>
153
 
      <listitem>
154
 
        <para>
155
 
          <emphasis role="bold">mode:</emphasis> no
156
 
        </para>
157
 
      </listitem>
158
 
      <listitem>
159
 
        <para>
160
 
          <emphasis role="bold">regular inputs:</emphasis>
161
 
        </para>
162
 
        <para>
163
 
          <emphasis role="bold">- port 1 : size [-1,-1] / type 1</emphasis>
164
 
        </para>
165
 
      </listitem>
166
 
      <listitem>
167
 
        <para>
168
 
          <emphasis role="bold">regular outputs:</emphasis>
169
 
        </para>
170
 
        <para>
171
 
          <emphasis role="bold">- port 1 : size [-1,-1] / type 1</emphasis>
172
 
        </para>
173
 
        <para>
174
 
          <emphasis role="bold">- port 2 : size [-1,-1] / type 1</emphasis>
175
 
        </para>
176
 
      </listitem>
177
 
      <listitem>
178
 
        <para>
179
 
          <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
180
 
        </para>
181
 
      </listitem>
182
 
      <listitem>
183
 
        <para>
184
 
          <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
185
 
        </para>
186
 
      </listitem>
187
 
      <listitem>
188
 
        <para>
189
 
          <emphasis role="bold">continuous-time state:</emphasis> no
190
 
        </para>
191
 
      </listitem>
192
 
      <listitem>
193
 
        <para>
194
 
          <emphasis role="bold">discrete-time state:</emphasis> no
195
 
        </para>
196
 
      </listitem>
197
 
      <listitem>
198
 
        <para>
199
 
          <emphasis role="bold">object discrete-time state:</emphasis> no
200
 
        </para>
201
 
      </listitem>
202
 
      <listitem>
203
 
        <para>
204
 
          <emphasis role="bold">name of computational function:</emphasis>
205
 
          <emphasis role="italic">mat_lu</emphasis>
206
 
        </para>
207
 
      </listitem>
208
 
    </itemizedlist>
209
 
  </refsection>
210
 
  <refsection id="Interfacingfunction_MATLU">
211
 
    <title>Interfacing function</title>
212
 
    <itemizedlist>
213
 
      <listitem>
214
 
        <para>SCI/modules/scicos_blocks/macros/MatrixOp/MATLU.sci</para>
215
 
      </listitem>
216
 
    </itemizedlist>
217
 
  </refsection>
218
 
  <refsection id="Computationalfunction_MATLU">
219
 
    <title>Computational function</title>
220
 
    <itemizedlist>
221
 
      <listitem>
222
 
        <para>SCI/modules/scicos_blocks/src/c/mat_lu.c</para>
223
 
      </listitem>
224
 
      <listitem>
225
 
        <para>SCI/modules/scicos_blocks/src/c/matz_lu.c</para>
226
 
      </listitem>
227
 
    </itemizedlist>
228
 
  </refsection>
229
 
  <refsection id="Seealso_MATLU">
230
 
    <title>See also</title>
231
 
    <itemizedlist>
232
 
      <listitem>
233
 
        <para>
234
 
          <link linkend="MATINV">MATINV - Matrix Inverse (xcos Block)</link>
235
 
        </para>
236
 
      </listitem>
237
 
      <listitem>
238
 
        <para>
239
 
          <link linkend="lu">lu (Scilab function)</link>
240
 
        </para>
241
 
      </listitem>
242
 
    </itemizedlist>
243
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>MATLU</refname>
 
27
        <refpurpose>LU Factorization</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata align="center" fileref="../../../../images/palettes/MATLU.png" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_MATLU">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="MATLU">LU Factorization</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_MATLU">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_MATLU">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_MATLU">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_MATLU">Default properties</xref>
 
67
                        </para>
 
68
                    </listitem>
 
69
                    <listitem>
 
70
                        <para>
 
71
                            <xref linkend="Interfacingfunction_MATLU">Interfacing function</xref>
 
72
                        </para>
 
73
                    </listitem>
 
74
                    <listitem>
 
75
                        <para>
 
76
                            <xref linkend="Computationalfunction_MATLU">Computational function</xref>
 
77
                        </para>
 
78
                    </listitem>
 
79
                    <listitem>
 
80
                        <para>
 
81
                            <xref linkend="Seealso_MATLU">See also</xref>
 
82
                        </para>
 
83
                    </listitem>
 
84
                </itemizedlist>
 
85
            </listitem>
 
86
        </itemizedlist>
 
87
    </refsection>
 
88
    <refsection id="Palette_MATLU">
 
89
        <title>Palette</title>
 
90
        <itemizedlist>
 
91
            <listitem>
 
92
                <para>
 
93
                    <link linkend="Matrix_pal">Matrix operation palette</link>
 
94
                </para>
 
95
            </listitem>
 
96
        </itemizedlist>
 
97
    </refsection>
 
98
    <refsection id="Description_MATLU">
 
99
        <title>Description</title>
 
100
        <para>
 
101
            The MATLU Block outputs two matrices L and U, with row pivoting, from the LU factorization of a
 
102
            square input matrix. If A is the input matrix then:
 
103
            <para>
 
104
            </para>
 
105
            E*A=L*U where E is the permutation matrix, U an upper triangular matrix and L a lower triangular matrix.
 
106
        </para>
 
107
        <para>
 
108
            The equivalent function of this block in Scilab is <link linkend="lu">[l,u,e]=lu(A)</link>.
 
109
        </para>
 
110
        <para/>
 
111
    </refsection>
 
112
    <refsection id="Dialogbox_MATLU">
 
113
        <title>Dialog box</title>
 
114
        <para>
 
115
            <inlinemediaobject>
 
116
                <imageobject>
 
117
                    <imagedata align="center" fileref="../../../../images/gui/MATLU_gui.gif" valign="middle"/>
 
118
                </imageobject>
 
119
            </inlinemediaobject>
 
120
        </para>
 
121
        <para/>
 
122
        <itemizedlist>
 
123
            <listitem>
 
124
                <para>
 
125
                    <emphasis role="bold">Datatype(1=real double 2=Complex)</emphasis>
 
126
                </para>
 
127
                <para>
 
128
                    It indicates the type of the output. It support only the two types double (1) and complex (2).
 
129
                    If we input another entry in this label xcos will print the message "Datatype is not supported".
 
130
                </para>
 
131
                <para>Properties : Type 'vec' of size 1.</para>
 
132
            </listitem>
 
133
        </itemizedlist>
 
134
    </refsection>
 
135
    <refsection id="Defaultproperties_MATLU">
 
136
        <title>Default properties</title>
 
137
        <itemizedlist>
 
138
            <listitem>
 
139
                <para>
 
140
                    <emphasis role="bold">always active:</emphasis> no
 
141
                </para>
 
142
            </listitem>
 
143
            <listitem>
 
144
                <para>
 
145
                    <emphasis role="bold">direct-feedthrough:</emphasis> yes
 
146
                </para>
 
147
            </listitem>
 
148
            <listitem>
 
149
                <para>
 
150
                    <emphasis role="bold">zero-crossing:</emphasis> no
 
151
                </para>
 
152
            </listitem>
 
153
            <listitem>
 
154
                <para>
 
155
                    <emphasis role="bold">mode:</emphasis> no
 
156
                </para>
 
157
            </listitem>
 
158
            <listitem>
 
159
                <para>
 
160
                    <emphasis role="bold">regular inputs:</emphasis>
 
161
                </para>
 
162
                <para>
 
163
                    <emphasis role="bold">- port 1 : size [-1,-1] / type 1</emphasis>
 
164
                </para>
 
165
            </listitem>
 
166
            <listitem>
 
167
                <para>
 
168
                    <emphasis role="bold">regular outputs:</emphasis>
 
169
                </para>
 
170
                <para>
 
171
                    <emphasis role="bold">- port 1 : size [-1,-1] / type 1</emphasis>
 
172
                </para>
 
173
                <para>
 
174
                    <emphasis role="bold">- port 2 : size [-1,-1] / type 1</emphasis>
 
175
                </para>
 
176
            </listitem>
 
177
            <listitem>
 
178
                <para>
 
179
                    <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
 
180
                </para>
 
181
            </listitem>
 
182
            <listitem>
 
183
                <para>
 
184
                    <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
 
185
                </para>
 
186
            </listitem>
 
187
            <listitem>
 
188
                <para>
 
189
                    <emphasis role="bold">continuous-time state:</emphasis> no
 
190
                </para>
 
191
            </listitem>
 
192
            <listitem>
 
193
                <para>
 
194
                    <emphasis role="bold">discrete-time state:</emphasis> no
 
195
                </para>
 
196
            </listitem>
 
197
            <listitem>
 
198
                <para>
 
199
                    <emphasis role="bold">object discrete-time state:</emphasis> no
 
200
                </para>
 
201
            </listitem>
 
202
            <listitem>
 
203
                <para>
 
204
                    <emphasis role="bold">name of computational function:</emphasis>
 
205
                    <emphasis role="italic">mat_lu</emphasis>
 
206
                </para>
 
207
            </listitem>
 
208
        </itemizedlist>
 
209
    </refsection>
 
210
    <refsection id="Interfacingfunction_MATLU">
 
211
        <title>Interfacing function</title>
 
212
        <itemizedlist>
 
213
            <listitem>
 
214
                <para>SCI/modules/scicos_blocks/macros/MatrixOp/MATLU.sci</para>
 
215
            </listitem>
 
216
        </itemizedlist>
 
217
    </refsection>
 
218
    <refsection id="Computationalfunction_MATLU">
 
219
        <title>Computational function</title>
 
220
        <itemizedlist>
 
221
            <listitem>
 
222
                <para>SCI/modules/scicos_blocks/src/c/mat_lu.c</para>
 
223
            </listitem>
 
224
            <listitem>
 
225
                <para>SCI/modules/scicos_blocks/src/c/matz_lu.c</para>
 
226
            </listitem>
 
227
        </itemizedlist>
 
228
    </refsection>
 
229
    <refsection id="Seealso_MATLU">
 
230
        <title>See also</title>
 
231
        <itemizedlist>
 
232
            <listitem>
 
233
                <para>
 
234
                    <link linkend="MATINV">MATINV - Matrix Inverse (xcos Block)</link>
 
235
                </para>
 
236
            </listitem>
 
237
            <listitem>
 
238
                <para>
 
239
                    <link linkend="lu">lu (Scilab function)</link>
 
240
                </para>
 
241
            </listitem>
 
242
        </itemizedlist>
 
243
    </refsection>
244
244
</refentry>