← 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/varn.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/varn.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<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="varn">
3
 
  <refnamediv>
4
 
    <refname>varn</refname>
5
 
    <refpurpose> symbolic variable of a polynomial</refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>[symb]=varn(p)
10
 
      [pm]=varn(x,var)
11
 
    </synopsis>
12
 
  </refsynopsisdiv>
13
 
  <refsection>
14
 
    <title>Arguments</title>
15
 
    <variablelist>
16
 
      <varlistentry>
17
 
        <term>p</term>
18
 
        <listitem>
19
 
          <para>polynomial (or polynomial matrix)</para>
20
 
        </listitem>
21
 
      </varlistentry>
22
 
      <varlistentry>
23
 
        <term>symb</term>
24
 
        <listitem>
25
 
          <para>character string</para>
26
 
        </listitem>
27
 
      </varlistentry>
28
 
      <varlistentry>
29
 
        <term>x</term>
30
 
        <listitem>
31
 
          <para>polynomial or polynomial matrix</para>
32
 
        </listitem>
33
 
      </varlistentry>
34
 
      <varlistentry>
35
 
        <term>var</term>
36
 
        <listitem>
37
 
          <para>symbolic variable (character string)</para>
38
 
        </listitem>
39
 
      </varlistentry>
40
 
      <varlistentry>
41
 
        <term>pm</term>
42
 
        <listitem>
43
 
          <para>polynomial (or polynomial matrix)</para>
44
 
        </listitem>
45
 
      </varlistentry>
46
 
    </variablelist>
47
 
  </refsection>
48
 
  <refsection>
49
 
    <title>Description</title>
50
 
    <para>
51
 
      <literal>symb=varn(p)</literal> returns in <literal>symb</literal> the symbolic variable of the polynomial <literal>p</literal>
52
 
      (i.e. <literal>varn(poly(0,'x'))</literal> is <literal>'x'</literal>).
53
 
    </para>
54
 
    <para>
55
 
      <literal>varn(x,'s')</literal> returns a polynomial matrix with same coefficients
56
 
      as <literal>x</literal> but with <literal>'s'</literal> as symbolic variable (change of variable name).
57
 
    </para>
58
 
  </refsection>
59
 
  <refsection>
60
 
    <title>Examples</title>
61
 
    <programlisting role="example"><![CDATA[ 
 
3
    <refnamediv>
 
4
        <refname>varn</refname>
 
5
        <refpurpose> symbolic variable of a polynomial</refpurpose>
 
6
    </refnamediv>
 
7
    <refsynopsisdiv>
 
8
        <title>Calling Sequence</title>
 
9
        <synopsis>[symb]=varn(p)
 
10
            [pm]=varn(x,var)
 
11
        </synopsis>
 
12
    </refsynopsisdiv>
 
13
    <refsection>
 
14
        <title>Arguments</title>
 
15
        <variablelist>
 
16
            <varlistentry>
 
17
                <term>p</term>
 
18
                <listitem>
 
19
                    <para>polynomial (or polynomial matrix)</para>
 
20
                </listitem>
 
21
            </varlistentry>
 
22
            <varlistentry>
 
23
                <term>symb</term>
 
24
                <listitem>
 
25
                    <para>character string</para>
 
26
                </listitem>
 
27
            </varlistentry>
 
28
            <varlistentry>
 
29
                <term>x</term>
 
30
                <listitem>
 
31
                    <para>polynomial or polynomial matrix</para>
 
32
                </listitem>
 
33
            </varlistentry>
 
34
            <varlistentry>
 
35
                <term>var</term>
 
36
                <listitem>
 
37
                    <para>symbolic variable (character string)</para>
 
38
                </listitem>
 
39
            </varlistentry>
 
40
            <varlistentry>
 
41
                <term>pm</term>
 
42
                <listitem>
 
43
                    <para>polynomial (or polynomial matrix)</para>
 
44
                </listitem>
 
45
            </varlistentry>
 
46
        </variablelist>
 
47
    </refsection>
 
48
    <refsection>
 
49
        <title>Description</title>
 
50
        <para>
 
51
            <literal>symb=varn(p)</literal> returns in <literal>symb</literal> the symbolic variable of the polynomial <literal>p</literal>
 
52
            (i.e. <literal>varn(poly(0,'x'))</literal> is <literal>'x'</literal>).
 
53
        </para>
 
54
        <para>
 
55
            <literal>varn(x,'s')</literal> returns a polynomial matrix with same coefficients
 
56
            as <literal>x</literal> but with <literal>'s'</literal> as symbolic variable (change of variable name).
 
57
        </para>
 
58
    </refsection>
 
59
    <refsection>
 
60
        <title>Examples</title>
 
61
        <programlisting role="example"><![CDATA[ 
62
62
s=poly(0,'s');p=[s^2+1,s];
63
63
varn(p)
64
64
varn(p,'x')
65
65
 ]]></programlisting>
66
 
  </refsection>
67
 
  <refsection role="see also">
68
 
    <title>See Also</title>
69
 
    <simplelist type="inline">
70
 
      <member>
71
 
        <link linkend="horner">horner</link>
72
 
      </member>
73
 
      <member>
74
 
        <link linkend="poly">poly</link>
75
 
      </member>
76
 
    </simplelist>
77
 
  </refsection>
 
66
    </refsection>
 
67
    <refsection role="see also">
 
68
        <title>See Also</title>
 
69
        <simplelist type="inline">
 
70
            <member>
 
71
                <link linkend="horner">horner</link>
 
72
            </member>
 
73
            <member>
 
74
                <link linkend="poly">poly</link>
 
75
            </member>
 
76
        </simplelist>
 
77
    </refsection>
78
78
</refentry>