blob: 168437a7d6c208e0165648cb02e49a0e89a43450 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/libm-0.2.7/src/math/atan.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>atan.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../libm/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../libm/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
</pre><pre class="rust"><code><span class="comment">/* origin: FreeBSD /usr/src/lib/msun/src/s_atan.c */
/*
* ====================================================
* Copyright (C) 1993 by Sun Microsystems, Inc. All rights reserved.
*
* Developed at SunPro, a Sun Microsystems, Inc. business.
* Permission to use, copy, modify, and distribute this
* software is freely granted, provided that this notice
* is preserved.
* ====================================================
*/
/* atan(x)
* Method
* 1. Reduce x to positive by atan(x) = -atan(-x).
* 2. According to the integer k=4t+0.25 chopped, t=x, the argument
* is further reduced to one of the following intervals and the
* arctangent of t is evaluated by the corresponding formula:
*
* [0,7/16] atan(x) = t-t^3*(a1+t^2*(a2+...(a10+t^2*a11)...)
* [7/16,11/16] atan(x) = atan(1/2) + atan( (t-0.5)/(1+t/2) )
* [11/16.19/16] atan(x) = atan( 1 ) + atan( (t-1)/(1+t) )
* [19/16,39/16] atan(x) = atan(3/2) + atan( (t-1.5)/(1+1.5t) )
* [39/16,INF] atan(x) = atan(INF) + atan( -1/t )
*
* Constants:
* The hexadecimal values are the intended ones for the following
* constants. The decimal values may be used, provided that the
* compiler will convert from decimal to binary accurately enough
* to produce the hexadecimal values shown.
*/
</span><span class="kw">use </span><span class="kw">super</span>::fabs;
<span class="kw">use </span>core::f64;
<span class="kw">const </span>ATANHI: [f64; <span class="number">4</span>] = [
<span class="number">4.63647609000806093515e-01</span>, <span class="comment">/* atan(0.5)hi 0x3FDDAC67, 0x0561BB4F */
</span><span class="number">7.85398163397448278999e-01</span>, <span class="comment">/* atan(1.0)hi 0x3FE921FB, 0x54442D18 */
</span><span class="number">9.82793723247329054082e-01</span>, <span class="comment">/* atan(1.5)hi 0x3FEF730B, 0xD281F69B */
</span><span class="number">1.57079632679489655800e+00</span>, <span class="comment">/* atan(inf)hi 0x3FF921FB, 0x54442D18 */
</span>];
<span class="kw">const </span>ATANLO: [f64; <span class="number">4</span>] = [
<span class="number">2.26987774529616870924e-17</span>, <span class="comment">/* atan(0.5)lo 0x3C7A2B7F, 0x222F65E2 */
</span><span class="number">3.06161699786838301793e-17</span>, <span class="comment">/* atan(1.0)lo 0x3C81A626, 0x33145C07 */
</span><span class="number">1.39033110312309984516e-17</span>, <span class="comment">/* atan(1.5)lo 0x3C700788, 0x7AF0CBBD */
</span><span class="number">6.12323399573676603587e-17</span>, <span class="comment">/* atan(inf)lo 0x3C91A626, 0x33145C07 */
</span>];
<span class="kw">const </span>AT: [f64; <span class="number">11</span>] = [
<span class="number">3.33333333333329318027e-01</span>, <span class="comment">/* 0x3FD55555, 0x5555550D */
</span>-<span class="number">1.99999999998764832476e-01</span>, <span class="comment">/* 0xBFC99999, 0x9998EBC4 */
</span><span class="number">1.42857142725034663711e-01</span>, <span class="comment">/* 0x3FC24924, 0x920083FF */
</span>-<span class="number">1.11111104054623557880e-01</span>, <span class="comment">/* 0xBFBC71C6, 0xFE231671 */
</span><span class="number">9.09088713343650656196e-02</span>, <span class="comment">/* 0x3FB745CD, 0xC54C206E */
</span>-<span class="number">7.69187620504482999495e-02</span>, <span class="comment">/* 0xBFB3B0F2, 0xAF749A6D */
</span><span class="number">6.66107313738753120669e-02</span>, <span class="comment">/* 0x3FB10D66, 0xA0D03D51 */
</span>-<span class="number">5.83357013379057348645e-02</span>, <span class="comment">/* 0xBFADDE2D, 0x52DEFD9A */
</span><span class="number">4.97687799461593236017e-02</span>, <span class="comment">/* 0x3FA97B4B, 0x24760DEB */
</span>-<span class="number">3.65315727442169155270e-02</span>, <span class="comment">/* 0xBFA2B444, 0x2C6A6C2F */
</span><span class="number">1.62858201153657823623e-02</span>, <span class="comment">/* 0x3F90AD3A, 0xE322DA11 */
</span>];
<span class="doccomment">/// Arctangent (f64)
///
/// Computes the inverse tangent (arc tangent) of the input value.
/// Returns a value in radians, in the range of -pi/2 to pi/2.
</span><span class="attribute">#[cfg_attr(all(test, assert_no_panic), no_panic::no_panic)]
</span><span class="kw">pub fn </span>atan(x: f64) -&gt; f64 {
<span class="kw">let </span><span class="kw-2">mut </span>x = x;
<span class="kw">let </span><span class="kw-2">mut </span>ix = (x.to_bits() &gt;&gt; <span class="number">32</span>) <span class="kw">as </span>u32;
<span class="kw">let </span>sign = ix &gt;&gt; <span class="number">31</span>;
ix &amp;= <span class="number">0x7fff_ffff</span>;
<span class="kw">if </span>ix &gt;= <span class="number">0x4410_0000 </span>{
<span class="kw">if </span>x.is_nan() {
<span class="kw">return </span>x;
}
<span class="kw">let </span>z = ATANHI[<span class="number">3</span>] + f64::from_bits(<span class="number">0x0380_0000</span>); <span class="comment">// 0x1p-120f
</span><span class="kw">return if </span>sign != <span class="number">0 </span>{ -z } <span class="kw">else </span>{ z };
}
<span class="kw">let </span>id = <span class="kw">if </span>ix &lt; <span class="number">0x3fdc_0000 </span>{
<span class="comment">/* |x| &lt; 0.4375 */
</span><span class="kw">if </span>ix &lt; <span class="number">0x3e40_0000 </span>{
<span class="comment">/* |x| &lt; 2^-27 */
</span><span class="kw">if </span>ix &lt; <span class="number">0x0010_0000 </span>{
<span class="comment">/* raise underflow for subnormal x */
</span><span class="macro">force_eval!</span>(x <span class="kw">as </span>f32);
}
<span class="kw">return </span>x;
}
-<span class="number">1
</span>} <span class="kw">else </span>{
x = fabs(x);
<span class="kw">if </span>ix &lt; <span class="number">0x3ff30000 </span>{
<span class="comment">/* |x| &lt; 1.1875 */
</span><span class="kw">if </span>ix &lt; <span class="number">0x3fe60000 </span>{
<span class="comment">/* 7/16 &lt;= |x| &lt; 11/16 */
</span>x = (<span class="number">2. </span>* x - <span class="number">1.</span>) / (<span class="number">2. </span>+ x);
<span class="number">0
</span>} <span class="kw">else </span>{
<span class="comment">/* 11/16 &lt;= |x| &lt; 19/16 */
</span>x = (x - <span class="number">1.</span>) / (x + <span class="number">1.</span>);
<span class="number">1
</span>}
} <span class="kw">else if </span>ix &lt; <span class="number">0x40038000 </span>{
<span class="comment">/* |x| &lt; 2.4375 */
</span>x = (x - <span class="number">1.5</span>) / (<span class="number">1. </span>+ <span class="number">1.5 </span>* x);
<span class="number">2
</span>} <span class="kw">else </span>{
<span class="comment">/* 2.4375 &lt;= |x| &lt; 2^66 */
</span>x = -<span class="number">1. </span>/ x;
<span class="number">3
</span>}
};
<span class="kw">let </span>z = x * x;
<span class="kw">let </span>w = z * z;
<span class="comment">/* break sum from i=0 to 10 AT[i]z**(i+1) into odd and even poly */
</span><span class="kw">let </span>s1 = z * (AT[<span class="number">0</span>] + w * (AT[<span class="number">2</span>] + w * (AT[<span class="number">4</span>] + w * (AT[<span class="number">6</span>] + w * (AT[<span class="number">8</span>] + w * AT[<span class="number">10</span>])))));
<span class="kw">let </span>s2 = w * (AT[<span class="number">1</span>] + w * (AT[<span class="number">3</span>] + w * (AT[<span class="number">5</span>] + w * (AT[<span class="number">7</span>] + w * AT[<span class="number">9</span>]))));
<span class="kw">if </span>id &lt; <span class="number">0 </span>{
<span class="kw">return </span>x - x * (s1 + s2);
}
<span class="kw">let </span>z = <span class="macro">i!</span>(ATANHI, id <span class="kw">as </span>usize) - (x * (s1 + s2) - <span class="macro">i!</span>(ATANLO, id <span class="kw">as </span>usize) - x);
<span class="kw">if </span>sign != <span class="number">0 </span>{
-z
} <span class="kw">else </span>{
z
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::atan;
<span class="kw">use </span>core::f64;
<span class="attribute">#[test]
</span><span class="kw">fn </span>sanity_check() {
<span class="kw">for </span>(input, answer) <span class="kw">in </span>[
(<span class="number">3.0_f64</span>.sqrt() / <span class="number">3.0</span>, f64::consts::FRAC_PI_6),
(<span class="number">1.0</span>, f64::consts::FRAC_PI_4),
(<span class="number">3.0_f64</span>.sqrt(), f64::consts::FRAC_PI_3),
(-<span class="number">3.0_f64</span>.sqrt() / <span class="number">3.0</span>, -f64::consts::FRAC_PI_6),
(-<span class="number">1.0</span>, -f64::consts::FRAC_PI_4),
(-<span class="number">3.0_f64</span>.sqrt(), -f64::consts::FRAC_PI_3),
]
.iter()
{
<span class="macro">assert!</span>(
(atan(<span class="kw-2">*</span>input) - answer) / answer &lt; <span class="number">1e-5</span>,
<span class="string">&quot;\natan({:.4}/16) = {:.4}, actual: {}&quot;</span>,
input * <span class="number">16.0</span>,
answer,
atan(<span class="kw-2">*</span>input)
);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>zero() {
<span class="macro">assert_eq!</span>(atan(<span class="number">0.0</span>), <span class="number">0.0</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>infinity() {
<span class="macro">assert_eq!</span>(atan(f64::INFINITY), f64::consts::FRAC_PI_2);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>minus_infinity() {
<span class="macro">assert_eq!</span>(atan(f64::NEG_INFINITY), -f64::consts::FRAC_PI_2);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>nan() {
<span class="macro">assert!</span>(atan(f64::NAN).is_nan());
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="libm" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>