bug 6394 fix + datatips custimization + revision of help pages
[scilab.git] / scilab / modules / cacsd / help / en_US / m_circle.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA - Serge Steer
5  *
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
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="m_circle">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>m_circle</refname>
19     <refpurpose> plots the complex plane iso-gain contours of y/(1+y) (obsolete) </refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>m_circle()
24 m_circle(gain)</synopsis>
25   </refsynopsisdiv>
26   <refsection>
27     <title>Parameters</title>
28     <variablelist>
29       <varlistentry>
30         <term>gain</term>
31         <listitem>
32           <para>vector of gains (in DB). The default value is</para>
33           <variablelist>
34             <varlistentry>
35               <term>gain</term>
36               <listitem>
37                 <para>=[-12 -8 -6 -5 -4 -3 -2 -1.4 -1 -.5 0.25 0.5 0.7 1 1.4 2 2.3 3 4 5 6 8 12]</para>
38               </listitem>
39             </varlistentry>
40           </variablelist>
41         </listitem>
42       </varlistentry>
43     </variablelist>
44   </refsection>
45   <refsection>
46     <title>Description</title>
47     <para><literal>m_circle</literal> draws the iso-gain contours
48     given by then <literal>gain</literal> argument in the complex
49     plane (Re,Im).</para>
50     <para>The default value for <literal>gain</literal> is:</para>
51     <para>
52     <literal>[-12 -8 -6 -5 -4 -3 -2 -1.4 -1 -.5 0.25 0.5 0.7 1 1.4 2 2.3 3 4 5 6 8 12]</literal>
53     </para>
54     <para><literal>m_circle</literal> is used with <literal>nyquist</literal>.</para>
55    <para>This function is superseeded by the <link linkend="hallchart">hallchart</link> function.</para>
56   </refsection>
57   <refsection>
58     <title>Examples</title>
59     <programlisting role="example"><![CDATA[
60 //Example 1 :
61 s=poly(0,'s')
62 h=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
63 nyquist(h,0.01,100,'(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01)')
64 m_circle();
65 //Example 2:
66 clf();
67 h1=h*syslin('c',(s^2+2*0.1*15.1*s+228.01)/(s^2+2*0.9*15*s+225))
68 nyquist([h1;h],0.01,100,['h1';'h'])
69 m_circle([-8 -6 -4]);
70 ]]></programlisting>
71   </refsection>
72   <refsection>
73     <title>See Also</title>
74     <simplelist type="inline">
75       <member>
76         <link linkend="nyquist">nyquist</link>
77       </member>
78       <member>
79         <link linkend="chart">chart</link>
80       </member>
81       <member>
82         <link linkend="black">black</link>
83       </member>
84     </simplelist>
85   </refsection>
86   <refsection>
87     <title>Authors</title>
88     <para>S.Steer.;   </para>
89   </refsection>
90 </refentry>