* Bug 15891 fixed: [doc] matrix-wise trigo pages => subsection
[scilab.git] / scilab / modules / elementary_functions / help / pt_BR / modulo.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - INRIA
5  * Copyright (C) 2013, 2018 - Samuel GOUGEON
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
18         xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
19         xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
20         xmlns:scilab="http://www.scilab.org" xml:id="modulo" xml:lang="pt">
21     <refnamediv>
22         <refname>modulo</refname>
23         <refpurpose>
24             Resto módulo m com o sinal do operando esquerdo, ou de uma divisão polinomial
25         </refpurpose>
26     </refnamediv>
27     <refnamediv xml:id="pmodulo">
28         <refname>pmodulo</refname>
29         <refpurpose>Resto positivo da divisão de n por m</refpurpose>
30     </refnamediv>
31     <refsynopsisdiv>
32         <title>Seqüência de Chamamento</title>
33         <synopsis>i = modulo(n,m)</synopsis>
34         <para></para>
35         <synopsis>i = pmodulo(n,m)</synopsis>
36     </refsynopsisdiv>
37     <refsection>
38         <title>Parâmetros</title>
39         <variablelist>
40             <varlistentry>
41                 <term>n,m</term>
42                 <listitem>
43                     <para>
44                         Escalar, vetor, matriz ou hipermatriz de inteiros codificados, reais ou
45                         polinômios com coeficientes reais.
46                         <varname>m</varname> e <varname>n</varname> devem ter o mesmo tipo.
47                         Se eles são do tipo inteiro, eles podem ser de comprimento de codificação
48                         distinto (por exemplo, int8 e int16).
49                         Se nenhum deles for escalar, eles devem ter os mesmos tamanhos.
50                     </para>
51                 </listitem>
52             </varlistentry>
53             <varlistentry>
54                 <term>i</term>
55                 <listitem>
56                     <para>
57                         Escalar, vetor, matriz ou hipermatriz do tipo (e inttype) <varname>n</varname>.
58                         <varname>i</varname> aceita os tamanhos do maior <varname>m</varname>
59                         ou <varname>n</varname>.
60                     </para>
61                     <para>
62                         <warning>
63                             For polynomials, when all remainders in the array <varname>i</varname>
64                             are constant (degree==0), <varname>i</varname> is of type 1
65                             (numbers) instead of 2 (constant polynomials).
66                         </warning>
67                     </para>
68                 </listitem>
69             </varlistentry>
70         </variablelist>
71     </refsection>
72     <refsection>
73         <title>Descrição</title>
74         <para>
75             <literal>modulo</literal> computa <literal>i= n (modulo m)</literal>
76             i.e. resto da divisão de <literal>m</literal>.
77         </para>
78         <para>Para polinômios, <literal>pdiv()</literal> é chamado.</para>
79         <para>
80             Para números,
81             <itemizedlist>
82                 <listitem>
83                     <para>
84                     <literal>modulo()</literal> calcula <literal>i = n - m .* int (n ./m)</literal>.
85                     O resultado é negativo (ou nulo) quando <varname>n</varname> é negativo e
86                     é positivo caso contrário.
87                     </para>
88                 </listitem>
89                 <listitem>
90                     <para>
91                     <literal>pmodulo()</literal> calcula <literal>i = n - | m | .* floor (n ./ | m |)</literal>.
92                     O resultado é sempre positivo ou nulo.
93                     </para>
94                 </listitem>
95             </itemizedlist>
96         </para>
97         <para>
98             <warning>
99                 Se <varname>m</varname> contiver pelo menos um valor 0, <literal>modulo(x,m)</literal>
100                 e <literal>pmodulo(x,m)</literal> executará uma divisão por zero.
101                 Se <varname>m</varname> for do tipo real, esta exceção será processada de acordo
102                 para o modo <literal>ieee()</literal>.
103                 Para inteiros codificados, sempre gerará um erro.
104             </warning>
105         </para>
106     </refsection>
107     <refsection>
108         <title>Exemplos</title>
109         <programlisting role="example"><![CDATA[
110 n = [1,2,10,15];
111 m = [2,2,3,5];
112 modulo(n,m)
113
114 modulo(-3, 9)
115 modulo(10, -4)
116
117 pmodulo(-3, 9)
118 pmodulo(10, -6)
119 pmodulo(-10, -6)
120
121 // Inteiros codificados
122 modulo( int8(-13), int16(-7))
123 pmodulo(int8(-13), int16(-7))
124 modulo( int8(-13), int16([-7 5]))
125 pmodulo(int8(-13), int16([-7 5]))
126 modulo( int8([-13 8]), int16(-7))
127 pmodulo(int8([-13 8]), int16(-7))
128 modulo( int8([-13 8]), int16([-7 5]))
129 pmodulo(int8([-13 8]), int16([-7 5]))
130
131 // Hypermatrices
132 m = grand(2,2,2,"uin",-100,100)
133 n = grand(2,2,2,"uin",-10 ,10);
134 n(n==0) = 1
135 modulo(m, 5)
136 pmodulo(m,5)
137 modulo(51, n)
138 pmodulo(51,n)
139 modulo(m, n)
140 pmodulo(m,n)
141
142 // Polinômios
143 modulo( %z^2+1, %z)
144 pmodulo(%z^2+1, %z)
145  ]]></programlisting>
146     </refsection>
147     <refsection role= "see also">
148         <title>Ver Também</title>
149         <simplelist type="inline">
150             <member>
151                 <link linkend="unwrap">unwrap</link>
152             </member>
153             <member>
154                 <link linkend="ieee">ieee</link>
155             </member>
156         </simplelist>
157     </refsection>
158     <refsection>
159         <title>Histórico</title>
160         <revhistory>
161             <revision>
162                 <revnumber>5.5.0</revnumber>
163                 <revremark>
164                     Extensão para inteiros codificados e para hypermatrices de inteiros codificados
165                     ou de reais.
166                 </revremark>
167             </revision>
168             <revision>
169                 <revnumber>6.0.2</revnumber>
170                 <revremark>Extensão para hipermatrizes de polinômios..</revremark>
171             </revision>
172         </revhistory>
173     </refsection>
174 </refentry>