Deleted vectorized computation feature. Deleted neldermead_contour. Fixed the demos.
[scilab.git] / scilab / modules / optimization / help / en_US / list2vec.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Ajouter ici d'√©ventuels commentaires sur le fichier XML
4 -->
5 <refentry version="5.0-subset Scilab" xml:id="list2vec" xml:lang="en"
6           xmlns="http://docbook.org/ns/docbook"
7           xmlns:xlink="http://www.w3.org/1999/xlink"
8           xmlns:svg="http://www.w3.org/2000/svg"
9           xmlns:ns3="http://www.w3.org/1999/xhtml"
10           xmlns:mml="http://www.w3.org/1998/Math/MathML"
11           xmlns:db="http://docbook.org/ns/docbook">
12   <info>
13     <pubdate>$LastChangedDate: 22-07-2009 $</pubdate>
14   </info>
15
16   <refnamediv>
17     <refname>list2vec</refname>
18
19     <refpurpose>Catenates list entries in a matrix.</refpurpose>
20   </refnamediv>
21
22   <refsynopsisdiv>
23     <title>Calling Sequence</title>
24
25     <synopsis>[bigVector,varsizes] = list2vec(li)</synopsis>
26   </refsynopsisdiv>
27
28   <refsection>
29     <title>Parameters</title>
30
31     <variablelist>
32       <varlistentry>
33         <term>li</term>
34
35         <listitem>
36           <para>a list with n entries. The list entries must be 2D matrices with comptible
37           types.</para>
38         </listitem>
39       </varlistentry>
40
41       <varlistentry>
42         <term>bigVector</term>
43
44         <listitem>
45           <para>A column vector. Formed by the elements of the
46           corresponding list entry.</para>
47         </listitem>
48       </varlistentry>
49
50       <varlistentry>
51         <term>varsizes</term>
52
53         <listitem>
54           <para>An n by 3 matrix. Each row contains the dimensions of the
55           corresponding list entry.</para>
56         </listitem>
57       </varlistentry>
58     </variablelist>
59   </refsection>
60
61   <refsection>
62     <title>Description</title>
63
64     <para>Catenates list entries in a column vector. The list entries are supposed to
65     be matrices with compatible types with respect to catenation.</para>
66 <para>This function is a subsidiary for <link
67     linkend="lmisolver">lmisolver</link></para>
68   </refsection>
69
70   <refsection>
71     <title>Examples</title>
72
73     <programlisting role="example"><![CDATA[ 
74 list2vec(list(1,2,3))
75 list2vec(list([1 2 3],[4;5],[%s %s+1]))
76  ]]></programlisting>
77   </refsection>
78
79   <refsection>
80     <title>See Also</title>
81
82     <simplelist type="inline">
83       <member><link linkend="vec2list">vec2list</link></member>
84     </simplelist>
85   </refsection>
86
87   <refsection>
88     <title>Authors</title>
89
90     <simplelist type="vert">
91       <member>F.D. INRIA</member>
92     </simplelist>
93   </refsection>
94 </refentry>