Deleted vectorized computation feature. Deleted neldermead_contour. Fixed the demos.
[scilab.git] / scilab / modules / optimization / help / en_US / aplat.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!--
3  * Ajouter ici d'√©ventuels commentaires sur le fichier XML
4 -->
5 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="aplat">
6   <info>
7     <pubdate>$LastChangedDate: 22-07-2009 $</pubdate>
8   </info>
9   <refnamediv>
10     <refname>aplat</refname>
11     <refpurpose>Flattens a list. </refpurpose>
12   </refnamediv>
13   <refsynopsisdiv>
14     <title>Calling Sequence</title>
15     <synopsis>[lf,ind] = aplat(l,r)</synopsis>
16   </refsynopsisdiv>
17   <refsection>
18     <title>Parameters</title>
19     <variablelist>
20       <varlistentry>
21         <term>l</term>
22         <listitem>
23           <para>
24             a list
25           </para>
26         </listitem>
27       </varlistentry>
28       <varlistentry>
29         <term>r</term>
30         <listitem>
31           <para>
32             an optional flat list
33           </para>
34         </listitem>
35       </varlistentry>
36       <varlistentry>
37         <term>lf</term>
38         <listitem>
39           <para>
40             a flat list (a single hierachical level)
41           </para>
42         </listitem>
43       </varlistentry>
44       <varlistentry>
45         <term>ind</term>
46         <listitem>
47           <para>
48            a list, each entry give the path of the corresponding lf entry in the original list
49           </para>
50         </listitem>
51       </varlistentry>
52     </variablelist>
53   </refsection>
54   <refsection>
55     <title>Description</title>
56     <para>
57      Creates a flat list, built with the initial l list leaves and if given prepended by the r list entries
58     </para>
59   </refsection>
60   <refsection>
61     <title>Examples</title>
62     <programlisting role="example"><![CDATA[ 
63 [lf,ind]=aplat(list(1,2,list([3,1],'xxx',list([3,2,1]))))
64  ]]></programlisting>
65   </refsection>
66   <refsection>
67     <title>See Also</title>
68     <simplelist type="inline">
69       <member>
70         <link linkend="recons" >recons</link>
71       </member>
72     </simplelist>
73   </refsection>
74   <refsection>
75     <title>Authors</title>
76     <simplelist type="vert">
77       <member>F.D. and S.S., INRIA</member>
78     </simplelist>
79   </refsection>
80
81 </refentry>