* Bug 15535 fixed: sign(int8(0)) was wrong. sign() page improved
[scilab.git] / scilab / modules / elementary_functions / help / fr_FR / matrixoperations / sign.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) 2015, 2016, 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="sign" xml:lang="fr">
21     <refnamediv>
22         <refname>sign</refname>
23         <refpurpose>fonction signe</refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>Syntaxe</title>
27         <synopsis>X = sign(A)</synopsis>
28     </refsynopsisdiv>
29     <refsection role="parameters">
30         <title>Paramètres</title>
31         <variablelist>
32             <varlistentry>
33                 <term>А</term>
34                 <listitem>
35                     <para>
36                         Matrice d'entiers encodés, de nombres décimaux, ou de nombres complexes.
37                         <varname>A</varname> peut être encodée creuse.
38                     </para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>X</term>
43                 <listitem>
44                     <para>
45                         Matrice de taille et de type de données identiques à ceux de
46                         <varname>A</varname>.
47                     </para>
48                 </listitem>
49             </varlistentry>
50         </variablelist>
51     </refsection>
52     <refsection role="description">
53         <title>Description</title>
54         <para>
55             Si <varname>X</varname> sont des entiers encodés ou des nombres décimaux,
56             <itemizedlist>
57                 <listitem>
58                     <literal>X(i) = -1</literal> lorsque <literal>A(i)&lt;0</literal>
59                 </listitem>
60                 <listitem>
61                     <literal>X(i) = 0</literal> lorsque <literal>A(i)==0</literal>
62                 </listitem>
63                 <listitem>
64                     <literal>X(i) = 1</literal> lorsque <literal>A(i)>0</literal>
65                 </listitem>
66                 <listitem>
67                     <literal>X(i)= %nan</literal> lorsque <literal>A(i)</literal> est NaN.
68                 </listitem>
69             </itemizedlist>
70         </para>
71         <para>
72             Si <varname>X</varname> est encodée en nombres complexes :
73             <literal>sign(A==0) = 0</literal>. Ailleurs, <literal>sign(A) = A./abs(A)</literal>.
74         </para>
75     </refsection>
76     <refsection role="examples">
77         <title>Exemples</title>
78         <para>Avec des nombres décimaux :</para>
79         <programlisting role="example"><![CDATA[
80 m  = [ 1.25  -2.5  -%inf   2.75
81        0.     1.    0.75   %inf
82        %nan   0.   -1.5   -2.5 ]; m
83 sign(m)
84  ]]></programlisting>
85     <screen><![CDATA[
86 --> m  =
87    1.25  -2.5  -Inf    2.75
88    0.     1.    0.75   Inf
89    Nan    0.   -1.5   -2.5
90
91 --> sign(m)
92  ans  =
93    1.   -1.  -1.   1.
94    0.    1.   1.   1.
95    Nan   0.  -1.  -1.
96 ]]></screen>
97     <para>Avec des nombres complexes :</para>
98     <programlisting role="example"><![CDATA[
99 i = %i;
100 c = [-1, -i, -3+4*i
101       1,  i,  3+4*i
102       3,  0,  3-4*i
103      -4, 4*i,-4-3*i ];
104 c
105 sign(c)
106  ]]></programlisting>
107     <screen><![CDATA[
108 --> c  =
109   -1.  -i     -3. + 4.i
110    1.   i      3. + 4.i
111    3.   0.     3. - 4.i
112   -4.   4.i   -4. - 3.i
113
114 --> sign(c)
115  ans  =
116   -1.  -i     -0.6 + 0.8i
117    1.   i      0.6 + 0.8i
118    1.   0.     0.6 - 0.8i
119   -1.   i     -0.8 - 0.6i
120 ]]></screen>
121     <para>Avec une matrice creuse:</para>
122     <programlisting role="example"><![CDATA[
123 sign(sprand(8,3,0.3,"normal"))
124  ]]></programlisting>
125     </refsection>
126     <refsection role="see also">
127         <title>Voir aussi</title>
128         <simplelist type="inline">
129             <member>
130                 <link linkend="abs">abs</link>
131             </member>
132             <member>
133                 <link linkend="csgn">csgn</link>
134             </member>
135             <member>
136                 <link linkend="signm">signm</link>
137             </member>
138         </simplelist>
139     </refsection>
140     <refsection role="history">
141         <title>Historique</title>
142         <revhistory>
143             <revision>
144                 <revnumber>6.0</revnumber>
145                 <revdescription>Extension aux matrices creuses
146                 </revdescription>
147             </revision>
148         </revhistory>
149     </refsection>
150 </refentry>