* Bug 16097 fixed: tanh() & coth() improved
[scilab.git] / scilab / modules / elementary_functions / help / en_US / trigonometry / tanh.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  *
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: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="tanh" xml:lang="en">
20     <refnamediv>
21         <refname>tanh</refname>
22         <refpurpose>hyperbolic tangent</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Syntax</title>
26         <synopsis>t = tanh(x)</synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Description</title>
30         <para>
31             The elements of <varname>t</varname> are the hyperbolic tangents of
32             the elements of <varname>x</varname>.
33         </para>
34     </refsection>
35     <refsection>
36         <title>Sample</title>
37         <scilab:image>
38             x=-%pi:0.01:%pi;
39             plot(x,tanh(x))
40         </scilab:image>
41     </refsection>
42     <refsection>
43         <title>Examples</title>
44         <programlisting role="example"><![CDATA[
45 x=[1,%i,-1,-%i]
46 tanh(x)
47 sinh(x)./cosh(x)
48  ]]></programlisting>
49     </refsection>
50     <refsection role="see also">
51         <title>See also</title>
52         <simplelist type="inline">
53             <member>
54                 <link linkend="atanh">atanh</link>
55             </member>
56             <member>
57                 <link linkend="tan">tan</link>
58             </member>
59             <member>
60                 <link linkend="tanhm">tanhm</link>
61             </member>
62         </simplelist>
63     </refsection>
64     <refsection role="history">
65         <title>History</title>
66         <revhistory>
67             <revision>
68                 <revnumber>6.1.0</revnumber>
69                 <revdescription>
70                     Extension to sparse matrices.
71                 </revdescription>
72             </revision>
73         </revhistory>
74     </refsection>
75 </refentry>