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