* Bug 16097 fixed: tanh() & coth() improved
[scilab.git] / scilab / modules / elementary_functions / help / fr_FR / trigonometry / coth.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) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2019 - Samuel GOUGEON
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"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19           xmlns:scilab="http://www.scilab.org" xml:id="coth" xml:lang="fr">
20     <refnamediv>
21         <refname>coth</refname>
22         <refpurpose>cotangente hyperbolique</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Séquence d'appel</title>
26         <synopsis>t = coth(x)</synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Paramètres</title>
30         <variablelist>
31             <varlistentry>
32                 <term>x</term>
33                 <listitem>
34                     <para>
35                        vecteur ou matrice de nombres réels ou complexes (encodée dense ou creuse).
36                     </para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>t</term>
41                 <listitem>
42                     <para>
43                       vecteur ou matrice de nombres réels ou complexes (toujours encodée en format dense).
44                     </para>
45                 </listitem>
46             </varlistentry>
47         </variablelist>
48     </refsection>
49     <refsection>
50         <title>Description</title>
51         <para>
52             Les éléments de <literal>t</literal> sont les cotangentes
53             hyperboliques des éléments de <literal>x</literal>.
54         </para>
55         <note>
56           <literal>coth(0)</literal> n'étant pas nul, le résultat pour toute matrice d'entrée
57           encodée creuse est encodé en format dense (comme avec <literal>cos()</literal>).
58         </note>
59     </refsection>
60     <refsection>
61         <title>Exemples</title>
62         <programlisting role="example"><![CDATA[
63 x = [1, 2*%i]
64 t = exp(x);
65 (t-ones(x)./t).\(t+ones(x)./t)
66 coth(x)
67 coth([-0 0])
68
69 // avec une matrice creuse :
70 s = sparse([1 1; 3 1; 2 2; 2 3; 1 3],[0.02 0.7 0.15 0.4 3],[3 3])
71 coth(s)   // => format dense
72  ]]></programlisting>
73     <screen>
74 --> (t-ones(x)./t).\(t+ones(x)./t)
75  ans  =
76    1.3130353   0.4576576i
77
78 --> coth(x)
79  ans  =
80    1.3130353   0.4576576i
81
82 --> coth([-0 0])
83  ans  =
84   -Inf   Inf
85
86 --> // avec une matrice creuse :
87 --> s = sparse([1 1; 3 1; 2 2; 2 3; 1 3],[0.02 0.7 0.15 0.4 3],[3 3])
88  s  =
89 (  3,  3) sparse matrix
90 (  1,  1)      0.02
91 (  1,  3)      3.
92 (  2,  2)      0.15
93 (  2,  3)      0.4
94 (  3,  1)      0.7
95
96 --> coth(s)   // => format dense
97  ans  =
98    50.006666   Inf         1.0049698
99    Inf         6.7165918   2.6319324
100    1.6546216   Inf         Inf
101 </screen>
102     </refsection>
103     <refsection role="see also">
104         <title>Voir aussi</title>
105         <simplelist type="inline">
106             <member>
107                 <link linkend="cotg">cotg</link>
108             </member>
109         </simplelist>
110     </refsection>
111     <refsection role="history">
112         <title>Historique</title>
113         <revhistory>
114             <revision>
115                 <revnumber>6.1.0</revnumber>
116                 <revdescription>
117                     Extension aux matrices creuses.
118                 </revdescription>
119             </revision>
120         </revhistory>
121     </refsection>
122 </refentry>