← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/interpolation/help/en_US/bsplin3val.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/interpolation/help/en_US/bsplin3val.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<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="bsplin3val" xml:lang="en">
3
 
  <refnamediv>
4
 
    <refname>bsplin3val</refname>
5
 
    <refpurpose>3d spline arbitrary derivative evaluation
6
 
      function
7
 
    </refpurpose>
8
 
  </refnamediv>
9
 
  <refsynopsisdiv>
10
 
    <title>Calling Sequence</title>
11
 
    <synopsis>[dfp]=bsplin3val(xp,yp,zp,tl,der)</synopsis>
12
 
  </refsynopsisdiv>
13
 
  <refsection>
14
 
    <title>Arguments</title>
15
 
    <variablelist>
16
 
      <varlistentry>
17
 
        <term>xp, yp, zp</term>
18
 
        <listitem>
19
 
          <para>real vectors or matrices of same size</para>
20
 
        </listitem>
21
 
      </varlistentry>
22
 
      <varlistentry>
23
 
        <term>tl</term>
24
 
        <listitem>
25
 
          <para>tlist of type "splin3d", defining a 3d tensor spline (called
26
 
            <literal>s</literal> in the following)
27
 
          </para>
28
 
        </listitem>
29
 
      </varlistentry>
30
 
      <varlistentry>
31
 
        <term>der</term>
32
 
        <listitem>
33
 
          <para>
34
 
            vector with 3 components <literal>[ox,oy,oz]</literal>
35
 
            defining which derivative of <literal>s</literal> to compute.
36
 
          </para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
      <varlistentry>
40
 
        <term>dfp</term>
41
 
        <listitem>
42
 
          <para>
43
 
            vector or matrix of same format than <literal>xp</literal>,
44
 
            <literal>yp</literal> and <literal>zp</literal>, elementwise
45
 
            evaluation of the specified derivative of <literal>s</literal> on
46
 
            these points.
47
 
          </para>
48
 
        </listitem>
49
 
      </varlistentry>
50
 
    </variablelist>
51
 
  </refsection>
52
 
  <refsection>
53
 
    <title>Description</title>
54
 
    <para>
55
 
      While the function <link linkend="interp3d">interp3d</link> may
56
 
      compute only the spline <literal>s</literal> and its first derivatives,
57
 
      <literal>bsplin3val</literal> may compute any derivative of
58
 
      <literal>s</literal>. The derivative to compute is specified by the
59
 
      argument <literal>der=[ox,oy,oz]</literal> :
60
 
    </para>
61
 
    <informalequation>
62
 
      <mediaobject>
63
 
        <imageobject>
64
 
          <imagedata align="center" fileref="../mml/bsplin3val_equation1.mml"/>
65
 
        </imageobject>
66
 
      </mediaobject>
67
 
    </informalequation>
68
 
    <para>
69
 
      So <literal>der=[0 0 0]</literal> corresponds to
70
 
      <emphasis>s</emphasis>, <literal>der=[1 0 0]</literal> to
71
 
      <emphasis>ds/dx</emphasis>, <literal>der=[0 1 0]</literal> to
72
 
      <emphasis>ds/dy</emphasis>, <literal>der=[1 1 0]</literal> to
73
 
      <emphasis>d2s/dxdy</emphasis>, etc...
74
 
    </para>
75
 
    <para>For a point with coordinates
76
 
      <emphasis>(xp(i),yp(i),zp(i))</emphasis> outside the grid, the function
77
 
      returns 0.
78
 
    </para>
79
 
  </refsection>
80
 
  <refsection>
81
 
    <title>Examples</title>
