[doc] comparisons page improved
[scilab.git] / scilab / modules / elementary_functions / help / en_US / trigonometry / asinhm.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" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:id="asinhm" xml:lang="en">
17     <refnamediv>
18         <refname>asinhm</refname>
19         <refpurpose>matrix hyperbolic inverse sine</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>t=asinhm(x)</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>x, t</term>
30                 <listitem>
31                     <para>a real or complex square matrices</para>
32                 </listitem>
33             </varlistentry>
34         </variablelist>
35     </refsection>
36     <refsection>
37         <title>Description</title>
38         <para>
39             <function>asinhm</function> is the matrix hyperbolic inverse sine of the matrix <varname>x</varname>. Uses
40             the formula <code>t = logm(x+sqrtm(x*x+eye()))</code>. Results may be
41             not reliable for non-symmetric matrix.
42         </para>
43     </refsection>
44     <refsection>
45         <title>Examples</title>
46         <programlisting role="example"><![CDATA[
47 A=[1,2;2,3]
48 sinhm(asinhm(A))
49  ]]></programlisting>
50     </refsection>
51     <refsection role="see also">
52         <title>See also</title>
53         <simplelist type="inline">
54             <member>
55                 <link linkend="asinh">asinh</link>
56             </member>
57             <member>
58                 <link linkend="logm">logm</link>
59             </member>
60             <member>
61                 <link linkend="sqrtm">sqrtm</link>
62             </member>
63             <member>
64                 <link linkend="sinhm">sinhm</link>
65             </member>
66             <member>
67                 <link linkend="eye">eye</link>
68             </member>
69         </simplelist>
70     </refsection>
71 </refentry>