Revision of English help pages for different functions (nothing serious).
[scilab.git] / scilab / modules / elementary_functions / help / en_US / elementarymatrices / linspace.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - INRIA
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="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="linspace" xml:lang="en">
14     <refnamediv>
15         <refname>linspace</refname>
16         <refpurpose>linearly spaced vector</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>[v]=linspace(x1,x2 [,n])</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>x1,x2</term>
27                 <listitem>
28                     <para>real or complex scalars or column vectors</para>
29                 </listitem>
30             </varlistentry>
31             <varlistentry>
32                 <term>n</term>
33                 <listitem>
34                     <para>integer: number of requested values. It must be greater or equal to 2 (default value = 100)</para>
35                 </listitem>
36             </varlistentry>
37             <varlistentry>
38                 <term>v</term>
39                 <listitem>
40                     <para>real or complex row vector</para>
41                 </listitem>
42             </varlistentry>
43         </variablelist>
44     </refsection>
45     <refsection>
46         <title>Description</title>
47         <para>
48             Linearly spaced vector. <literal>linspace(x1, x2)</literal>
49             generates a row vector of n (default value=100) linearly equally spaced
50             points between <literal>x1</literal> and <literal>x2</literal>. If
51             <literal>x1</literal> or <literal>x2</literal> are complex then
52             <literal>linspace(x1,x2)</literal> returns a row vector of n complexes,
53             the real (resp. imaginary) parts of the n complexes are linearly equally
54             spaced between the real (resp. imaginary) parts of <literal>x1</literal>
55             and <literal>x2.</literal>
56         </para>
57     </refsection>
58     <refsection>
59         <title>Examples</title>
60         <programlisting role="example"><![CDATA[ 
61 linspace(1,2,10)
62 linspace([1:4]',[5:8]',10)
63 linspace(1+%i,2+2*%i,10)
64  ]]></programlisting>
65     </refsection>
66     <refsection role="see also">
67         <title>See Also</title>
68         <simplelist type="inline">
69             <member>
70                 <link linkend="logspace">logspace</link>
71             </member>
72         </simplelist>
73     </refsection>
74     <refsection>
75         <title>History</title>
76         <revhistory>
77             <revision>
78                 <revnumber>5.4.0</revnumber>
79                 <revremark>
80                     <itemizedlist>
81                         <listitem>The linspace function accepts column vectors as input argument for the two first input arguments. Thanks to Guillaume AZEMA for the implementation.
82                         </listitem>
83                         <listitem>The third input argument (n) must be an integer value.
84                         </listitem>
85                     </itemizedlist>
86                 </revremark>
87             </revision>
88         </revhistory>
89     </refsection>
90 </refentry>