← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/polynomials/help/en_US/lcmdiag.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/polynomials/help/en_US/lcmdiag.xml
11
11
 *
12
12
 -->
13
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="lcmdiag">
14
 
  <refnamediv>
15
 
    <refname>lcmdiag</refname>
16
 
    <refpurpose> least common multiple diagonal factorization</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>[N,D]=lcmdiag(H)
21
 
      [N,D]=lcmdiag(H,flag)
22
 
    </synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>H</term>
29
 
        <listitem>
30
 
          <para>rational matrix</para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
      <varlistentry>
34
 
        <term>N</term>
35
 
        <listitem>
36
 
          <para>polynomial matrix</para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
      <varlistentry>
40
 
        <term>D</term>
41
 
        <listitem>
42
 
          <para>diagonal polynomial matrix</para>
43
 
        </listitem>
44
 
      </varlistentry>
45
 
      <varlistentry>
46
 
        <term>flag</term>
47
 
        <listitem>
48
 
          <para>
49
 
            character string: <literal>'row'</literal> or <literal>'col'</literal> (default)
50
 
          </para>
51
 
        </listitem>
52
 
      </varlistentry>
53
 
    </variablelist>
54
 
  </refsection>
55
 
  <refsection>
56
 
    <title>Description</title>
57
 
    <para>
58
 
      <literal>[N,D]=lcmdiag(H,'row')</literal> computes a factorization <literal>D*H=N</literal>,
59
 
      i.e.  <literal>H=D^(-1)*N</literal>  where D is a diagonal matrix with D(k,k)=lcm of
60
 
      kth row of H('den').
61
 
    </para>
62
 
    <para>
63
 
      <literal>[N,D]=lcmdiag(H)</literal> or <literal>[N,D]=lcmdiag(H,'col)</literal> returns
64
 
      <literal>H=N*D^(-1)</literal> with diagonal D and D(k,k)=lcm of kth col of H('den')
65
 
    </para>
66
 
  </refsection>
67
 
  <refsection>
68
 
    <title>Examples</title>
69
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>lcmdiag</refname>
 
16
        <refpurpose> least common multiple diagonal factorization</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>[N,D]=lcmdiag(H)
 
21
            [N,D]=lcmdiag(H,flag)
 
22
        </synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>H</term>
 
29
                <listitem>
 
30
                    <para>rational matrix</para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
            <varlistentry>
 
34
                <term>N</term>
 
35
                <listitem>
 
36
                    <para>polynomial matrix</para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
            <varlistentry>
 
40
                <term>D</term>
 
41
                <listitem>
 
42
                    <para>diagonal polynomial matrix</para>
 
43
                </listitem>
 
44
            </varlistentry>
 
45
            <varlistentry>
 
46
                <term>flag</term>
 
47
                <listitem>
 
48
                    <para>
 
49
                        character string: <literal>'row'</literal> or <literal>'col'</literal> (default)
 
50
                    </para>
 
51
                </listitem>
 
52
            </varlistentry>
 
53
        </variablelist>
 
54
    </refsection>
 
55
    <refsection>
 
56
        <title>Description</title>
 
57
        <para>
 
58
            <literal>[N,D]=lcmdiag(H,'row')</literal> computes a factorization <literal>D*H=N</literal>,
 
59
            i.e.  <literal>H=D^(-1)*N</literal>  where D is a diagonal matrix with D(k,k)=lcm of
 
60
            kth row of H('den').
 
61
        </para>
 
62
        <para>
 
63
            <literal>[N,D]=lcmdiag(H)</literal> or <literal>[N,D]=lcmdiag(H,'col)</literal> returns
 
64
            <literal>H=N*D^(-1)</literal> with diagonal D and D(k,k)=lcm of kth col of H('den')
 
65
        </para>
 
66
    </refsection>
 
67
    <refsection>
 
68
        <title>Examples</title>
 
69
        <programlisting role="example"><![CDATA[ 
70
70
s=poly(0,'s');
71
71
H=[1/s,(s+2)/s/(s+1)^2;1/(s^2*(s+2)),2/(s+2)];
72
72
[N,D]=lcmdiag(H);
73
73
N/D-H
74
74
 ]]></programlisting>
75
 
  </refsection>
76
 
  <refsection role="see also">
77
 
    <title>See Also</title>
78
 
    <simplelist type="inline">
79
 
      <member>
80
 
        <link linkend="lcm">lcm</link>
81
 
      </member>
82
 
      <member>
83
 
        <link linkend="gcd">gcd</link>
84
 
      </member>
85
 
      <member>
86
 
        <link linkend="bezout">bezout</link>
87
 
      </member>
88
 
    </simplelist>
89
 
  </refsection>
 
75
    </refsection>
 
76
    <refsection role="see also">
 
77
        <title>See Also</title>
 
78
        <simplelist type="inline">
 
79
            <member>
 
80
                <link linkend="lcm">lcm</link>
 
81
            </member>
 
82
            <member>
 
83
                <link linkend="gcd">gcd</link>
 
84
            </member>
 
85
            <member>
 
86
                <link linkend="bezout">bezout</link>
 
87
            </member>
 
88
        </simplelist>
 
89
    </refsection>
90
90
</refentry>