bug 4601 fix
[scilab.git] / scilab / modules / optimization / help / en_US / vec2list.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="vec2list" 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>vec2list</refname>
18
19     <refpurpose>list2vec reciprocal function</refpurpose>
20   </refnamediv>
21
22   <refsynopsisdiv>
23     <title>Calling Sequence</title>
24
25     <synopsis>li=vec2list(bigVector,varsizes,ind)</synopsis>
26   </refsynopsisdiv>
27
28   <refsection>
29     <title>Parameters</title>
30
31     <variablelist>
32      
33       <varlistentry>
34         <term>bigVector</term>
35
36         <listitem>
37           <para>An m by n matrix. Each column is used to generate the
38           corresponding list entry.</para>
39         </listitem>
40       </varlistentry>
41
42       <varlistentry>
43         <term>varsizes</term>
44
45         <listitem>
46           <para>An n by 2 matrix. Each row give the dimensions of the
47           matrix to be built with the correponding column of
48           bigVector.</para>
49         </listitem>
50       </varlistentry>
51       <varlistentry>
52         <term>ind</term>
53
54         <listitem>
55           <para>a list with n entries. Each entry is a vector of
56           positive integers which gives the hierchical path where the
57           corresponding matrix has to be put.</para>
58         </listitem>
59       </varlistentry>
60
61       <varlistentry>
62         <term>li</term>
63
64         <listitem>
65           <para>a list or a recursive list with n leaves. The list
66           entries (or leaves) are 2D matrices built with the
67           corresponding column of bigVector and size given by the
68           corresponding row of varsizes.</para>
69         </listitem>
70       </varlistentry>
71
72     </variablelist>
73   </refsection>
74
75   <refsection>
76     <title>Description</title>
77     <para>If the ind argument is not given, this function creates a
78     list.  The list entries (or leaves) are 2D matrices built with the
79     corresponding column of bigVector and size given by the
80     corresponding row of varsizes.</para>
81
82     <para>If the ind argument is given, this function creates a
83     hierachical list with n leaves. The leaves are 2D matrices built
84     with the corresponding column of bigVector and size given by the
85     corresponding row of varsizes. The hierachical path for each leaf
86     if given by the corresponding entry of ind.</para>
87     <para>This function is a subsidiary for <link
88     linkend="lmisolver">lmisolver</link></para>
89   </refsection>
90
91   <refsection>
92     <title>Examples</title>
93
94     <programlisting role="example">
95         vec2list(1:4,ones(4,2))
96         vec2list(1:4,[2 1;1 2])
97         vec2list(1:4,ones(4,2),list(1,2,[3,1],[3,2,1]))
98     </programlisting>
99   </refsection>
100
101   <refsection>
102     <title>See Also</title>
103
104     <simplelist type="inline">
105       <member><link linkend="list2vec">list2vec</link></member>
106     </simplelist>
107   </refsection>
108
109   <refsection>
110     <title>Authors</title>
111
112     <simplelist type="vert">
113       <member>F.D., INRIA</member>
114       <member>S.S., INRIA</member>
115     </simplelist>
116   </refsection>
117 </refentry>