Bug Fix #14415 - Corrected some spellings error in help pages
[scilab.git] / scilab / modules / optimization / help / en_US / semidefprog / vec2list.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="vec2list" xml:lang="en">
3     <refnamediv>
4         <refname>vec2list</refname>
5         <refpurpose>Inverse function of list2vec.</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Syntax</title>
9         <synopsis>li=vec2list(bigVector,varsizes,ind)</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>bigVector</term>
16                 <listitem>
17                     <para>An m by n matrix. Each column is used to generate the
18                         corresponding list entry.
19                     </para>
20                 </listitem>
21             </varlistentry>
22             <varlistentry>
23                 <term>varsizes</term>
24                 <listitem>
25                     <para>An n by 2 matrix. Each row give the dimensions of the
26                         matrix to be built with the corresponding column of
27                         bigVector.
28                     </para>
29                 </listitem>
30             </varlistentry>
31             <varlistentry>
32                 <term>ind</term>
33                 <listitem>
34                     <para>a list with n entries. Each entry is a vector of
35                         positive integers which gives the hierarchical path where the
36                         corresponding matrix has to be put.
37                     </para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>li</term>
42                 <listitem>
43                     <para>a list or a recursive list with n leaves. The list
44                         entries (or leaves) are 2D matrices built with the
45                         corresponding column of bigVector and size given by the
46                         corresponding row of varsizes.
47                     </para>
48                 </listitem>
49             </varlistentry>
50         </variablelist>
51     </refsection>
52     <refsection>
53         <title>Description</title>
54         <para>If the ind argument is not given, this function creates a
55             list.  The list entries (or leaves) are 2D matrices built with the
56             corresponding column of bigVector and size given by the
57             corresponding row of varsizes.
58         </para>
59         <para>If the ind argument is given, this function creates a
60             hierachical list with n leaves. The leaves are 2D matrices built
61             with the corresponding column of bigVector and size given by the
62             corresponding row of varsizes. The hierachical path for each leaf
63             if given by the corresponding entry of ind.
64         </para>
65         <para>
66             This function is a subsidiary for <link linkend="lmisolver">lmisolver</link>
67         </para>
68     </refsection>
69     <refsection>
70         <title>Examples</title>
71         <programlisting role="example"><![CDATA[
72 vec2list(1:4,ones(4,2))
73 vec2list(1:4,[2 1;1 2])
74 vec2list(1:4,ones(4,2),list(1,2,[3,1],[3,2,1]))
75  ]]></programlisting>
76     </refsection>
77     <refsection role="see also">
78         <title>See Also</title>
79         <simplelist type="inline">
80             <member>
81                 <link linkend="list2vec">list2vec</link>
82             </member>
83         </simplelist>
84     </refsection>
85 </refentry>