← 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/inttrap.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/inttrap.xml
11
11
 *
12
12
 -->
13
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: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="inttrap" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>inttrap</refname>
16
 
    <refpurpose>integration of experimental data by trapezoidal
17
 
      interpolation
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsynopsisdiv>
21
 
    <title>Calling Sequence</title>
22
 
    <synopsis>v = inttrap([x,] s)</synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>x</term>
29
 
        <listitem>
30
 
          <para>vector of increasing x coordinate data. Default value is
31
 
            <literal>1:size(s,'*')</literal>
32
 
          </para>
33
 
        </listitem>
34
 
      </varlistentry>
35
 
      <varlistentry>
36
 
        <term>s</term>
37
 
        <listitem>
38
 
          <para>vector of y coordinate data</para>
39
 
        </listitem>
40
 
      </varlistentry>
41
 
      <varlistentry>
42
 
        <term>v</term>
43
 
        <listitem>
44
 
          <para>value of the integral</para>
45
 
        </listitem>
46
 
      </varlistentry>
47
 
    </variablelist>
48
 
  </refsection>
49
 
  <refsection>
50
 
    <title>Description</title>
51
 
    <para>Computes:</para>
52
 
    <para>
53
 
      <literal>s(i)=f(x(i))</literal> and <literal>x0=x(1)</literal>,
54
 
      <literal>x1=x(n)</literal>
55
 
    </para>
56
 
    <para>
57
 
      where <literal>f</literal> is a function described by a set of experimental values.
58
 
    </para>
59
 
    <para>Between mesh points function is interpolated linearly.</para>
60
 
  </refsection>
61
 
  <refsection>
62
 
    <title>Examples</title>
63
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>inttrap</refname>
 
16
        <refpurpose>integration of experimental data by trapezoidal
 
17
            interpolation
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsynopsisdiv>
 
21
        <title>Calling Sequence</title>
 
22
        <synopsis>v = inttrap([x,] s)</synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>x</term>
 
29
                <listitem>
 
30
                    <para>vector of increasing x coordinate data. Default value is
 
31
                        <literal>1:size(s,'*')</literal>
 
32
                    </para>
 
33
                </listitem>
 
34
            </varlistentry>
 
35
            <varlistentry>
 
36
                <term>s</term>
 
37
                <listitem>
 
38
                    <para>vector of y coordinate data</para>
 
39
                </listitem>
 
40
            </varlistentry>
 
41
            <varlistentry>
 
42
                <term>v</term>
 
43
                <listitem>
 
44
                    <para>value of the integral</para>
 
45
                </listitem>
 
46
            </varlistentry>
 
47
        </variablelist>
 
48
    </refsection>
 
49
    <refsection>
 
50
        <title>Description</title>
 
51
        <para>Computes:</para>
 
52
        <para>
 
53
            <literal>s(i)=f(x(i))</literal> and <literal>x0=x(1)</literal>,
 
54
            <literal>x1=x(n)</literal>
 
55
        </para>
 
56
        <para>
 
57
            where <literal>f</literal> is a function described by a set of experimental values.
 
58
        </para>
 
59
        <para>Between mesh points function is interpolated linearly.</para>
 
60
    </refsection>
 
61
    <refsection>
 
62
        <title>Examples</title>
 
63
        <programlisting role="example"><![CDATA[ 
64
64
t=0:0.1:%pi
65
65
inttrap(t,sin(t))
66
66
 ]]></programlisting>
67
 
  </refsection>
68
 
  <refsection role="see also">
69
 
    <title>See Also</title>
70
 
    <simplelist type="inline">
71
 
      <member>
72
 
        <link linkend="intg">intg</link>
73
 
      </member>
74
 
      <member>
75
 
        <link linkend="intc">intc</link>
76
 
      </member>
77
 
      <member>
78
 
        <link linkend="intl">intl</link>
79
 
      </member>
80
 
      <member>
81
 
        <link linkend="integrate">integrate</link>
82
 
      </member>
83
 
      <member>
84
 
        <link linkend="intsplin">intsplin</link>
85
 
      </member>
86
 
      <member>
87
 
        <link linkend="splin">splin</link>
88
 
      </member>
89
 
    </simplelist>
90
 
  </refsection>
 
67
    </refsection>
 
68
    <refsection role="see also">
 
69
        <title>See Also</title>
 
70
        <simplelist type="inline">
 
71
            <member>
 
72
                <link linkend="intg">intg</link>
 
73
            </member>
 
74
            <member>
 
75
                <link linkend="intc">intc</link>
 
76
            </member>
 
77
            <member>
 
78
                <link linkend="intl">intl</link>
 
79
            </member>
 
80
            <member>
 
81
                <link linkend="integrate">integrate</link>
 
82
            </member>
 
83
            <member>
 
84
                <link linkend="intsplin">intsplin</link>
 
85
            </member>
 
86
            <member>
 
87
                <link linkend="splin">splin</link>
 
88
            </member>
 
89
        </simplelist>
 
90
    </refsection>
91
91
</refentry>