f79e766d0a655e15a733ff517c4193b22c547bb6
[scilab.git] / scilab / modules / elementary_functions / help / en_US / elementarymatrices / ndgrid.xml
1 <?xml version="1.0" encoding="UTF-8"?>
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="ndgrid" xml:lang="en">
3   <info>
4     <pubdate>$LastChangedDate$</pubdate>
5   </info>
6   <refnamediv>
7     <refname>ndgrid</refname>
8     <refpurpose>arrays for multidimensional function evaluation on
9     grid</refpurpose>
10   </refnamediv>
11   <refsynopsisdiv>
12     <title>Calling Sequence</title>
13     <synopsis>[X, Y] = ndgrid(x,y)
14 [X, Y, Z] = ndgrid(x,y,z)
15 [X, Y, Z, T] = ndgrid(x,y,z,t)
16 [X1, X2, ..., Xm] = ndgrid(x1,x2,...,xm)</synopsis>
17   </refsynopsisdiv>
18   <refsection>
19     <title>Arguments</title>
20     <variablelist>
21       <varlistentry>
22         <term>x, y, z, ...</term>
23         <listitem>
24           <para>vectors</para>
25         </listitem>
26       </varlistentry>
27       <varlistentry>
28         <term>X, Y, Z, ...</term>
29         <listitem>
30           <para>matrices in case of 2 input arguments, or else
31           hypermatrices</para>
32         </listitem>
33       </varlistentry>
34     </variablelist>
35   </refsection>
36   <refsection>
37     <title>Description</title>
38     <para>This is an utility routine useful to create arrays for function
39     evaluation on 2, 3, ..., n dimensional grids. For instance in 2d, a grid
40     is defined by two vectors, <literal>x</literal> and <literal> y</literal>
41     of length nx and ny, and you want to evaluate a function (says
42     <emphasis>f</emphasis>) on all the grid points, that is on all the points
43     of coordinates <emphasis>(x(i),y(j))</emphasis> with
44     <emphasis>i=1,..,nx</emphasis> and <emphasis>j=1,..,ny</emphasis>. In this
45     case, this function can compute the two matrices <literal>X,Y</literal> of
46     size <emphasis>nx x ny</emphasis> such that :</para>
47     <programlisting><![CDATA[ 
48 X(i,j) = x(i)   for all i in [1,nx]
49 Y(i,j) = y(j)       and j in [1,ny]
50  ]]></programlisting>
51     <para>and the evaluation may be done with <literal>Z=f(X,Y)</literal> (at
52     the condition that you have coded <literal>f</literal> for evaluation on
53     vector arguments, which is done (in general) by using the element-wise
54     operators <literal>.*</literal>, <literal>./</literal> and
55     <literal>.^</literal> in place of <literal>*</literal>,
56     <literal>/</literal> and <literal>^</literal>).</para>
57     <para>In the 3d case, considering 3 vectors <literal>x,y,z</literal> of
58     length nx, ny and nz, <literal>X,Y,Z</literal> are 3 hypermatrices of size
59     <emphasis>nx x ny x nz</emphasis> such that :</para>
60     <programlisting><![CDATA[ 
61 X(i,j,k) = x(i)  
62 Y(i,j,k) = y(j)   for all (i,j,k) in [1,nx]x[1,ny]x[1,nz]
63 Z(i,j,k) = z(k)
64  ]]></programlisting>
65     <para>In the general case of m input arguments <literal>x1, x2, ..,
66     xm</literal>, then the m output arguments <literal>X1, X2, ..,
67     Xm</literal> are hypermatrices of size <emphasis>nx1 x nx2 x ... x
68     nxm</emphasis> and :</para>
69     <programlisting><![CDATA[ 
70 Xj(i1,i2,...,ij,...,im) = xj(ij)   
71 for all (i1,i2,...,im) in [1,nx1]x[1,nx2]x...x[1,nxm]  
72  ]]></programlisting>
73   </refsection>
74   <refsection>
75     <title>Examples</title>
76     <programlisting role="example"><![CDATA[  
77 // create a simple 2d grid
78 nx = 40; ny = 40;
79 x = linspace(-1,1,nx);
80 y = linspace(-1,1,ny);
81 [X,Y] = ndgrid(x,y);
82
83 // compute a function on the grid and plot it
84 //deff("z=f(x,y)","z=128*x.^2 .*(1-x).^2 .*y.^2 .*(1-y).^2");
85 deff("z=f(x,y)","z=x.^2 + y.^3")
86 Z = f(X,Y);
87 clf()
88 plot3d(x,y,Z, flag=[2 6 4]); show_window()
89
90 // create a simple 3d grid
91 nx = 10; ny = 6; nz = 4;
92 x = linspace(0,2,nx);
93 y = linspace(0,1,ny);
94 z = linspace(0,0.5,nz);
95 [X,Y,Z] = ndgrid(x,y,z);
96
97 // try to display this 3d grid ...
98 XF=[]; YF=[]; ZF=[];
99
100 for k=1:nz
101    [xf,yf,zf] = nf3d(X(:,:,k),Y(:,:,k),Z(:,:,k));
102    XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf];
103 end
104
105 for j=1:ny
106    [xf,yf,zf] = nf3d(matrix(X(:,j,:),[nx,nz]),...
107                      matrix(Y(:,j,:),[nx,nz]),...
108                      matrix(Z(:,j,:),[nx,nz]));
109    XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf];
110 end
111
112 clf()
113 plot3d(XF,YF,ZF, flag=[0 6 3], leg="X@Y@Z")
114 xtitle("A 3d grid !"); show_window()
115  ]]></programlisting>
116   </refsection>
117   <refsection role="see also">
118     <title>See Also</title>
119     <simplelist type="inline">
120       <member>
121         <link linkend="kron">kron</link>
122       </member>
123     </simplelist>
124   </refsection>
125   <refsection>
126     <title>Authors</title>
127     <para>B. Pincon</para>
128   </refsection>
129 </refentry>