← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/differential_equations/help/en_US/ode_discrete.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/differential_equations/help/en_US/ode_discrete.xml
12
12
 *
13
13
 -->
14
14
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="ode_discrete" xml:lang="en">
15
 
  <refnamediv>
16
 
    <refname>ode_discrete</refname>
17
 
    <refpurpose>ordinary differential equation solver, discrete time
18
 
      simulation
19
 
    </refpurpose>
20
 
  </refnamediv>
21
 
  <refsynopsisdiv>
22
 
    <title>Calling Sequence</title>
23
 
    <synopsis>y=ode("discrete",y0,k0,kvect,f)</synopsis>
24
 
  </refsynopsisdiv>
25
 
  <refsection>
26
 
    <title>Arguments</title>
27
 
    <variablelist>
28
 
      <varlistentry>
29
 
        <term>y0</term>
30
 
        <listitem>
31
 
          <para>a real vector or matrix (initial conditions).</para>
32
 
        </listitem>
33
 
      </varlistentry>
34
 
      <varlistentry>
35
 
        <term>t0</term>
36
 
        <listitem>
37
 
          <para>a real scalar (initial time).</para>
38
 
        </listitem>
39
 
      </varlistentry>
40
 
      <varlistentry>
41
 
        <term>f</term>
42
 
        <listitem>
43
 
          <para>an external i.e. function or character string or list.</para>
44
 
        </listitem>
45
 
      </varlistentry>
46
 
      <varlistentry>
47
 
        <term>k0</term>
48
 
        <listitem>
49
 
          <para>an integer (initial time).</para>
50
 
        </listitem>
51
 
      </varlistentry>
52
 
      <varlistentry>
53
 
        <term>kvect</term>
54
 
        <listitem>
55
 
          <para>an integer vector.</para>
56
 
        </listitem>
57
 
      </varlistentry>
58
 
    </variablelist>
59
 
  </refsection>
60
 
  <refsection>
61
 
    <title>Description</title>
62
 
    <para>With this syntax (first argument equal to
63
 
      <literal>"discrete"</literal>) <literal>ode</literal> computes recursively
64
 
      <literal>y(k+1)=f(k,y(k))</literal> from an initial state
65
 
      <literal>y(k0)</literal> and returns <literal>y(k)</literal> for
66
 
      <literal>k</literal> in <literal>kvect</literal>.
67
 
      <literal>kvect(1)</literal> must be greater than or equal to
68
 
      <literal>k0</literal>.
69
 
    </para>
70
 
    <para>Other arguments and other options are the same as for
71
 
      <literal>ode</literal>, see the see <link linkend="ode">ode</link> help.
72
 
    </para>
73
 
  </refsection>
74
 
  <refsection>
75
 
    <title>Examples</title>
76
 
    <programlisting role="example"><![CDATA[ 
 
15
    <refnamediv>
 
16
        <refname>ode_discrete</refname>
 
17
        <refpurpose>ordinary differential equation solver, discrete time
 
18
            simulation
 
19
        </refpurpose>
 
20
    </refnamediv>
 
21
    <refsynopsisdiv>
 
22
        <title>Calling Sequence</title>
 
23
        <synopsis>y=ode("discrete",y0,k0,kvect,f)</synopsis>
 
24
    </refsynopsisdiv>
 
25
    <refsection>
 
26
        <title>Arguments</title>
 
27
        <variablelist>
 
28
            <varlistentry>
 
29
                <term>y0</term>
 
30
                <listitem>
 
31
                    <para>a real vector or matrix (initial conditions).</para>
 
32
                </listitem>
 
33
            </varlistentry>
 
34
            <varlistentry>
 
35
                <term>t0</term>
 
36
                <listitem>
 
37
                    <para>a real scalar (initial time).</para>
 
38
                </listitem>
 
39
            </varlistentry>
 
40
            <varlistentry>
 
41
                <term>f</term>
 
42
                <listitem>
 
43
                    <para>an external i.e. function or character string or list.</para>
 
44
                </listitem>
 
45
            </varlistentry>
 
46
            <varlistentry>
 
47
                <term>k0</term>
 
48
                <listitem>
 
49
                    <para>an integer (initial time).</para>
 
50
                </listitem>
 
51
            </varlistentry>
 
52
            <varlistentry>
 
53
                <term>kvect</term>
 
54
                <listitem>
 
55
                    <para>an integer vector.</para>
 
56
                </listitem>
 
57
            </varlistentry>
 
58
        </variablelist>
 
59
    </refsection>
 
60
    <refsection>
 
61
        <title>Description</title>
 
62
        <para>With this syntax (first argument equal to
 
63
            <literal>"discrete"</literal>) <literal>ode</literal> computes recursively
 
64
            <literal>y(k+1)=f(k,y(k))</literal> from an initial state
 
65
            <literal>y(k0)</literal> and returns <literal>y(k)</literal> for
 
66
            <literal>k</literal> in <literal>kvect</literal>.
 
67
            <literal>kvect(1)</literal> must be greater than or equal to
 
68
            <literal>k0</literal>.
 
69
        </para>
 
70
        <para>Other arguments and other options are the same as for
 
71
            <literal>ode</literal>, see the see <link linkend="ode">ode</link> help.
 
72
        </para>
 
73
    </refsection>
 
74
    <refsection>
 
75
        <title>Examples</title>
 
76
        <programlisting role="example"><![CDATA[ 
77
77
y1=[1;2;3]; deff("yp=a_function(k,y)","yp=A*y+B*u(k)")
78
78
A=diag([0.2,0.5,0.9]); B=[1;1;1];u=1:10;n=5;
79
79
y=ode("discrete",y1,1,1:n,a_function);
82
82
// Now y evaluates  at [y3,y5,y7,y9]
83
83
y=ode("discrete",y1,1,3:2:9,a_function)
84
84
 ]]></programlisting>
85
 
  </refsection>
86
 
  <refsection role="see also">
87
 
    <title>See Also</title>
88
 
    <simplelist type="inline">
89
 
      <member>
90
 
        <link linkend="ode">ode</link>
91
 
      </member>
92
 
    </simplelist>
93
 
  </refsection>
 
85
    </refsection>
 
86
    <refsection role="see also">
 
87
        <title>See Also</title>
 
88
        <simplelist type="inline">
 
89
            <member>
 
90
                <link linkend="ode">ode</link>
 
91
            </member>
 
92
        </simplelist>
 
93
    </refsection>
94
94
</refentry>