[localization] fix wrong french translation of row
[scilab.git] / scilab / modules / elementary_functions / help / fr_FR / matrixoperations / or.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) 2016 - Samuel GOUGEON
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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" xmlns:scilab="http://www.scilab.org" xml:id="or" xml:lang="fr">
17     <refnamediv>
18         <refname>or</refname>
19         <refpurpose>OU logique entre éléments d'un tableau booléen ou numérique</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntaxe</title>
23         <synopsis>
24             b = or(A)
25             b = or(A, 'r')
26             b = or(A, 'c')
27             b = or(A, n)
28         </synopsis>
29     </refsynopsisdiv>
30     <refsection role="parameters">
31         <title>Paramètres</title>
32         <variablelist>
33             <varlistentry>
34                 <term>A</term>
35                 <listitem>
36                     <para>
37                         vecteur, matrice ou hypermatrice de booléens, d'entiers
38                         encodés (de type entier <link linkend="inttype">inttype</link>
39                         quelconque), de décimaux, ou de nombres complexes.
40                         <varname>A</varname> peut être encodée creuse
41                             (<link linkend="sparse">sparse</link>).
42                     </para>
43                     <para>
44                         Un nombre est identifié à <literal>%F</literal> (faux)
45                         s'il vaut 0 ou 0+0i. Sinon (%nan inclus), il est identifé
46                         à <literal>%T</literal> (vrai).
47                     </para>
48                     <note>Valeurs particulières de <varname>A</varname> :
49                         <itemizedlist>
50                             <listitem>
51                                 <literal>or([])</literal> vaut <literal>%F</literal>.
52                             </listitem>
53                             <listitem>
54                                 <literal>or(%nan)</literal> vaut <literal>%T</literal>.
55                             </listitem>
56                         </itemizedlist>
57                     </note>
58                 </listitem>
59             </varlistentry>
60             <varlistentry>
61                 <term>b</term>
62                 <listitem>
63                     <para>
64                         Booléen simple si <literal>or(A)</literal> est utilisée
65                         sans option <varname>"r", "c", n</varname>.
66                         <varname>b</varname> vaut alors
67                         <itemizedlist>
68                             <listitem>
69                                 %F, si tous les éléments de <varname>A</varname>
70                                 sont %F ou nuls.
71                             </listitem>
72                             <listitem>
73                                 %T, sinon : au moins un des éléments de <varname>A</varname>
74                                 est %T ou non nul.
75                             </listitem>
76                         </itemizedlist>
77                     </para>
78                     <para>
79                         Sinon : vecteur ligne, colonne, matrice ou hypermatrice.
80                         Voir la description de <varname>n</varname> ci-dessous.
81                     </para>
82                     <para>
83                         Lorsque <varname>A</varname> est encodée creuse,
84                         <varname>b</varname> l'est également.
85                     </para>
86                 </listitem>
87             </varlistentry>
88             <varlistentry>
89                 <term>n</term>
90                 <listitem>
91                     <para>
92                         N° &lt;= ndims(A) de la dimension selon laquelle
93                         <function>or()</function> est appliqué / projeté.
94                         Par défaut, <function>or()</function> est appliqué
95                         entre <emphasis>tous</emphasis> les éléments de
96                         <varname>A</varname>. Sinon :
97                         <itemizedlist>
98                             <listitem>
99                                 n = 1 | "r" : <function>or()</function> est
100                                 appliqué entre les lignes de <varname>A</varname>.
101                                 Si <varname>A</varname> est une matrice,
102                                 <varname>b</varname> est alors une
103                                 ligne, avec
104                                 <literal>b(j) = or(A(:,j))</literal>
105                             </listitem>
106                             <listitem>
107                                 n = 2 | "c" :
108                                 <function>or()</function> est appliqué entre les
109                                 colonnes de <varname>A</varname>.
110                                 Si <varname>A</varname> est une matrice,
111                                 <varname>b</varname> est alors une
112                                 <emphasis role="bold">c</emphasis>olonne, avec
113                                 <literal>b(i) = or(A(i,:))</literal>.
114                             </listitem>
115                             <listitem>
116                                 n > 2 : Si <varname>A</varname> est une hypermatrice
117                                 <function>or()</function> est appliqué selon
118                                 sa n<superscript>ème</superscript> dimension.
119                                 <para>
120                                     Exemple: Si <literal>ndims(A)==3</literal>
121                                     et <literal>n=3</literal>,
122                                     <varname>b</varname> sera une matrice booléenne
123                                     de tailles <literal>size(A)([1 2])</literal>, avec
124                                     <literal>b(i,j) = or(A(i,j,:))</literal>.
125                                 </para>
126                             </listitem>
127                         </itemizedlist>
128                     </para>
129                 </listitem>
130             </varlistentry>
131         </variablelist>
132     </refsection>
133     <refsection role="description">
134         <title>Description</title>
135         <para>
136             <function>or()</function> applique un "OU" logique entre les éléments
137             de l'opérande unique <varname>A</varname>, et en calcule le résultat.
138         </para>
139         <para>
140             Pour appliquer un OU logique entre éléments respectifs de 2 tableaux
141             <literal>C</literal> et <literal>D</literal> de mêmes tailles,
142             utiliser l'opérateur dédié <varname>|</varname>.
143         </para>
144         <para>
145             Pourquoi <literal>or([])</literal> vaut-il <literal>%F</literal> ?
146             Quels que soient les tableaux compatibles <literal>B</literal> et
147             <literal>C</literal>,
148             <literal>or([B C]) == (or(B) | or(C))</literal>.
149             Or, pour <literal>B = []</literal>, <literal>or([B C])==or(C)</literal>.
150             Pour avoir toujours <literal>(or([]) | or(C)) == or(C)</literal>,
151             <literal>or([])</literal> doit impérativement être <literal>%F</literal>.
152         </para>
153     </refsection>
154     <refsection role="examples">
155         <title>Exemples</title>
156         <programlisting role="example"><![CDATA[
157 or([])
158 or(0)
159 or(0+0*%i)
160 or(%eps)
161 or(%i)
162 or(%nan)
163
164 // Projection à travers une dimension / selon une direction :
165 A = rand(2,5)<0.3
166 or(A)
167 or(A, "r")   // or(A, 1) est équivalent
168 or(A, "c")   // or(A, 2) est équivalent
169
170 // Utilisation entre entiers encodés :
171 A = int16(grand(3,5,"uin",-10,10));
172 A(abs(A)<8) = 0
173 or(A)
174 or(A,1)
175
176 // Avec une hypermatrice de nombres décimaux :
177 A = rand(3,4,2);
178 A(A<0.7) = 0
179 or(A,3)
180
181 // Avec une matrice encodée creuse :
182 A = sprand(70,100, 0.001)
183 or(A, "r")
184 or(A, "c")
185 ]]></programlisting>
186  <screen><![CDATA[--> or([])
187  ans  =
188   F
189
190 --> or(0)
191  ans  =
192   F
193
194 --> or(0+0*%i)
195  ans  =
196   F
197
198 --> or(%eps)
199  ans  =
200   T
201
202 --> or(%i)
203  ans  =
204   T
205
206 --> or(%nan)
207  ans  =
208   T
209
210 --> // Projection à travers une dimension / selon une direction :
211 --> A = rand(2,5)<0.3
212  A  =
213   T F F F F
214   F F T F F
215
216 --> or(A)
217  ans  =
218   T
219
220 --> or(A, "r")   // or(A, 1) est équivalent
221  ans  =
222   T F T F F
223
224 --> or(A, "c")   // or(A, 2) est équivalent
225  ans  =
226   T
227   T
228
229 --> // Utilisation entre entiers encodés :
230 --> A = int16(grand(3,5,"uin",-10,10));
231 --> A(abs(A)<8) = 0
232  A  =
233   0  0  0 -9  0
234   0 10  0  0  0
235   0  0  0  0  9
236
237 --> or(A)
238  ans  =
239   T
240
241 --> or(A,1)
242  ans  =
243   F T F T T
244
245
246 --> // Avec une hypermatrice de nombres décimaux :
247 --> A = rand(3,4,2);
248 --> A(A<0.7) = 0
249  A  =
250 (:,:,1)
251    0.   0.       0.   0.
252    0.   0.7065   0.   0.7227
253    0.   0.       0.   0.8977
254 (:,:,2)
255    0.       0.   0.       0.7901
256    0.       0.   0.       0.9809
257    0.9677   0.   0.7795   0.8187
258
259 --> or(A,3)
260  ans  =
261   F F F T
262   F T F T
263   T F T T
264
265
266 --> // Avec une matrice encodée creuse :
267 --> A = sprand(70,100, 0.001)
268  A  =
269 (  70,  100) sparse matrix
270
271 (  18,  53)   0.7943
272 (  23,  96)   0.4361
273 (  38,  34)   0.9275
274 (  56,   1)   0.1622
275 (  69,  98)   0.3112
276
277 --> or(A, "r")
278  ans  =
279 (  1,  100) sparse matrix
280
281 (  1,   1)  T
282 (  1,  34)  T
283 (  1,  53)  T
284 (  1,  96)  T
285 (  1,  98)  T
286
287 --> or(A, "c")
288  ans  =
289 (  70,  1) sparse matrix
290
291 (  18,  1)  T
292 (  23,  1)  T
293 (  38,  1)  T
294 (  56,  1)  T
295 (  69,  1)  T
296 ]]></screen>
297     </refsection>
298     <refsection role="see also">
299         <title>Voir aussi</title>
300         <simplelist type="inline">
301             <member>
302                 <link linkend="or_op">| (distributif)</link>
303             </member>
304             <member>
305                 <link linkend="and">and</link>
306             </member>
307             <member>
308                 <link linkend="not">~ not</link>
309             </member>
310         </simplelist>
311     </refsection>
312 </refentry>