* Bug 16026 fixed: atanh() page and m2sci updated
[scilab.git] / scilab / modules / m2sci / help / en_US / m2sci_equivalents / a / atanh.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) 2009 - DIGITEO - Vincent COUVERT
5  *
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"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:id="m2sci_atanh">
20     <refnamediv>
21         <refname>atanh (Matlab function)</refname>
22         <refpurpose>Inverse hyperbolic tangent</refpurpose>
23     </refnamediv>
24     <refsection>
25         <title>Matlab/Scilab equivalent</title>
26         <informaltable border="1" width="100%">
27             <tr>
28                 <td align="center">
29                     <emphasis role="bold">Matlab</emphasis>
30                 </td>
31                 <td align="center">
32                     <emphasis role="bold">Scilab</emphasis>
33                 </td>
34             </tr>
35             <tr>
36                 <td>
37                     <programlisting role="no-scilab-exec"><![CDATA[
38 atanh
39 ]]></programlisting>
40                 </td>
41                 <td>
42                     <programlisting role="no-scilab-exec"><![CDATA[
43 atanh
44 ]]></programlisting>
45                 </td>
46             </tr>
47         </informaltable>
48     </refsection>
49     <refsection>
50         <title>Particular cases</title>
51         <para>
52             In y=atanh(x), for real elements of x &lt; -1, the complex part of Scilab y value is the
53             opposite of Matlab y value.
54         </para>
55         <para>
56           Examples
57         <informaltable border="1" width="100%">
58             <tr>
59                 <th>Matlab</th>
60                 <th>Scilab</th>
61             </tr>
62             <tr>
63                 <td>
64                     <programlisting role="no-scilab-exec"><![CDATA[
65 y = atanh(-2)
66 y = -0.5493 - 1.5708i
67 ]]></programlisting>
68                 </td>
69                 <td>
70                     <programlisting role="no-scilab-exec"><![CDATA[
71 y = atanh(-2)
72 y = -0.5493061 + 1.5707963i
73 ]]></programlisting>
74                 </td>
75             </tr>
76         </informaltable>
77         </para>
78     </refsection>
79 </refentry>