blob: 00609e5b640a16097c9677ea2e75b59d0401102d [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/expm1.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>expm1.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>
</pre><pre class="rust"><code><span class="comment">/* origin: FreeBSD /usr/src/lib/msun/src/s_expm1.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.
* ====================================================
*/
</span><span class="kw">use </span>core::f64;
<span class="kw">const </span>O_THRESHOLD: f64 = <span class="number">7.09782712893383973096e+02</span>; <span class="comment">/* 0x40862E42, 0xFEFA39EF */
</span><span class="kw">const </span>LN2_HI: f64 = <span class="number">6.93147180369123816490e-01</span>; <span class="comment">/* 0x3fe62e42, 0xfee00000 */
</span><span class="kw">const </span>LN2_LO: 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 */
/* Scaled Q&#39;s: Qn_here = 2**n * Qn_above, for R(2*z) where z = hxs = x*x/2: */
</span><span class="kw">const </span>Q1: f64 = -<span class="number">3.33333333333331316428e-02</span>; <span class="comment">/* BFA11111 111110F4 */
</span><span class="kw">const </span>Q2: f64 = <span class="number">1.58730158725481460165e-03</span>; <span class="comment">/* 3F5A01A0 19FE5585 */
</span><span class="kw">const </span>Q3: f64 = -<span class="number">7.93650757867487942473e-05</span>; <span class="comment">/* BF14CE19 9EAADBB7 */
</span><span class="kw">const </span>Q4: f64 = <span class="number">4.00821782732936239552e-06</span>; <span class="comment">/* 3ED0CFCA 86E65239 */
</span><span class="kw">const </span>Q5: f64 = -<span class="number">2.01099218183624371326e-07</span>; <span class="comment">/* BE8AFDB7 6E09C32D */
</span><span class="doccomment">/// Exponential, base *e*, of x-1 (f64)
///
/// Calculates the exponential of `x` and subtract 1, that is, *e* raised
/// to the power `x` minus 1 (where *e* is the base of the natural
/// system of logarithms, approximately 2.71828).
/// The result is accurate even for small values of `x`,
/// where using `exp(x)-1` would lose many significant digits.
</span><span class="attribute">#[cfg_attr(all(test, assert_no_panic), no_panic::no_panic)]
</span><span class="kw">pub fn </span>expm1(<span class="kw-2">mut </span>x: f64) -&gt; f64 {
<span class="kw">let </span>hi: f64;
<span class="kw">let </span>lo: f64;
<span class="kw">let </span>k: i32;
<span class="kw">let </span>c: f64;
<span class="kw">let </span><span class="kw-2">mut </span>t: f64;
<span class="kw">let </span><span class="kw-2">mut </span>y: f64;
<span class="kw">let </span><span class="kw-2">mut </span>ui = x.to_bits();
<span class="kw">let </span>hx = ((ui &gt;&gt; <span class="number">32</span>) &amp; <span class="number">0x7fffffff</span>) <span class="kw">as </span>u32;
<span class="kw">let </span>sign = (ui &gt;&gt; <span class="number">63</span>) <span class="kw">as </span>i32;
<span class="comment">/* filter out huge and non-finite argument */
</span><span class="kw">if </span>hx &gt;= <span class="number">0x4043687A </span>{
<span class="comment">/* if |x|&gt;=56*ln2 */
</span><span class="kw">if </span>x.is_nan() {
<span class="kw">return </span>x;
}
<span class="kw">if </span>sign != <span class="number">0 </span>{
<span class="kw">return </span>-<span class="number">1.0</span>;
}
<span class="kw">if </span>x &gt; O_THRESHOLD {
x <span class="kw-2">*</span>= f64::from_bits(<span class="number">0x7fe0000000000000</span>);
<span class="kw">return </span>x;
}
}
<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 &lt; <span class="number">0x3FF0A2B2 </span>{
<span class="comment">/* and |x| &lt; 1.5 ln2 */
</span><span class="kw">if </span>sign == <span class="number">0 </span>{
hi = x - LN2_HI;
lo = LN2_LO;
k = <span class="number">1</span>;
} <span class="kw">else </span>{
hi = x + LN2_HI;
lo = -LN2_LO;
k = -<span class="number">1</span>;
}
} <span class="kw">else </span>{
k = (INVLN2 * x + <span class="kw">if </span>sign != <span class="number">0 </span>{ -<span class="number">0.5 </span>} <span class="kw">else </span>{ <span class="number">0.5 </span>}) <span class="kw">as </span>i32;
t = k <span class="kw">as </span>f64;
hi = x - t * LN2_HI; <span class="comment">/* t*ln2_hi is exact here */
</span>lo = t * LN2_LO;
}
x = hi - lo;
c = (hi - x) - lo;
} <span class="kw">else if </span>hx &lt; <span class="number">0x3c900000 </span>{
<span class="comment">/* |x| &lt; 2**-54, return x */
</span><span class="kw">if </span>hx &lt; <span class="number">0x00100000 </span>{
<span class="macro">force_eval!</span>(x);
}
<span class="kw">return </span>x;
} <span class="kw">else </span>{
c = <span class="number">0.0</span>;
k = <span class="number">0</span>;
}
<span class="comment">/* x is now in primary range */
</span><span class="kw">let </span>hfx = <span class="number">0.5 </span>* x;
<span class="kw">let </span>hxs = x * hfx;
<span class="kw">let </span>r1 = <span class="number">1.0 </span>+ hxs * (Q1 + hxs * (Q2 + hxs * (Q3 + hxs * (Q4 + hxs * Q5))));
t = <span class="number">3.0 </span>- r1 * hfx;
<span class="kw">let </span><span class="kw-2">mut </span>e = hxs * ((r1 - t) / (<span class="number">6.0 </span>- x * t));
<span class="kw">if </span>k == <span class="number">0 </span>{
<span class="comment">/* c is 0 */
</span><span class="kw">return </span>x - (x * e - hxs);
}
e = x * (e - c) - c;
e -= hxs;
<span class="comment">/* exp(x) ~ 2^k (x_reduced - e + 1) */
</span><span class="kw">if </span>k == -<span class="number">1 </span>{
<span class="kw">return </span><span class="number">0.5 </span>* (x - e) - <span class="number">0.5</span>;
}
<span class="kw">if </span>k == <span class="number">1 </span>{
<span class="kw">if </span>x &lt; -<span class="number">0.25 </span>{
<span class="kw">return </span>-<span class="number">2.0 </span>* (e - (x + <span class="number">0.5</span>));
}
<span class="kw">return </span><span class="number">1.0 </span>+ <span class="number">2.0 </span>* (x - e);
}
ui = ((<span class="number">0x3ff </span>+ k) <span class="kw">as </span>u64) &lt;&lt; <span class="number">52</span>; <span class="comment">/* 2^k */
</span><span class="kw">let </span>twopk = f64::from_bits(ui);
<span class="kw">if </span>k &lt; <span class="number">0 </span>|| k &gt; <span class="number">56 </span>{
<span class="comment">/* suffice to return exp(x)-1 */
</span>y = x - e + <span class="number">1.0</span>;
<span class="kw">if </span>k == <span class="number">1024 </span>{
y = y * <span class="number">2.0 </span>* f64::from_bits(<span class="number">0x7fe0000000000000</span>);
} <span class="kw">else </span>{
y = y * twopk;
}
<span class="kw">return </span>y - <span class="number">1.0</span>;
}
ui = ((<span class="number">0x3ff </span>- k) <span class="kw">as </span>u64) &lt;&lt; <span class="number">52</span>; <span class="comment">/* 2^-k */
</span><span class="kw">let </span>uf = f64::from_bits(ui);
<span class="kw">if </span>k &lt; <span class="number">20 </span>{
y = (x - e + (<span class="number">1.0 </span>- uf)) * twopk;
} <span class="kw">else </span>{
y = (x - (e + uf) + <span class="number">1.0</span>) * twopk;
}
y
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="attribute">#[test]
</span><span class="kw">fn </span>sanity_check() {
<span class="macro">assert_eq!</span>(<span class="kw">super</span>::expm1(<span class="number">1.1</span>), <span class="number">2.0041660239464334</span>);
}
}
</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>