← 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/zeros.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/zeros.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="zeros" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>zeros</refname>
16
 
    <refpurpose>matrix made of zeros</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>y=zeros()
21
 
      y=zeros(x)
22
 
      y=zeros(m1,m2,..)
23
 
    </synopsis>
24
 
  </refsynopsisdiv>
25
 
  <refsection>
26
 
    <title>Arguments</title>
27
 
    <variablelist>
28
 
      <varlistentry>
29
 
        <term>x,y</term>
30
 
        <listitem>
31
 
          <para>matrices</para>
32
 
        </listitem>
33
 
      </varlistentry>
34
 
      <varlistentry>
35
 
        <term>m1, m2,..</term>
36
 
        <listitem>
37
 
          <para>integers</para>
38
 
        </listitem>
39
 
      </varlistentry>
40
 
    </variablelist>
41
 
  </refsection>
42
 
  <refsection>
43
 
    <title>Description</title>
44
 
    <para>
45
 
      Creates matrix of zeros (same as <literal>0*ones</literal>).
46
 
    </para>
47
 
    <variablelist>
48
 
      <varlistentry>
49
 
        <term>zeros(m1,m2)</term>
50
 
        <listitem>
51
 
          <para>
52
 
            for an <literal>(m1,m2)</literal> matrix.
53
 
          </para>
54
 
        </listitem>
55
 
      </varlistentry>
56
 
      <varlistentry>
57
 
        <term>zeros(m1,m2,..,mn)</term>
58
 
        <listitem>
59
 
          <para>
60
 
            creates a <literal>(m1,m2,..,mn)</literal> matrix filled with
61
 
            zeros
62
 
          </para>
63
 
        </listitem>
64
 
      </varlistentry>
65
 
      <varlistentry>
66
 
        <term>zeros(A)</term>
67
 
        <listitem>
68
 
          <para>
69
 
            for a matrix of same size of <literal>A</literal>.
70
 
          </para>
71
 
        </listitem>
72
 
      </varlistentry>
73
 
      <varlistentry>
74
 
        <term>zeros(3)</term>
75
 
        <listitem>
76
 
          <para>
77
 
            is <literal>zeros(a)</literal> with <literal>a=3</literal> i.e
78
 
            it is NOT a 3x3 matrix!
79
 
          </para>
80
 
        </listitem>
81
 
      </varlistentry>
82
 
      <varlistentry>
83
 
        <term>zeros()</term>
84
 
        <listitem>
85
 
          <para>returns a single zero</para>
86
 
        </listitem>
87
 
      </varlistentry>
88
 
    </variablelist>
89
 
    <para>
90
 
      If <literal>x</literal> is a <literal>syslin</literal> list (linear
91
 
      system in state-space or transfer form), <literal>zeros(x)</literal> is
92
 
      also valid and returns a zero matrix.
93
 
    </para>
94
 
  </refsection>
95
 
  <refsection>
96
 
    <title>Examples</title>
97
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>zeros</refname>
 
16
        <refpurpose>matrix made of zeros</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>y=zeros()
 
21
            y=zeros(x)
 
22
            y=zeros(m1,m2,..)
 
23
        </synopsis>
 
24
    </refsynopsisdiv>
 
25
    <refsection>
 
26
        <title>Arguments</title>
 
27
        <variablelist>
 
28
            <varlistentry>
 
29
                <term>x,y</term>
 
30
                <listitem>
 
31
                    <para>matrices</para>
 
32
                </listitem>
 
33
            </varlistentry>
 
34
            <varlistentry>
 
35
                <term>m1, m2,..</term>
 
36
                <listitem>
 
37
                    <para>integers</para>
 
38
                </listitem>
 
39
            </varlistentry>
 
40
        </variablelist>
 
41
    </refsection>
 
42
    <refsection>
 
43
        <title>Description</title>
 
44
        <para>
 
45
            Creates matrix of zeros (same as <literal>0*ones</literal>).
 
46
        </para>
 
47
        <variablelist>
 
48
            <varlistentry>
 
49
                <term>zeros(m1,m2)</term>
 
50
                <listitem>
 
51
                    <para>
 
52
                        for an <literal>(m1,m2)</literal> matrix.
 
53
                    </para>
 
54
                </listitem>
 
55
            </varlistentry>
 
56
            <varlistentry>
 
57
                <term>zeros(m1,m2,..,mn)</term>
 
58
                <listitem>
 
59
                    <para>
 
60
                        creates a <literal>(m1,m2,..,mn)</literal> matrix filled with
 
61
                        zeros
 
62
                    </para>
 
63
                </listitem>
 
64
            </varlistentry>
 
65
            <varlistentry>
 
66
                <term>zeros(A)</term>
 
67
                <listitem>
 
68
                    <para>
 
69
                        for a matrix of same size of <literal>A</literal>.
 
70
                    </para>
 
71
                </listitem>
 
72
            </varlistentry>
 
73
            <varlistentry>
 
74
                <term>zeros(3)</term>
 
75
                <listitem>
 
76
                    <para>
 
77
                        is <literal>zeros(a)</literal> with <literal>a=3</literal> i.e
 
78
                        it is NOT a 3x3 matrix!
 
79
                    </para>
 
80
                </listitem>
 
81
            </varlistentry>
 
82
            <varlistentry>
 
83
                <term>zeros()</term>
 
84
                <listitem>
 
85
                    <para>returns a single zero</para>
 
86
                </listitem>
 
87
            </varlistentry>
 
88
        </variablelist>
 
89
        <para>
 
90
            If <literal>x</literal> is a <literal>syslin</literal> list (linear
 
91
            system in state-space or transfer form), <literal>zeros(x)</literal> is
 
92
            also valid and returns a zero matrix.
 
93
        </para>
 
94
    </refsection>
 
95
    <refsection>
 
96
        <title>Examples</title>
 
97
        <programlisting role="example"><![CDATA[ 
98
98
zeros(3)
99
99
zeros(3,3)
100
100
zeros(2,3,2)
101
101
 ]]></programlisting>
102
 
  </refsection>
103
 
  <refsection role="see also">
104
 
    <title>See Also</title>
105
 
    <simplelist type="inline">
106
 
      <member>
107
 
        <link linkend="eye">eye</link>
108
 
      </member>
109
 
      <member>
110
 
        <link linkend="ones">ones</link>
111
 
      </member>
112
 
      <member>
113
 
        <link linkend="spzeros">spzeros</link>
114
 
      </member>
115
 
    </simplelist>
116
 
  </refsection>
 
102
    </refsection>
 
103
    <refsection role="see also">
 
104
        <title>See Also</title>
 
105
        <simplelist type="inline">
 
106
            <member>
 
107
                <link linkend="eye">eye</link>
 
108
            </member>
 
109
            <member>
 
110
                <link linkend="ones">ones</link>
 
111
            </member>
 
112
            <member>
 
113
                <link linkend="spzeros">spzeros</link>
 
114
            </member>
 
115
        </simplelist>
 
116
    </refsection>
117
117
</refentry>