82
 
    <programlisting role="example"><![CDATA[ 
 
3
    <refnamediv>
 
4
        <refname>bsplin3val</refname>
 
5
        <refpurpose>3d spline arbitrary derivative evaluation
 
6
            function
 
7
        </refpurpose>
 
8
    </refnamediv>
 
9
    <refsynopsisdiv>
 
10
        <title>Calling Sequence</title>
 
11
        <synopsis>[dfp]=bsplin3val(xp,yp,zp,tl,der)</synopsis>
 
12
    </refsynopsisdiv>
 
13
    <refsection>
 
14
        <title>Arguments</title>
 
15
        <variablelist>
 
16
            <varlistentry>
 
17
                <term>xp, yp, zp</term>
 
18
                <listitem>
 
19
                    <para>real vectors or matrices of same size</para>
 
20
                </listitem>
 
21
            </varlistentry>
 
22
            <varlistentry>
 
23
                <term>tl</term>
 
24
                <listitem>
 
25
                    <para>tlist of type "splin3d", defining a 3d tensor spline (called
 
26
                        <literal>s</literal> in the following)
 
27
                    </para>
 
28
                </listitem>
 
29
            </varlistentry>
 
30
            <varlistentry>
 
31
                <term>der</term>
 
32
                <listitem>
 
33
                    <para>
 
34
                        vector with 3 components <literal>[ox,oy,oz]</literal>
 
35
                        defining which derivative of <literal>s</literal> to compute.
 
36
                    </para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
            <varlistentry>
 
40
                <term>dfp</term>
 
41
                <listitem>
 
42
                    <para>
 
43
                        vector or matrix of same format than <literal>xp</literal>,
 
44
                        <literal>yp</literal> and <literal>zp</literal>, elementwise
 
45
                        evaluation of the specified derivative of <literal>s</literal> on
 
46
                        these points.
 
47
                    </para>
 
48
                </listitem>
 
49
            </varlistentry>
 
50
        </variablelist>
 
51
    </refsection>
 
52
    <refsection>
 
53
        <title>Description</title>
 
54
        <para>
 
55
            While the function <link linkend="interp3d">interp3d</link> may
 
56
            compute only the spline <literal>s</literal> and its first derivatives,
 
57
            <literal>bsplin3val</literal> may compute any derivative of
 
58
            <literal>s</literal>. The derivative to compute is specified by the
 
59
            argument <literal>der=[ox,oy,oz]</literal> :
 
60
        </para>
 
61
        <informalequation>
 
62
            <mediaobject>
 
63
                <imageobject>
 
64
                    <imagedata align="center" fileref="../mml/bsplin3val_equation1.mml"/>
 
65
                </imageobject>
 
66
            </mediaobject>
 
67
        </informalequation>
 
68
        <para>
 
69
            So <literal>der=[0 0 0]</literal> corresponds to
 
70
            <emphasis>s</emphasis>, <literal>der=[1 0 0]</literal> to
 
71
            <emphasis>ds/dx</emphasis>, <literal>der=[0 1 0]</literal> to
 
72
            <emphasis>ds/dy</emphasis>, <literal>der=[1 1 0]</literal> to
 
73
            <emphasis>d2s/dxdy</emphasis>, etc...
 
74
        </para>
 
75
        <para>For a point with coordinates
 
76
            <emphasis>(xp(i),yp(i),zp(i))</emphasis> outside the grid, the function
 
77
            returns 0.
 
78
        </para>
 
79
    </refsection>
 
80
    <refsection>
 
81
        <title>Examples</title>
 
82
        <programlisting role="example"><![CDATA[ 
83
83
deff("v=f(x,y,z)","v=cos(x).*sin(y).*cos(z)");
84
84
deff("v=fx(x,y,z)","v=-sin(x).*sin(y).*cos(z)");
85
85
deff("v=fxy(x,y,z)","v=-sin(x).*cos(y).*cos(z)");
111
111
fxxyz_e = fxxyz(xp,yp,zp)
112
112
fxxyz_i = bsplin3val(xp,yp,zp,tl,[2 1 1])
113
113
 ]]></programlisting>
114
 
  </refsection>
115
 
  <refsection role="see also">
116
 
    <title>See Also</title>
117
 
    <simplelist type="inline">
118
 
      <member>
119
 
        <link linkend="splin3d">splin3d</link>
120
 
      </member>
121
 
      <member>
122
 
        <link linkend="interp3d">interp3d</link>
123
 
      </member>
124
 
    </simplelist>
125
 
  </refsection>
126
 
  <refsection>
127
 
    <title>History</title>
128
 
    <revhistory>
129
 
      <revision>
130
 
        <revnumber>5.4.0</revnumber>
131
 
        <revremark>previously, imaginary part of input arguments were implicitly ignored.</revremark>
132
 
      </revision>
133
 
    </revhistory>
134
 
  </refsection>
 
114
    </refsection>
 
115
    <refsection role="see also">
 
116
        <title>See Also</title>
 
117
        <simplelist type="inline">
 
118
            <member>
 
119
                <link linkend="splin3d">splin3d</link>
 
120
            </member>
 
121
            <member>
 
122
                <link linkend="interp3d">interp3d</link>
 
123
            </member>
 
124
        </simplelist>
 
125
    </refsection>
 
126
    <refsection>
 
127
        <title>History</title>
 
128
        <revhistory>
 
129
            <revision>
 
130
                <revnumber>5.4.0</revnumber>
 
131
                <revremark>previously, imaginary part of input arguments were implicitly ignored.</revremark>
 
132
            </revision>
 
133
        </revhistory>
 
134
    </refsection>
135
135
</refentry>