File: atanh.xml

package info (click to toggle)
scilab 5.2.2-9
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 334,832 kB
  • ctags: 52,586
  • sloc: xml: 526,945; ansic: 223,590; fortran: 163,080; java: 56,934; cpp: 33,840; tcl: 27,936; sh: 20,397; makefile: 9,908; ml: 9,451; perl: 1,323; cs: 614; lisp: 30
file content (117 lines) | stat: -rw-r--r-- 3,631 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 *
 -->
<refentry version="5.0-subset Scilab" xml:id="atanh" xml:lang="en"
          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">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>

  <refnamediv>
    <refname>atanh</refname>

    <refpurpose>hyperbolic tangent inverse</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>Calling Sequence</title>

    <synopsis>t=atanh(x)</synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Parameters</title>

    <variablelist>
      <varlistentry>
        <term>x</term>

        <listitem>
          <para>real or complex vector/matrix</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>t</term>

        <listitem>
          <para>real or complex vector/matrix</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Description</title>

    <para>The components of vector <literal>t</literal> are the hyperbolic
    tangent inverse of the corresponding entries of vector
    <literal>x</literal>. Definition domain is <literal>[-1,1]</literal> for
    the real function (see Remark).</para>
  </refsection>

  <refsection>
    <title>Remark</title>

    <para>In Scilab (as in some others numerical software) when you try to
    evaluate an elementary mathematical function outside its definition domain
    in the real case, then the complex extension is used (with a complex
    result). The more famous example being the sqrt function (try
    <literal>sqrt(-1)</literal> !). This approach have some drawbacks when you
    evaluate the function at a singular point which may led to different
    results when the point is considered as real or complex. For the
    <literal>atanh</literal> this occurs for <literal>-1</literal> and
    <literal>1</literal> because the at these points the imaginary part do not
    converge and so <literal>atanh(1) = +Inf + i NaN</literal> while
    <literal>atanh(1) = +Inf</literal> for the real case (as lim x-&gt;1- of
    atanh(x)). So when you evaluate this function on the vector <literal>[1
    2]</literal> then like <literal>2</literal> is outside the definition
    domain, the complex extension is used for all the vector and you get
    <literal>atanh(1) = +Inf + i NaN</literal> while you get <literal>atanh(1)
    = +Inf</literal> with <literal>[1 0.5]</literal> for instance.</para>
  </refsection>

  <refsection>
    <title>Examples</title>

    <programlisting role="example"><![CDATA[ 
// example 1
x=[0,%i,-%i]
tanh(atanh(x))

// example 2
x = [-%inf -3 -2 -1 0 1 2 3 %inf]
ieee(2)
atanh(tanh(x))

// example 3 (see Remark)
ieee(2)
atanh([1 2])
atanh([1 0.5])
 ]]></programlisting>
  </refsection>

  <refsection>
    <title>See Also</title>

    <simplelist type="inline">
      <member><link linkend="tanh">tanh</link></member>

      <member><link linkend="ieee">ieee</link></member>
    </simplelist>
  </refsection>
</refentry>