* Bug #8431: eval3d() set obsolete
[scilab.git] / scilab / modules / graphics / help / en_US / 3d_plot / eval3d.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA - Serge Steer
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="eval3d">
17     <refnamediv>
18         <refname>eval3d</refname>
19         <refpurpose>values of a function on a grid  => <emphasis role="bold">this function is obsolete</emphasis></refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>[z]=eval3d(fun,x,[y])</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>fun</term>
30                 <listitem>
31                     <para>function accepting vectors as arguments.</para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>x,y</term>
36                 <listitem>
37                     <para>
38                         2 vectors of size (1,n1) and (1,n2). (default value for <literal>y</literal> : <literal>y=x</literal>).
39                     </para>
40                 </listitem>
41             </varlistentry>
42             <varlistentry>
43                 <term>z</term>
44                 <listitem>
45                     <para>matrix of size (n1,n2).</para>
46                 </listitem>
47             </varlistentry>
48         </variablelist>
49     </refsection>
50     <refsection>
51         <title>Description</title>
52         <warning>
53             <emphasis role="bold">This function is obsolete</emphasis> and will be removed in Scilab 6.1.
54         </warning>
55         <para>If <literal>fun(x,y)</literal> can process <literal>x</literal>
56             and <literal>y</literal> matrices, please use the following replacements:
57             <itemizedlist>
58                 <listitem>
59                     <para>
60                         <emphasis role="bold">z = eval3d(fun,x)</emphasis> => <literal>X=ndgrid(x,x); z=fun(X,X')</literal>
61                     </para>
62                 </listitem>
63                 <listitem>
64                     <para>
65                         <emphasis role="bold">z = eval3d(fun,x,y)</emphasis> => <literal>[X,Y]=ndgrid(x,y); z=fun(X,Y)</literal>
66                     </para>
67                 </listitem>
68             </itemizedlist>
69         </para>
70         <para>
71             Otherwise, if <literal>fun(x,y)</literal> accepts only scalars
72             <literal>x</literal> and <literal>y</literal>, please use
73             <link linkend="feval">feval</link> as usual:
74             <literal>z=feval(x,fun)</literal> or <literal>z=feval(x,y,fun)</literal>.
75         </para>
76     </refsection>
77 </refentry>