* Bug #12882 fixed - Some help pages were not clear.
[scilab.git] / scilab / modules / core / help / en_US / 1_keywords / left.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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="left">
3     <refnamediv>
4         <refname>left</refname>
5         <refpurpose>([) left bracket</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>[a11,a12,...;a21,a22,...;...]
10             [s1,s2,...]=func(...)
11         </synopsis>
12     </refsynopsisdiv>
13     <refsection>
14         <title>Arguments</title>
15         <variablelist>
16             <varlistentry>
17                 <term>a11,a12,... </term>
18                 <listitem>
19                     <para>matrix of any compatible types with compatible dimensions</para>
20                 </listitem>
21                 <term>s1,s2,... </term>
22                 <listitem>
23                     <para>any possible variable name</para>
24                 </listitem>
25             </varlistentry>
26         </variablelist>
27     </refsection>
28     <refsection>
29         <title>Description</title>
30         <para>
31             Left and right brackets are used for vector and matrix concatenation.
32             These symbols are also used to denote a multiple left-hand-side for a function call
33         </para>
34         <para>
35             Inside concatenation brackets blank or comma characters mean "column concatenation",
36             semicolon and carriage-return mean "row concatenation".
37         </para>
38         <para>
39             <note>
40                 Note : to avoid confusions it is safer to use comma instead of blank to
41                 separate columns.
42             </note>
43         </para>
44         <para>
45             Within multiple lhs brackets variable names must be separated by comma.
46         </para>
47     </refsection>
48     <refsection>
49         <title>Examples</title>
50         <programlisting role="example"><![CDATA[
51 [6.9,9.64; sqrt(-1) 0]
52 [1 +%i  2 -%i  3]
53 []
54 ['this is';'a string';'vector']
55 s=poly(0,'s');[1/s,2/s]
56 [tf2ss(1/s),tf2ss(2/s)]
57
58 [u,s]=schur(rand(3,3))
59  ]]></programlisting>
60     </refsection>
61     <refsection role="see also">
62         <title>See Also</title>
63         <simplelist type="inline">
64             <member>
65                 <link linkend="comma">comma</link>
66             </member>
67             <member>
68                 <link linkend="semicolon">semicolon</link>
69             </member>
70         </simplelist>
71     </refsection>
72 </refentry>