~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/eng/programming/poly.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>poly</TITLE>
 
6
  <TYPE>Scilab Function</TYPE>
 
7
  <DATE>April 1993</DATE>
 
8
  <SHORT_DESCRIPTION name="poly"> polynomial definition</SHORT_DESCRIPTION>
 
9
  <CALLING_SEQUENCE>
 
10
    <CALLING_SEQUENCE_ITEM>[p]=poly(a,&quot;x&quot;, [&quot;flag&quot;])  </CALLING_SEQUENCE_ITEM>
 
11
  </CALLING_SEQUENCE>
 
12
  <PARAM>
 
13
    <PARAM_INDENT>
 
14
      <PARAM_ITEM>
 
15
        <PARAM_NAME>a</PARAM_NAME>
 
16
        <PARAM_DESCRIPTION>
 
17
          <SP>: matrix or real number</SP>
 
18
        </PARAM_DESCRIPTION>
 
19
      </PARAM_ITEM>
 
20
      <PARAM_ITEM>
 
21
        <PARAM_NAME>x</PARAM_NAME>
 
22
        <PARAM_DESCRIPTION>
 
23
          <SP>: symbolic variable</SP>
 
24
        </PARAM_DESCRIPTION>
 
25
      </PARAM_ITEM>
 
26
      <PARAM_ITEM>
 
27
        <PARAM_NAME>&quot;flag&quot;  </PARAM_NAME>
 
28
        <PARAM_DESCRIPTION>
 
29
          <SP>: string (&quot;roots&quot;, &quot;coeff&quot;), default value is &quot;roots&quot;.</SP>
 
30
        </PARAM_DESCRIPTION>
 
31
      </PARAM_ITEM>
 
32
    </PARAM_INDENT>
 
33
  </PARAM>
 
34
  <DESCRIPTION>
 
35
    <P>
 
36
    If <VERB>a</VERB> is a matrix, <VERB>p</VERB> is the characteristic polynomial i.e.
 
37
     <VERB>determinant(x*eye()-a)</VERB>, <VERB>x</VERB> being the symbolic variable.</P>
 
38
    <P>
 
39
    If <VERB>v</VERB>  is a vector, <VERB>poly(v,&quot;x&quot;,[&quot;roots&quot;])</VERB>  is the polynomial
 
40
    with <VERB>roots</VERB> the entries of <VERB>v</VERB> and <VERB>&quot;x&quot;</VERB> as formal variable.
 
41
    (In this case,  <VERB>roots</VERB> and   <VERB>poly</VERB> are inverse functions).</P>
 
42
    <P><VERB>poly(v,&quot;x&quot;,&quot;coeff&quot;)</VERB> creates the polynomial with symbol <VERB>&quot;x&quot;</VERB>
 
43
    and with coefficients the entries of <VERB>v</VERB> (v(1) is the constant term of the polynomial). (Here <VERB>poly</VERB> and <VERB>coeff</VERB>
 
44
    are inverse functions).</P>
 
45
    <P><VERB>s=poly(0,&quot;s&quot;)</VERB> is the seed for defining polynomials with symbol
 
46
    <VERB>&quot;s&quot;</VERB>.</P>
 
47
  </DESCRIPTION>
 
48
  <EXAMPLE>
 
49
<![CDATA[
 
50
s=poly(0,"s");p=1+s+2*s^2;
 
51
A=rand(2,2);poly(A,"x")
 
52
 ]]>
 
53
  </EXAMPLE>
 
54
  <SEE_ALSO>
 
55
    <SEE_ALSO_ITEM>
 
56
      <LINK>coeff</LINK>
 
57
    </SEE_ALSO_ITEM>
 
58
    <SEE_ALSO_ITEM>
 
59
      <LINK>matrices</LINK>
 
60
    </SEE_ALSO_ITEM>
 
61
    <SEE_ALSO_ITEM>
 
62
      <LINK>rational</LINK>
 
63
    </SEE_ALSO_ITEM>
 
64
  </SEE_ALSO>
 
65
</MAN>