amath/doc/html/acosh_8c.html

272 lines
19 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>amath: lib/real/acosh.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">amath
&#160;<span id="projectnumber">1.6.2</span>
</div>
<div id="projectbrief">Simple command line calculator</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('acosh_8c.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">acosh.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="real_2prim_8h_source.html">prim.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="math_8h_source.html">math.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for acosh.c:</div>
<div class="dyncontent">
<div class="center"><img src="acosh_8c__incl.png" border="0" usemap="#lib_2real_2acosh_8c" alt=""/></div>
<map name="lib_2real_2acosh_8c" id="lib_2real_2acosh_8c">
<area shape="rect" id="node2" href="real_2prim_8h.html" title="prim.h" alt="" coords="5,80,64,107"/>
<area shape="rect" id="node3" href="math_8h.html" title="Functions in math library for handling real numbers. " alt="" coords="89,80,151,107"/>
</map>
</div>
</div>
<p><a href="acosh_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac862445bcb46911b1782c284829d5e46"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="acosh_8c.html#ac862445bcb46911b1782c284829d5e46">acosh</a> (double x)</td></tr>
<tr class="memdesc:ac862445bcb46911b1782c284829d5e46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverse hyperbolic cosine function. <a href="#ac862445bcb46911b1782c284829d5e46">More...</a><br /></td></tr>
<tr class="separator:ac862445bcb46911b1782c284829d5e46"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ada85e349d35971b32c8ea4238881ff8b"><td class="memItemLeft" align="right" valign="top">static const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="acosh_8c.html#ada85e349d35971b32c8ea4238881ff8b">one</a> = 1.0</td></tr>
<tr class="separator:ada85e349d35971b32c8ea4238881ff8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a703f4fc93e5a57058ce6ba2ba196918d"><td class="memItemLeft" align="right" valign="top">static const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="acosh_8c.html#a703f4fc93e5a57058ce6ba2ba196918d">ln2</a> = 6.93147180559945286227e-01</td></tr>
<tr class="separator:a703f4fc93e5a57058ce6ba2ba196918d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ac862445bcb46911b1782c284829d5e46"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double acosh </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Inverse hyperbolic cosine function. </p>
<dl class="section version"><dt>Version</dt><dd>1.3 </dd></dl>
<dl class="section date"><dt>Date</dt><dd>95/01/18</dd></dl>
<pre>
Method :
Based on
acosh(x) = log [ x + sqrt(x*x-1) ]
we have
acosh(x) := log(x)+ln2, if x is large; else
acosh(x) := log(2x-1/(sqrt(x*x-1)+x)) if x&gt;2; else
acosh(x) := log1p(t+sqrt(2.0*t+t*t)); where t=x-1.</pre><pre>Special cases:
acosh(x) is NaN with signal if x&lt;1.
acosh(NaN) is NaN without signal.
</pre> <dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) 1993 by Sun Microsystems, Inc. All rights reserved. Developed at SunSoft, a Sun Microsystems, Inc. business. Permission to use, copy, modify, and distribute this software is freely granted, provided that this notice is preserved. </dd></dl>
<p>Definition at line <a class="el" href="acosh_8c_source.html#l00075">75</a> of file <a class="el" href="acosh_8c_source.html">acosh.c</a>.</p>
<p>References <a class="el" href="acosh_8c_source.html#l00049">ln2</a>, <a class="el" href="log1p_8c_source.html#l00125">log1p()</a>, <a class="el" href="acosh_8c_source.html#l00048">one</a>, and <a class="el" href="sqrt_8c_source.html#l00127">sqrt()</a>.</p>
<p>Referenced by <a class="el" href="real_8cpp_source.html#l00477">RealNumber::HypArcCosine()</a>, and <a class="el" href="real_8cpp_source.html#l00487">RealNumber::HypArcSecant()</a>.</p>
<div class="fragment"><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;{</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">double</span> t;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <a class="code" href="real_2prim_8h.html#ae91287c8a5f73a8a22a100f50dc4de77">sword</a> hx, lx;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <a class="code" href="real_2prim_8h.html#ae62ee08d06ab4cc06d61dc1246b73195">GET_HIGH_WORD</a>(hx,x);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="real_2prim_8h.html#adee023704c856ea8f310e8e3fd765a22">GET_LOW_WORD</a>(lx,x);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">if</span>(hx&lt;0x3ff00000) { <span class="comment">/* x &lt; 1 */</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordflow">return</span> (x-x)/(x-x);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span>(hx &gt;=0x41b00000) { <span class="comment">/* x &gt; 2**28 */</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">if</span>(hx &gt;=0x7ff00000) { <span class="comment">/* x is inf of NaN */</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">return</span> x+x;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; } <span class="keywordflow">else</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> <a class="code" href="math_8h.html#adb302c9aafbaa5e180d9f60ee954bb82">log</a>(x)+<a class="code" href="acosh_8c.html#a703f4fc93e5a57058ce6ba2ba196918d">ln2</a>; <span class="comment">/* acosh(huge)=log(2x) */</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span>(((hx-0x3ff00000)|lx)==0) {</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordflow">return</span> 0.0; <span class="comment">/* acosh(1) = 0 */</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (hx &gt; 0x40000000) { <span class="comment">/* 2**28 &gt; x &gt; 2 */</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; t=x*x;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordflow">return</span> <a class="code" href="math_8h.html#adb302c9aafbaa5e180d9f60ee954bb82">log</a>(2.0*x-<a class="code" href="acosh_8c.html#ada85e349d35971b32c8ea4238881ff8b">one</a>/(x+<a class="code" href="math_8h.html#ab87521a75ef827a85807f89a6c10629a">sqrt</a>(t-<a class="code" href="acosh_8c.html#ada85e349d35971b32c8ea4238881ff8b">one</a>)));</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; } <span class="keywordflow">else</span> { <span class="comment">/* 1&lt;x&lt;2 */</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; t = x-<a class="code" href="acosh_8c.html#ada85e349d35971b32c8ea4238881ff8b">one</a>;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordflow">return</span> <a class="code" href="math_8h.html#ac2aac20ab1347498e6e4f209148fea84">log1p</a>(t+<a class="code" href="math_8h.html#ab87521a75ef827a85807f89a6c10629a">sqrt</a>(2.0*t+t*t));</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; }</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;}</div><div class="ttc" id="acosh_8c_html_ada85e349d35971b32c8ea4238881ff8b"><div class="ttname"><a href="acosh_8c.html#ada85e349d35971b32c8ea4238881ff8b">one</a></div><div class="ttdeci">static const double one</div><div class="ttdef"><b>Definition:</b> <a href="acosh_8c_source.html#l00048">acosh.c:48</a></div></div>
<div class="ttc" id="real_2prim_8h_html_ae62ee08d06ab4cc06d61dc1246b73195"><div class="ttname"><a href="real_2prim_8h.html#ae62ee08d06ab4cc06d61dc1246b73195">GET_HIGH_WORD</a></div><div class="ttdeci">#define GET_HIGH_WORD(i, d)</div><div class="ttdoc">Get the more significant 32 bit int from a double. </div><div class="ttdef"><b>Definition:</b> <a href="real_2prim_8h_source.html#l00165">prim.h:165</a></div></div>
<div class="ttc" id="math_8h_html_ac2aac20ab1347498e6e4f209148fea84"><div class="ttname"><a href="math_8h.html#ac2aac20ab1347498e6e4f209148fea84">log1p</a></div><div class="ttdeci">double log1p(double x)</div><div class="ttdef"><b>Definition:</b> <a href="log1p_8c_source.html#l00125">log1p.c:125</a></div></div>
<div class="ttc" id="real_2prim_8h_html_adee023704c856ea8f310e8e3fd765a22"><div class="ttname"><a href="real_2prim_8h.html#adee023704c856ea8f310e8e3fd765a22">GET_LOW_WORD</a></div><div class="ttdeci">#define GET_LOW_WORD(i, d)</div><div class="ttdoc">Get the less significant 32 bit int from a double. </div><div class="ttdef"><b>Definition:</b> <a href="real_2prim_8h_source.html#l00176">prim.h:176</a></div></div>
<div class="ttc" id="real_2prim_8h_html_ae91287c8a5f73a8a22a100f50dc4de77"><div class="ttname"><a href="real_2prim_8h.html#ae91287c8a5f73a8a22a100f50dc4de77">sword</a></div><div class="ttdeci">signed int sword</div><div class="ttdoc">32 bit signed integer. </div><div class="ttdef"><b>Definition:</b> <a href="real_2prim_8h_source.html#l00107">prim.h:107</a></div></div>
<div class="ttc" id="math_8h_html_ab87521a75ef827a85807f89a6c10629a"><div class="ttname"><a href="math_8h.html#ab87521a75ef827a85807f89a6c10629a">sqrt</a></div><div class="ttdeci">double sqrt(double x)</div><div class="ttdoc">Square root function. </div><div class="ttdef"><b>Definition:</b> <a href="sqrt_8c_source.html#l00127">sqrt.c:127</a></div></div>
<div class="ttc" id="math_8h_html_adb302c9aafbaa5e180d9f60ee954bb82"><div class="ttname"><a href="math_8h.html#adb302c9aafbaa5e180d9f60ee954bb82">log</a></div><div class="ttdeci">double log(double x)</div><div class="ttdoc">Natural logarithm function (base e). </div><div class="ttdef"><b>Definition:</b> <a href="log_8c_source.html#l00118">log.c:118</a></div></div>
<div class="ttc" id="acosh_8c_html_a703f4fc93e5a57058ce6ba2ba196918d"><div class="ttname"><a href="acosh_8c.html#a703f4fc93e5a57058ce6ba2ba196918d">ln2</a></div><div class="ttdeci">static const double ln2</div><div class="ttdef"><b>Definition:</b> <a href="acosh_8c_source.html#l00049">acosh.c:49</a></div></div>
</div><!-- fragment -->
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="acosh_8c_ac862445bcb46911b1782c284829d5e46_cgraph.png" border="0" usemap="#acosh_8c_ac862445bcb46911b1782c284829d5e46_cgraph" alt=""/></div>
<map name="acosh_8c_ac862445bcb46911b1782c284829d5e46_cgraph" id="acosh_8c_ac862445bcb46911b1782c284829d5e46_cgraph">
<area shape="rect" id="node2" href="log1p_8c.html#ac2aac20ab1347498e6e4f209148fea84" title="log1p" alt="" coords="111,5,164,32"/>
<area shape="rect" id="node3" href="sqrt_8c.html#ab87521a75ef827a85807f89a6c10629a" title="Square root function. " alt="" coords="115,56,159,83"/>
</map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="acosh_8c_ac862445bcb46911b1782c284829d5e46_icgraph.png" border="0" usemap="#acosh_8c_ac862445bcb46911b1782c284829d5e46_icgraph" alt=""/></div>
<map name="acosh_8c_ac862445bcb46911b1782c284829d5e46_icgraph" id="acosh_8c_ac862445bcb46911b1782c284829d5e46_icgraph">
<area shape="rect" id="node2" href="structRealNumber.html#a180b1d26d19c53070014c9540ca058a9" title="Inverse hyperbolic cosine function. " alt="" coords="111,5,299,32"/>
<area shape="rect" id="node3" href="structRealNumber.html#a2c63d0e9efa401cb5ff4a459f339dfb5" title="Inverse hyperbolic secant function. " alt="" coords="111,56,299,83"/>
</map>
</div>
</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="a703f4fc93e5a57058ce6ba2ba196918d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const double ln2 = 6.93147180559945286227e-01</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="acosh_8c_source.html#l00049">49</a> of file <a class="el" href="acosh_8c_source.html">acosh.c</a>.</p>
<p>Referenced by <a class="el" href="acosh_8c_source.html#l00075">acosh()</a>.</p>
</div>
</div>
<a class="anchor" id="ada85e349d35971b32c8ea4238881ff8b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const double one = 1.0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="acosh_8c_source.html#l00048">48</a> of file <a class="el" href="acosh_8c_source.html">acosh.c</a>.</p>
<p>Referenced by <a class="el" href="acosh_8c_source.html#l00075">acosh()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="dir_ca194a09c7a767aed9138a74a7cf8e10.html">real</a></li><li class="navelem"><a class="el" href="acosh_8c.html">acosh.c</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>