← 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/modulo.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/modulo.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="modulo" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>modulo</refname>
16
 
    <refpurpose>symmetric arithmetic remainder modulo m</refpurpose>
17
 
  </refnamediv>
18
 
  <refnamediv xml:id="pmodulo">
19
 
    <refname>pmodulo</refname>
20
 
    <refpurpose>positive arithmetic remainder modulo m</refpurpose>
21
 
  </refnamediv>
22
 
  <refsynopsisdiv>
23
 
    <title>Calling Sequence</title>
24
 
    <synopsis>i = modulo(n,m)</synopsis>
25
 
    <synopsis>i = pmodulo(n,m)</synopsis>
26
 
  </refsynopsisdiv>
27
 
  <refsection>
28
 
    <title>Arguments</title>
29
 
    <variablelist>
30
 
      <varlistentry>
31
 
        <term>n</term>
32
 
        <listitem>
33
 
          <para>real vector or matrix </para>
34
 
        </listitem>
35
 
      </varlistentry>
36
 
      <varlistentry>
37
 
        <term>m</term>
38
 
        <listitem>
39
 
          <para>real vector or matrix </para>
40
 
        </listitem>
41
 
      </varlistentry>
42
 
    </variablelist>
43
 
  </refsection>
44
 
  <refsection>
45
 
    <title>Description</title>
46
 
    <para>
47
 
      <literal>modulo</literal> computes <literal>i = n (modulo
48
 
        m)
49
 
      </literal>
50
 
      i.e. remainder of <literal>n</literal> divided by
51
 
      <literal>m</literal> (<literal>n</literal> and <literal>m</literal>
52
 
      are integers).
53
 
    </para>
54
 
    <para>
55
 
      <literal>i = n - m .* int (n ./ m)</literal>. Here the answer may be negative
56
 
      if <literal>n</literal> or <literal>m</literal> are negative.
57
 
    </para>
58
 
    <para>
59
 
      <literal>pmodulo</literal> computes <literal>i = n - m .* floor (n
60
 
        ./ m)
61
 
      </literal>
62
 
      ,the answer is positive or zero.
63
 
    </para>
64
 
    <para>
65
 
      <literal>modulo(x,0)</literal> returns an error message: "Division by zero...". With ieee(2), <literal>modulo(x,0)</literal> returns %nan.
66
 
    </para>
67
 
    <para>
68
 
      <literal>pmodulo(x,0)</literal> returns an error message: "Division by zero...". With ieee(2), <literal>pmodulo(x,0)</literal> returns %nan.
69
 
    </para>
70
 
  </refsection>
71
 
  <refsection>
72
 
    <title>Examples</title>
73
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>modulo</refname>
 
16
        <refpurpose>symmetric arithmetic remainder modulo m</refpurpose>
 
17
    </refnamediv>
 
18
    <refnamediv xml:id="pmodulo">
 
19
        <refname>pmodulo</refname>
 
20
        <refpurpose>positive arithmetic remainder modulo m</refpurpose>
 
21
    </refnamediv>
 
22
    <refsynopsisdiv>
 
23
        <title>Calling Sequence</title>
 
24
        <synopsis>i = modulo(n,m)</synopsis>
 
25
        <synopsis>i = pmodulo(n,m)</synopsis>
 
26
    </refsynopsisdiv>
 
27
    <refsection>
 
28
        <title>Arguments</title>
 
29
        <variablelist>
 
30
            <varlistentry>
 
31
                <term>n</term>
 
32
                <listitem>
 
33
                    <para>real vector or matrix </para>
 
34
                </listitem>
 
35
            </varlistentry>
 
36
            <varlistentry>
 
37
                <term>m</term>
 
38
                <listitem>
 
39
                    <para>real vector or matrix </para>
 
40
                </listitem>
 
41
            </varlistentry>
 
42
        </variablelist>
 
43
    </refsection>
 
44
    <refsection>
 
45
        <title>Description</title>
 
46
        <para>
 
47
            <literal>modulo</literal> computes <literal>i = n (modulo
 
48
                m)
 
49
            </literal>
 
50
            i.e. remainder of <literal>n</literal> divided by
 
51
            <literal>m</literal> (<literal>n</literal> and <literal>m</literal>
 
52
            are integers).
 
53
        </para>
 
54
        <para>
 
55
            <literal>i = n - m .* int (n ./ m)</literal>. Here the answer may be negative
 
56
            if <literal>n</literal> or <literal>m</literal> are negative.
 
57
        </para>
 
58
        <para>
 
59
            <literal>pmodulo</literal> computes <literal>i = n - m .* floor (n
 
60
                ./ m)
 
61
            </literal>
 
62
            ,the answer is positive or zero.
 
63
        </para>
 
64
        <para>
 
65
            <literal>modulo(x,0)</literal> returns an error message: "Division by zero...". With ieee(2), <literal>modulo(x,0)</literal> returns %nan.
 
66
        </para>
 
67
        <para>
 
68
            <literal>pmodulo(x,0)</literal> returns an error message: "Division by zero...". With ieee(2), <literal>pmodulo(x,0)</literal> returns %nan.
 
69
        </para>
 
70
    </refsection>
 
71
    <refsection>
 
72
        <title>Examples</title>
 
73
        <programlisting role="example"><![CDATA[ 
74
74
n=[1,2,10,15];m=[2,2,3,5];
75
75
modulo(n,m)
76
76
 
77
77
modulo(-3,9)
78
78
pmodulo(-3,9)
79
79
 ]]></programlisting>
80
 
  </refsection>
 
80
    </refsection>
81
81
</refentry>