← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/core/help/en_US/keywords/dot.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/core/help/en_US/keywords/dot.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
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: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="dot" xml:lang="en">
3
 
  <refnamediv>
4
 
    <refname>dot</refname>
5
 
    <refpurpose>(.) symbol</refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>
10
 
      123.33
11
 
      a.*b
12
 
      
13
 
      [123,..
14
 
      456]
15
 
    </synopsis>
16
 
  </refsynopsisdiv>
17
 
  <refsection>
18
 
    <title>Description</title>
19
 
    <variablelist>
20
 
      <varlistentry>
21
 
        <term>.</term>
22
 
        <listitem>
23
 
          <para>Dot is used to mark decimal point for numbers : 3.25 and
24
 
            0.001
25
 
          </para>
26
 
        </listitem>
27
 
      </varlistentry>
28
 
      <varlistentry>
29
 
        <term>.&lt;op&gt;</term>
30
 
        <listitem>
31
 
          <para>
32
 
            used in conjunction with other operator symbols (<literal>*/ \ ^ '</literal>) to form other operators. Element-by-element
33
 
            multiplicative operations are obtained using <literal> .* , .^ , ./ , .\</literal>
34
 
            or <literal>.'</literal>. For example,  <literal>C = A ./ B</literal> is
35
 
            the matrix with elements <literal>c(i,j) = a(i,j)/b(i,j)</literal>. Kronecker product
36
 
            is noted <literal>.*.</literal> . Note that when dot follows a number it is always a part
37
 
            of the number so <literal>2.*x</literal> is evaluated as <literal>2.0*x</literal> and <literal>2 .*x</literal> is evaluated
38
 
            as <literal>(2).*x</literal>.
39
 
          </para>
40
 
        </listitem>
41
 
      </varlistentry>
42
 
      <varlistentry>
43
 
        <term>..</term>
44
 
        <listitem>
45
 
          <para>Continuation mark. Two or more dots at the end of a
46
 
            line (or followed by a comment) causes the following line to be a
47
 
            continuation.
48
 
          </para>
49
 
          <para>Continuation lines are handled by a preprocessor which builds
50
 
            a long logical line from a sequence of continuation lines. So the
51
 
            continuation marks can be used to cut a line at any point.
52
 
          </para>
53
 
          <para>
54
 
            The following function <literal>foo</literal>:
55
 
          </para>
56
 
          <programlisting role=""><![CDATA[ 
 
3
    <refnamediv>
 
4
        <refname>dot</refname>
 
5
        <refpurpose>(.) symbol</refpurpose>
 
6
    </refnamediv>
 
7
    <refsynopsisdiv>
 
8
        <title>Calling Sequence</title>
 
9
        <synopsis>
 
10
            123.33
 
11
            a.*b
 
12
            
 
13
            [123,..
 
14
            456]
 
15
        </synopsis>
 
16
    </refsynopsisdiv>
 
17
    <refsection>
 
18
        <title>Description</title>
 
19
        <variablelist>
 
20
            <varlistentry>
 
21
                <term>.</term>
 
22
                <listitem>
 
23
                    <para>Dot is used to mark decimal point for numbers : 3.25 and
 
24
                        0.001
 
25
                    </para>
 
26
                </listitem>
 
27
            </varlistentry>
 
28
            <varlistentry>
 
29
                <term>.&lt;op&gt;</term>
 
30
                <listitem>
 
31
                    <para>
 
32
                        used in conjunction with other operator symbols (<literal>*/ \ ^ '</literal>) to form other operators. Element-by-element
 
33
                        multiplicative operations are obtained using <literal> .* , .^ , ./ , .\</literal>
 
34
                        or <literal>.'</literal>. For example,  <literal>C = A ./ B</literal> is
 
35
                        the matrix with elements <literal>c(i,j) = a(i,j)/b(i,j)</literal>. Kronecker product
 
36
                        is noted <literal>.*.</literal> . Note that when dot follows a number it is always a part
 
37
                        of the number so <literal>2.*x</literal> is evaluated as <literal>2.0*x</literal> and <literal>2 .*x</literal> is evaluated
 
38
                        as <literal>(2).*x</literal>.
 
39
                    </para>
 
40
                </listitem>
 
41
            </varlistentry>
 
42
            <varlistentry>
 
43
                <term>..</term>
 
44
                <listitem>
 
45
                    <para>Continuation mark. Two or more dots at the end of a
 
46
                        line (or followed by a comment) causes the following line to be a
 
47
                        continuation.
 
48
                    </para>
 
49
                    <para>Continuation lines are handled by a preprocessor which builds
 
50
                        a long logical line from a sequence of continuation lines. So the
 
51
                        continuation marks can be used to cut a line at any point.
 
52
                    </para>
 
53
                    <para>
 
54
                        The following function <literal>foo</literal>:
 
55
                    </para>
 
56
                    <programlisting role=""><![CDATA[ 
57
57
function foo
58
58
  a=1
59
59
  disp(a),..
60
60
  disp('ok')
61
61
endfunction
62
62
 ]]></programlisting>
63
 
          <para>is equivalent to:</para>
64
 
          <programlisting role=""><![CDATA[ 
 
63
                    <para>is equivalent to:</para>
 
64
                    <programlisting role=""><![CDATA[ 
65
65
function foo 
66
66
  a=1
67
67
 
68
68
  disp(a),disp('ok') 
69
69
endfunction
70
70
 ]]></programlisting>
71
 
          <para>The logical line formed by physical line 3 and physical line 4
72
 
            is built as if it was entirely written in the physical line 4 while
73
 
            physical line 3 would be empty. This is done this way because
74
 
            continuation marks can be put anywhere even inside an
75
 
            expression.
76
 
          </para>
77
 
        </listitem>
78
 
      </varlistentry>
79
 
    </variablelist>
80
 
  </refsection>
81
 
  <refsection>
82
 
    <title>Examples</title>
83
 
    <programlisting role="example"><![CDATA[ 
 
71
                    <para>The logical line formed by physical line 3 and physical line 4
 
72
                        is built as if it was entirely written in the physical line 4 while
 
73
                        physical line 3 would be empty. This is done this way because
 
74
                        continuation marks can be put anywhere even inside an
 
75
                        expression.
 
76
                    </para>
 
77
                </listitem>
 
78
            </varlistentry>
 
79
        </variablelist>
 
80
    </refsection>
 
81
    <refsection>
 
82
        <title>Examples</title>
 
83
        <programlisting role="example"><![CDATA[ 
84
84
//decimal point
85
85
1.345
86
86
 
96
96
y=12..
97
97
45
98
98
 ]]></programlisting>
99
 
  </refsection>
100
 
  <refsection role="see also">
101
 
    <title>See Also</title>
102
 
    <simplelist type="inline">
103
 
      <member>
104
 
        <link linkend="star">star</link>
105
 
      </member>
106
 
      <member>
107
 
        <link linkend="hat">hat</link>
108
 
      </member>
109
 
      <member>
110
 
        <link linkend="slash">slash</link>
111
 
      </member>
112
 
      <member>
113
 
        <link linkend="backslash">backslash</link>
114
 
      </member>
115
 
    </simplelist>
116
 
  </refsection>
 
99
    </refsection>
 
100
    <refsection role="see also">
 
101
        <title>See Also</title>
 
102
        <simplelist type="inline">
 
103
            <member>
 
104
                <link linkend="star">star</link>
 
105
            </member>
 
106
            <member>
 
107
                <link linkend="hat">hat</link>
 
108
            </member>
 
109
            <member>
 
110
                <link linkend="slash">slash</link>
 
111
            </member>
 
112
            <member>
 
113
                <link linkend="backslash">backslash</link>
 
114
            </member>
 
115
        </simplelist>
 
116
    </refsection>
117
117
</refentry>