blob: a3848ca6e6652b77f8ebef8605497ddf914437f4 [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/exp.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>exp.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>
</pre><pre class="rust"><code><span class="comment">/* origin: FreeBSD /usr/src/lib/msun/src/e_exp.c */
/*
* ====================================================
* Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
*
* Permission to use, copy, modify, and distribute this
* software is freely granted, provided that this notice
* is preserved.
* ====================================================
*/
/* exp(x)
* Returns the exponential of x.
*
* Method
* 1. Argument reduction:
* Reduce x to an r so that |r| &lt;= 0.5*ln2 ~ 0.34658.
* Given x, find r and integer k such that
*
* x = k*ln2 + r, |r| &lt;= 0.5*ln2.
*
* Here r will be represented as r = hi-lo for better
* accuracy.
*
* 2. Approximation of exp(r) by a special rational function on
* the interval [0,0.34658]:
* Write
* R(r**2) = r*(exp(r)+1)/(exp(r)-1) = 2 + r*r/6 - r**4/360 + ...
* We use a special Remez algorithm on [0,0.34658] to generate
* a polynomial of degree 5 to approximate R. The maximum error
* of this polynomial approximation is bounded by 2**-59. In
* other words,
* R(z) ~ 2.0 + P1*z + P2*z**2 + P3*z**3 + P4*z**4 + P5*z**5
* (where z=r*r, and the values of P1 to P5 are listed below)
* and
* | 5 | -59
* | 2.0+P1*z+...+P5*z - R(z) | &lt;= 2
* | |
* The computation of exp(r) thus becomes
* 2*r
* exp(r) = 1 + ----------
* R(r) - r
* r*c(r)
* = 1 + r + ----------- (for better accuracy)
* 2 - c(r)
* where
* 2 4 10
* c(r) = r - (P1*r + P2*r + ... + P5*r ).
*
* 3. Scale back to obtain exp(x):
* From step 1, we have
* exp(x) = 2^k * exp(r)
*
* Special cases:
* exp(INF) is INF, exp(NaN) is NaN;
* exp(-INF) is 0, and
* for finite argument, only exp(0)=1 is exact.
*
* Accuracy:
* according to an error analysis, the error is always less than
* 1 ulp (unit in the last place).
*
* Misc. info.
* For IEEE double
* if x &gt; 709.782712893383973096 then exp(x) overflows
* if x &lt; -745.133219101941108420 then exp(x) underflows
*/
</span><span class="kw">use </span><span class="kw">super</span>::scalbn;
<span class="kw">const </span>HALF: [f64; <span class="number">2</span>] = [<span class="number">0.5</span>, -<span class="number">0.5</span>];
<span class="kw">const </span>LN2HI: f64 = <span class="number">6.93147180369123816490e-01</span>; <span class="comment">/* 0x3fe62e42, 0xfee00000 */
</span><span class="kw">const </span>LN2LO: f64 = <span class="number">1.90821492927058770002e-10</span>; <span class="comment">/* 0x3dea39ef, 0x35793c76 */
</span><span class="kw">const </span>INVLN2: f64 = <span class="number">1.44269504088896338700e+00</span>; <span class="comment">/* 0x3ff71547, 0x652b82fe */
</span><span class="kw">const </span>P1: f64 = <span class="number">1.66666666666666019037e-01</span>; <span class="comment">/* 0x3FC55555, 0x5555553E */
</span><span class="kw">const </span>P2: f64 = -<span class="number">2.77777777770155933842e-03</span>; <span class="comment">/* 0xBF66C16C, 0x16BEBD93 */
</span><span class="kw">const </span>P3: f64 = <span class="number">6.61375632143793436117e-05</span>; <span class="comment">/* 0x3F11566A, 0xAF25DE2C */
</span><span class="kw">const </span>P4: f64 = -<span class="number">1.65339022054652515390e-06</span>; <span class="comment">/* 0xBEBBBD41, 0xC5D26BF1 */
</span><span class="kw">const </span>P5: f64 = <span class="number">4.13813679705723846039e-08</span>; <span class="comment">/* 0x3E663769, 0x72BEA4D0 */
</span><span class="doccomment">/// Exponential, base *e* (f64)
///
/// Calculate the exponential of `x`, that is, *e* raised to the power `x`
/// (where *e* is the base of the natural system of logarithms, approximately 2.71828).
</span><span class="attribute">#[cfg_attr(all(test, assert_no_panic), no_panic::no_panic)]
</span><span class="kw">pub fn </span>exp(<span class="kw-2">mut </span>x: f64) -&gt; f64 {
<span class="kw">let </span>x1p1023 = f64::from_bits(<span class="number">0x7fe0000000000000</span>); <span class="comment">// 0x1p1023 === 2 ^ 1023
</span><span class="kw">let </span>x1p_149 = f64::from_bits(<span class="number">0x36a0000000000000</span>); <span class="comment">// 0x1p-149 === 2 ^ -149
</span><span class="kw">let </span>hi: f64;
<span class="kw">let </span>lo: f64;
<span class="kw">let </span>c: f64;
<span class="kw">let </span>xx: f64;
<span class="kw">let </span>y: f64;
<span class="kw">let </span>k: i32;
<span class="kw">let </span>sign: i32;
<span class="kw">let </span><span class="kw-2">mut </span>hx: u32;
hx = (x.to_bits() &gt;&gt; <span class="number">32</span>) <span class="kw">as </span>u32;
sign = (hx &gt;&gt; <span class="number">31</span>) <span class="kw">as </span>i32;
hx &amp;= <span class="number">0x7fffffff</span>; <span class="comment">/* high word of |x| */
/* special cases */
</span><span class="kw">if </span>hx &gt;= <span class="number">0x4086232b </span>{
<span class="comment">/* if |x| &gt;= 708.39... */
</span><span class="kw">if </span>x.is_nan() {
<span class="kw">return </span>x;
}
<span class="kw">if </span>x &gt; <span class="number">709.782712893383973096 </span>{
<span class="comment">/* overflow if x!=inf */
</span>x <span class="kw-2">*</span>= x1p1023;
<span class="kw">return </span>x;
}
<span class="kw">if </span>x &lt; -<span class="number">708.39641853226410622 </span>{
<span class="comment">/* underflow if x!=-inf */
</span><span class="macro">force_eval!</span>((-x1p_149 / x) <span class="kw">as </span>f32);
<span class="kw">if </span>x &lt; -<span class="number">745.13321910194110842 </span>{
<span class="kw">return </span><span class="number">0.</span>;
}
}
}
<span class="comment">/* argument reduction */
</span><span class="kw">if </span>hx &gt; <span class="number">0x3fd62e42 </span>{
<span class="comment">/* if |x| &gt; 0.5 ln2 */
</span><span class="kw">if </span>hx &gt;= <span class="number">0x3ff0a2b2 </span>{
<span class="comment">/* if |x| &gt;= 1.5 ln2 */
</span>k = (INVLN2 * x + <span class="macro">i!</span>(HALF, sign <span class="kw">as </span>usize)) <span class="kw">as </span>i32;
} <span class="kw">else </span>{
k = <span class="number">1 </span>- sign - sign;
}
hi = x - k <span class="kw">as </span>f64 * LN2HI; <span class="comment">/* k*ln2hi is exact here */
</span>lo = k <span class="kw">as </span>f64 * LN2LO;
x = hi - lo;
} <span class="kw">else if </span>hx &gt; <span class="number">0x3e300000 </span>{
<span class="comment">/* if |x| &gt; 2**-28 */
</span>k = <span class="number">0</span>;
hi = x;
lo = <span class="number">0.</span>;
} <span class="kw">else </span>{
<span class="comment">/* inexact if x!=0 */
</span><span class="macro">force_eval!</span>(x1p1023 + x);
<span class="kw">return </span><span class="number">1. </span>+ x;
}
<span class="comment">/* x is now in primary range */
</span>xx = x * x;
c = x - xx * (P1 + xx * (P2 + xx * (P3 + xx * (P4 + xx * P5))));
y = <span class="number">1. </span>+ (x * c / (<span class="number">2. </span>- c) - lo + hi);
<span class="kw">if </span>k == <span class="number">0 </span>{
y
} <span class="kw">else </span>{
scalbn(y, k)
}
}
</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>