summaryrefslogtreecommitdiff
path: root/help/en_US/polyscale.xml
blob: cc626631fd2a33623f9fefb30d7d00a4a9647bf7 (plain)
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
84
85
86
87
88
89
90
91
92
93
<?xml version="1.0" encoding="UTF-8"?>

<!--
 *
 * This help file was generated from polyscale.sci using help_from_sci().
 *
 -->

<refentry version="5.0-subset Scilab" xml:id="polyscale" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:scilab="http://www.scilab.org"
          xmlns:db="http://docbook.org/ns/docbook">

  <refnamediv>
    <refname>polyscale</refname>
    <refpurpose> scales the roots of a polynomial in the z plane</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
  b = polyscale(a,alpha)

   </synopsis>
</refsynopsisdiv>

<refsection>
<title>Description</title>
<para>
b = polyscale(a,alpha) scales the roots of a polynomial in the z-plane, where a is a vector containing the polynomial coefficients and alpha is the scaling factor.
</para>
<para>
If alpha is a real value in the range [0 1], then the roots of a are radially scaled toward the origin in the z-plane. Complex values for alpha allow arbitrary changes to the root locations.
</para>


</refsection>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>a:</term>
      <listitem><para> vector containing the polynomial coefficients</para></listitem></varlistentry>
   </variablelist>
<variablelist>
   <varlistentry><term>alpha:</term>
      <listitem><para> the scaling vector</para></listitem></varlistentry>
   </variablelist>
<variablelist>
<varlistentry><term>b:</term>
      <listitem><para>vector of scaled roots. </para></listitem></varlistentry>
   </variablelist>
</refsection>


<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
p=[1 0 0 0 0 0 0 -1]
b=polyscale(p,0.95)
//EXPECTED OUTPUT:b=1.    0.    0.    0.    0.    0.    0.  - 0.6983373


   ]]></programlisting>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
t
p=[1 0 0 0 0 0 0 -1]
b=polyscale(p,0.85)
//EXPECTED OUTPUT:b=1.    0.    0.    0.    0.    0.    0.  - 0.3205771


   ]]></programlisting>
</refsection>

<refsection>
<title>Author</title>
<simplelist type="vert">
   <member>Debdeep Dey</member>
   </simplelist>
</refsection>



</refentry>