← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/elementary_functions/help/en_US/elementarymatrices/linspace.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/elementary_functions/help/en_US/elementarymatrices/linspace.xml
11
11
 *
12
12
 -->
13
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" version="5.0-subset Scilab" 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[ 
 
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
61
linspace(1,2,10)
62
62
linspace(1+%i,2+2*%i,10)
63
63
 ]]></programlisting>
64
 
  </refsection>
65
 
  <refsection role="see also">
66
 
    <title>See Also</title>
67
 
    <simplelist type="inline">
68
 
      <member>
69
 
        <link linkend="logspace">logspace</link>
70
 
      </member>
71
 
    </simplelist>
72
 
  </refsection>
73
 
  <refsection>
74
 
    <title>History</title>
75
 
    <revhistory>
76
 
      <revision>
77
 
        <revnumber>5.4.0</revnumber>
78
 
        <revremark>
79
 
          <itemizedlist>
80
 
            <listitem>The linspace function accepts column vectors as input argument for the two first input arguments. Thanks to Guillaume AZEMA for the implementation.
81
 
            </listitem>
82
 
            <listitem>The third input argument (n) must be an integer value.
83
 
            </listitem>
84
 
          </itemizedlist>
85
 
        </revremark>
86
 
      </revision>
87
 
    </revhistory>
88
 
  </refsection>
 
64
    </refsection>
 
65
    <refsection role="see also">
 
66
        <title>See Also</title>
 
67
        <simplelist type="inline">
 
68
            <member>
 
69
                <link linkend="logspace">logspace</link>
 
70
            </member>
 
71
        </simplelist>
 
72
    </refsection>
 
73
    <refsection>
 
74
        <title>History</title>
 
75
        <revhistory>
 
76
            <revision>
 
77
                <revnumber>5.4.0</revnumber>
 
78
                <revremark>
 
79
                    <itemizedlist>
 
80
                        <listitem>The linspace function accepts column vectors as input argument for the two first input arguments. Thanks to Guillaume AZEMA for the implementation.
 
81
                        </listitem>
 
82
                        <listitem>The third input argument (n) must be an integer value.
 
83
                        </listitem>
 
84
                    </itemizedlist>
 
85
                </revremark>
 
86
            </revision>
 
87
        </revhistory>
 
88
    </refsection>
89
89
</refentry>