summaryrefslogtreecommitdiffstats
path: root/scilab/modules/graphics/help/en_US/2d_plot/paramfplot2d.xml
blob: 56b8142695abed515da0e0efe628a658b71e4fb8 (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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 *
 -->
<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="paramfplot2d">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>
  <refnamediv>
    <refname>paramfplot2d</refname>
    <refpurpose> animated plot of a 2D parametrized curve.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>paramfplot2d(f,x,theta)
paramfplot2d(f,x,theta,flag)
paramfplot2d(f,x,theta,flag,rect)</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Arguments</title>
    <variablelist>
      <varlistentry>
        <term>x</term>
        <listitem>
          <para>real vector.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>f</term>
        <listitem>
          <para>function <literal>y=f(x,t)</literal> . f is a Scilab function or a dynamically linked routine (referred to as a string).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>theta</term>
        <listitem>
          <para>real vector (set of parameters).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>flag</term>
        <listitem>
          <para>string <literal>'no'</literal> or <literal>'yes'</literal>: If "yes" screen is not cleared  between two consecutive plots.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>rect</term>
        <listitem>
          <para>"rectangle" [xmin, xmax, ymin, ymax] (1 x 4 real vector),</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Description</title>
    <para>
    Animated plot of the function <literal>x</literal>,
    <literal>t</literal>--&gt;<literal>f(x,t)</literal> for
    <literal>t=theta(1),theta(2),etc</literal>.  <literal>f</literal>
    can be a either Scilab function or a dynamically linked routine
    since <literal>y=f(x,t)</literal> is evaluated as
    <literal>y=feval(x(:),t,f)</literal>. See <link
    linkend="feval">feval</link>.
  </para>
  <para>
    <literal>f</literal> is a mapping <literal>x</literal>,
    <literal>t</literal>--&gt; <literal>f(x,t) = R^N</literal> valued
    function for <literal>x</literal> a vector of
    <literal>R^N</literal> and <literal>t</literal> a real number.
  </para>
  </refsection>
  <refsection>
    <title>Examples</title>
    <programlisting role="example"><![CDATA[ 
deff('y=f(x,t)','y=t*sin(x)')
x=linspace(0,2*%pi,50);theta=0:0.05:1;
clf;paramfplot2d(f,x,theta);
 ]]></programlisting>
    <programlisting role="example"><![CDATA[ 
function V=twosoliton(x,t)
  a1=6;s1=2;v1=a1^2;
  a2=4;s2=40;v2=a2^2;
  
  f1=exp(-a1*(x-s1-v1*t));
  f2=exp(-a2*(x-s2-v2*t));
  r=((a2-1)/(a2+a1))^2;
  V=2*(v1*f1+v2*f2+2*(a2-a1)^2*f1.*f2+r*(v2*(f1^2).*f2+v1*f1.*(f2^2)))./((1+f1+f2+r*f1.*f2)^2);
endfunction
x=linspace(1,100,3000);
clf;paramfplot2d(twosoliton,x,0:0.05:3);
 ]]></programlisting>
  </refsection>
  <refsection role="see also">
<title>See Also</title>
    <simplelist type="inline">
     <member>
        <link linkend="comet">comet</link>
      </member>

      <member>
        <link linkend="plot2d">plot2d</link>
      </member>
      <member>
        <link linkend="feval">feval</link>
      </member>
      <member>
        <link linkend="fplot2d">fplot2d</link>
      </member>
    </simplelist>
  </refsection>
</refentry>