← Back to branch summary

~ubuntu-branches/ubuntu/lucid/scilab/lucid

« back to all changes in this revision

Viewing changes to modules/elementary_functions/help/en_US/zeros.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sylvestre Ledru
  • Date: 2009-04-28 18:47:03 UTC
  • mfrom: (1.1.7 upstream) (4.2.3 sid)
  • Revision ID: james.westby@ubuntu.com-20090428184703-7thddz8vtwqmxmx2
Tags: 5.1.1-4
* librefblas3-dev does not exist (yet). Thanks to Jose Ramon
* Do not stop when ocamlopt is not available on the arch 
  (ocaml-not-available.diff)
* Provide a clear error message for archs where modelicac compiler is 
  not available (modelicac-not-available.diff)
* scilab startup script moved from package scilab => scilab-bin (because of
  the ocamlopt problem, I cannot predict if modelicac will be available or
  not. Therefor, I ship usr/bin/ instead of binary per binary. This will
  also simplifies the packaging of Scilab 5.2)

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/elementary_functions/help/en_US/zeros.xml
10
10
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11
11
 *
12
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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="zeros">
 
13
<refentry version="5.0-subset Scilab" xml:id="zeros" xml:lang="en"
 
14
          xmlns="http://docbook.org/ns/docbook"
 
15
          xmlns:xlink="http://www.w3.org/1999/xlink"
 
16
          xmlns:svg="http://www.w3.org/2000/svg"
 
17
          xmlns:ns5="http://www.w3.org/1999/xhtml"
 
18
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
 
19
          xmlns:db="http://docbook.org/ns/docbook">
14
20
  <info>
15
21
    <pubdate>$LastChangedDate$</pubdate>
16
22
  </info>
 
23
 
17
24
  <refnamediv>
18
25
    <refname>zeros</refname>
19
 
    <refpurpose> matrix made of zeros</refpurpose>
 
26
 
 
27
    <refpurpose>matrix made of zeros</refpurpose>
20
28
  </refnamediv>
 
29
 
21
30
  <refsynopsisdiv>
22
31
    <title>Calling Sequence</title>
 
32
 
23
33
    <synopsis>y=zeros()
24
34
y=zeros(x)
25
35
y=zeros(m1,m2,..)</synopsis>
26
36
  </refsynopsisdiv>
 
37
 
27
38
  <refsection>
28
39
    <title>Parameters</title>
 
40
 
29
41
    <variablelist>
30
42
      <varlistentry>
31
43
        <term>x,y</term>
 
44
 
32
45
        <listitem>
33
46
          <para>matrices</para>
34
47
        </listitem>
35
48
      </varlistentry>
 
49
 
36
50
      <varlistentry>
37
 
        <term>m1, m2,..  </term>
 
51
        <term>m1, m2,..</term>
 
52
 
38
53
        <listitem>
39
54
          <para>integers</para>
40
55
        </listitem>
41
56
      </varlistentry>
42
57
    </variablelist>
43
58
  </refsection>
 
59
 
44
60
  <refsection>
45
61
    <title>Description</title>
46
 
    <para>
47
 
    Creates matrix of zeros  (same as <literal>0*ones</literal>).
48
 
  </para>
 
62
 
 
63
    <para>Creates matrix of zeros (same as <literal>0*ones</literal>).</para>
 
64
 
49
65
    <variablelist>
50
66
      <varlistentry>
51
67
        <term>zeros(m1,m2)</term>
 
68
 
52
69
        <listitem>
53
70
          <para>for an <literal>(m1,m2)</literal> matrix.</para>
54
71
        </listitem>
55
72
      </varlistentry>
 
73
 
56
74
      <varlistentry>
57
75
        <term>zeros(m1,m2,..,mn)</term>
 
76
 
58
77
        <listitem>
59
 
          <para>creates a <literal>(m1,m2,..,mn)</literal> matrix filled with zeros</para>
 
78
          <para>creates a <literal>(m1,m2,..,mn)</literal> matrix filled with
 
79
          zeros</para>
60
80
        </listitem>
61
81
      </varlistentry>
 
82
 
62
83
      <varlistentry>
63
84
        <term>zeros(A)</term>
 
85
 
64
86
        <listitem>
65
87
          <para>for a matrix of same size of <literal>A</literal>.</para>
66
88
        </listitem>
67
89
      </varlistentry>
 
90
 
68
91
      <varlistentry>
69
92
        <term>zeros(3)</term>
 
93
 
70
94
        <listitem>
71
 
          <para>is <literal>zeros(a)</literal> with <literal>a=3</literal> i.e it is NOT a 3x3 matrix!</para>
 
95
          <para>is <literal>zeros(a)</literal> with <literal>a=3</literal> i.e
 
96
          it is NOT a 3x3 matrix!</para>
72
97
        </listitem>
73
98
      </varlistentry>
 
99
 
74
100
      <varlistentry>
75
101
        <term>zeros()</term>
 
102
 
76
103
        <listitem>
77
104
          <para>returns a single zero</para>
78
105
        </listitem>
79
106
      </varlistentry>
80
107
    </variablelist>
81
 
    <para>
82
 
    If <literal>x</literal> is a <literal>syslin</literal> list (linear system in state-space or transfer
83
 
    form), <literal>zeros(x)</literal> is also valid and returns a zero matrix.</para>
 
108
 
 
109
    <para>If <literal>x</literal> is a <literal>syslin</literal> list (linear
 
110
    system in state-space or transfer form), <literal>zeros(x)</literal> is
 
111
    also valid and returns a zero matrix.</para>
84
112
  </refsection>
 
113
 
85
114
  <refsection>
86
115
    <title>Examples</title>
87
 
    <programlisting role="example"><![CDATA[
88
116
 
 
117
    <programlisting role="example"> 
89
118
zeros(3)
90
119
zeros(3,3)
91
120
zeros(2,3,2)
92
 
 
93
 
  ]]></programlisting>
 
121
   </programlisting>
94
122
  </refsection>
 
123
 
95
124
  <refsection>
96
125
    <title>See Also</title>
 
126
 
97
127
    <simplelist type="inline">
98
 
      <member>
99
 
        <link linkend="eye">eye</link>
100
 
      </member>
101
 
      <member>
102
 
        <link linkend="ones">ones</link>
103
 
      </member>
104
 
      <member>
105
 
        <link linkend="spzeros">spzeros</link>
106
 
      </member>
 
128
      <member><link linkend="eye">eye</link></member>
 
129
 
 
130
      <member><link linkend="ones">ones</link></member>
 
131
 
 
132
      <member><link linkend="spzeros">spzeros</link></member>
107
133
    </simplelist>
108
134
  </refsection>
109
135
</refentry>