Revision of help page for contour2di function (en_US).
[scilab.git] / scilab / modules / graphics / help / en_US / 2d_plot / contour2di.xml
index e407868..047aab6 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>[xc,yc]=contour2di(x,y,z,nz)</synopsis>
+        <synopsis>[xc, yc] = contour2di(x, y, z, nz)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>x,y</term>
+                <term>x, y</term>
                 <listitem>
-                    <para>two real row vectors of size n1 and n2: the grid.</para>
+                    <para>
+                        two real row vectors of size <literal>n1</literal> and <literal>n2</literal>: the grid.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>z</term>
                 <listitem>
-                    <para>real matrix of size (n1,n2), the values of the function.</para>
+                    <para>
+                        a real matrix of size <literal>(n1,n2)</literal>, the
+                        values of the function.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>nz</term>
                 <listitem>
-                    <para>the level values or the number of levels.</para>
+                    <para>
+                        the level values or the number of levels.
+                    </para>
                     <variablelist>
                         <varlistentry>
-                            <term/>
+                            <term>
+                                If <literal>nz</literal> is an integer
+                            </term>
                             <listitem>
                                 <para>
-                                    If <literal>nz</literal> is an integer, its value gives the number of
-                                    level curves  equally spaced from zmin to zmax as follows:
+                                    its value gives the number of
+                                    level curves  equally spaced from <literal>zmin</literal> to <literal>zmax</literal> as follows:
                                 </para>
-                                <programlisting role=""><![CDATA[ 
+                                <programlisting role="no-scilab-exec"><![CDATA[ 
 z= zmin + (1:nz)*(zmax-zmin)/(nz+1)
  ]]></programlisting>
                                 <para>
-                                    Note that the <literal>zmin</literal> and <literal>zmax</literal> levels are not drawn  (generically they are reduced to points) but they can be added  with 
+                                    <note>
+                                    Note that the <literal>zmin</literal> and
+                                    <literal>zmax</literal> levels are not drawn
+                                    (generically they are reduced to points) but
+                                    they can be added  with
+                                    </note>
                                 </para>
-                                <programlisting role=""><![CDATA[ 
+                                <programlisting role="no-scilab-exec"><![CDATA[ 
 [im,jm] = find(z == zmin);     // or zmax 
 plot2d(x(im)',y(jm)',-9,"000")
  ]]></programlisting>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
-                            <term/>
+                            <term>
+                                If <literal>nz</literal> is a vector
+                            </term>
                             <listitem>
                                 <para>
-                                    If <literal>nz</literal> is a vector, <literal>nz(i)</literal> gives the value of the ith level curve.
+                                    <literal>nz(i)</literal> gives the value of
+                                    the <literal>i</literal>-th level curve.
                                 </para>
                             </listitem>
                         </varlistentry>
@@ -70,9 +87,11 @@ plot2d(x(im)',y(jm)',-9,"000")
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xc,yc</term>
+                <term>xc, yc</term>
                 <listitem>
-                    <para>vectors of identical sizes containing the contours definitions. See below for details.</para>
+                    <para>
+                        vectors of identical sizes containing the contours definitions. See below for details.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -80,16 +99,19 @@ plot2d(x(im)',y(jm)',-9,"000")
     <refsection>
         <title>Description</title>
         <para>
-            <literal>contour2di</literal> computes level curves of a surface <literal>z=f(x,y)</literal> on
-            a 2D plot.  The values of <literal>f(x,y)</literal> are given by the matrix <literal>z</literal>
-            at the grid points defined by <literal>x</literal> and <literal>y</literal>.
+            <function>contour2di</function> computes level curves of a surface
+            <literal>z = f(x, y)</literal> on a 2D plot.  The values of
+            <literal>f(x,y)</literal> are given by the matrix <varname>z</varname>
+            at the grid points defined by <varname>x</varname> and <varname>y</varname>.
         </para>
         <para>
-            <literal>xc(1)</literal> contains the level associated with first contour path,
-            <literal>yc(1)</literal> contains the number <literal>N1</literal> of points defining this contour path
-            and (<literal>xc(1+(1:N1))</literal>, <literal>yc(1+(1:N1))</literal> ) contain the coordinates
-            of the paths points.
-            The second path begin at <literal>xc(2+N1)</literal> and <literal>yc(2+N1)</literal> and so on.
+            <literal>xc(1)</literal> contains the level associated with first
+            contour path, <literal>yc(1)</literal> contains the number
+            <literal>N1</literal> of points defining this contour path and
+            (<literal>xc(1+(1:N1))</literal>, <literal>yc(1+(1:N1))</literal> )
+            contain the coordinates of the paths points. The second path begin
+            at <literal>xc(2+N1)</literal> and <literal>yc(2+N1)</literal> and
+            so on.
         </para>
     </refsection>
     <refsection>
@@ -112,20 +134,11 @@ end
                 <link linkend="contour">contour</link>
             </member>
             <member>
-                <link linkend="fcontour">fcontour</link>
-            </member>
-            <member>
-                <link linkend="fcontour2d">fcontour2d</link>
-            </member>
-            <member>
                 <link linkend="contour2d">contour2d</link>
             </member>
             <member>
                 <link linkend="plot2d">plot2d</link>
             </member>
-            <member>
-                <link linkend="xset">xset</link>
-            </member>
         </simplelist>
     </refsection>
 </refentry>