blob: fee11109903c0bc4326bbf6b1dd37a3a2e9ab9f3 [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/log.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>log.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>
</pre><pre class="rust"><code><span class="comment">/* origin: FreeBSD /usr/src/lib/msun/src/e_log.c */
/*
* ====================================================
* 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.
* ====================================================
*/
/* log(x)
* Return the logarithm of x
*
* Method :
* 1. Argument Reduction: find k and f such that
* x = 2^k * (1+f),
* where sqrt(2)/2 &lt; 1+f &lt; sqrt(2) .
*
* 2. Approximation of log(1+f).
* Let s = f/(2+f) ; based on log(1+f) = log(1+s) - log(1-s)
* = 2s + 2/3 s**3 + 2/5 s**5 + .....,
* = 2s + s*R
* We use a special Remez algorithm on [0,0.1716] to generate
* a polynomial of degree 14 to approximate R The maximum error
* of this polynomial approximation is bounded by 2**-58.45. In
* other words,
* 2 4 6 8 10 12 14
* R(z) ~ Lg1*s +Lg2*s +Lg3*s +Lg4*s +Lg5*s +Lg6*s +Lg7*s
* (the values of Lg1 to Lg7 are listed in the program)
* and
* | 2 14 | -58.45
* | Lg1*s +...+Lg7*s - R(z) | &lt;= 2
* | |
* Note that 2s = f - s*f = f - hfsq + s*hfsq, where hfsq = f*f/2.
* In order to guarantee error in log below 1ulp, we compute log
* by
* log(1+f) = f - s*(f - R) (if f is not too large)
* log(1+f) = f - (hfsq - s*(hfsq+R)). (better accuracy)
*
* 3. Finally, log(x) = k*ln2 + log(1+f).
* = k*ln2_hi+(f-(hfsq-(s*(hfsq+R)+k*ln2_lo)))
* Here ln2 is split into two floating point number:
* ln2_hi + ln2_lo,
* where n*ln2_hi is always exact for |n| &lt; 2000.
*
* Special cases:
* log(x) is NaN with signal if x &lt; 0 (including -INF) ;
* log(+INF) is +INF; log(0) is -INF with signal;
* log(NaN) is that NaN with no signal.
*
* Accuracy:
* according to an error analysis, the error is always less than
* 1 ulp (unit in the last place).
*
* 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">const </span>LN2_HI: f64 = <span class="number">6.93147180369123816490e-01</span>; <span class="comment">/* 3fe62e42 fee00000 */
</span><span class="kw">const </span>LN2_LO: f64 = <span class="number">1.90821492927058770002e-10</span>; <span class="comment">/* 3dea39ef 35793c76 */
</span><span class="kw">const </span>LG1: f64 = <span class="number">6.666666666666735130e-01</span>; <span class="comment">/* 3FE55555 55555593 */
</span><span class="kw">const </span>LG2: f64 = <span class="number">3.999999999940941908e-01</span>; <span class="comment">/* 3FD99999 9997FA04 */
</span><span class="kw">const </span>LG3: f64 = <span class="number">2.857142874366239149e-01</span>; <span class="comment">/* 3FD24924 94229359 */
</span><span class="kw">const </span>LG4: f64 = <span class="number">2.222219843214978396e-01</span>; <span class="comment">/* 3FCC71C5 1D8E78AF */
</span><span class="kw">const </span>LG5: f64 = <span class="number">1.818357216161805012e-01</span>; <span class="comment">/* 3FC74664 96CB03DE */
</span><span class="kw">const </span>LG6: f64 = <span class="number">1.531383769920937332e-01</span>; <span class="comment">/* 3FC39A09 D078C69F */
</span><span class="kw">const </span>LG7: f64 = <span class="number">1.479819860511658591e-01</span>; <span class="comment">/* 3FC2F112 DF3E5244 */
</span><span class="attribute">#[cfg_attr(all(test, assert_no_panic), no_panic::no_panic)]
</span><span class="kw">pub fn </span>log(<span class="kw-2">mut </span>x: f64) -&gt; f64 {
<span class="kw">let </span>x1p54 = f64::from_bits(<span class="number">0x4350000000000000</span>); <span class="comment">// 0x1p54 === 2 ^ 54
</span><span class="kw">let </span><span class="kw-2">mut </span>ui = x.to_bits();
<span class="kw">let </span><span class="kw-2">mut </span>hx: u32 = (ui &gt;&gt; <span class="number">32</span>) <span class="kw">as </span>u32;
<span class="kw">let </span><span class="kw-2">mut </span>k: i32 = <span class="number">0</span>;
<span class="kw">if </span>(hx &lt; <span class="number">0x00100000</span>) || ((hx &gt;&gt; <span class="number">31</span>) != <span class="number">0</span>) {
<span class="comment">/* x &lt; 2**-126 */
</span><span class="kw">if </span>ui &lt;&lt; <span class="number">1 </span>== <span class="number">0 </span>{
<span class="kw">return </span>-<span class="number">1. </span>/ (x * x); <span class="comment">/* log(+-0)=-inf */
</span>}
<span class="kw">if </span>hx &gt;&gt; <span class="number">31 </span>!= <span class="number">0 </span>{
<span class="kw">return </span>(x - x) / <span class="number">0.0</span>; <span class="comment">/* log(-#) = NaN */
</span>}
<span class="comment">/* subnormal number, scale x up */
</span>k -= <span class="number">54</span>;
x <span class="kw-2">*</span>= x1p54;
ui = x.to_bits();
hx = (ui &gt;&gt; <span class="number">32</span>) <span class="kw">as </span>u32;
} <span class="kw">else if </span>hx &gt;= <span class="number">0x7ff00000 </span>{
<span class="kw">return </span>x;
} <span class="kw">else if </span>hx == <span class="number">0x3ff00000 </span>&amp;&amp; ui &lt;&lt; <span class="number">32 </span>== <span class="number">0 </span>{
<span class="kw">return </span><span class="number">0.</span>;
}
<span class="comment">/* reduce x into [sqrt(2)/2, sqrt(2)] */
</span>hx += <span class="number">0x3ff00000 </span>- <span class="number">0x3fe6a09e</span>;
k += ((hx &gt;&gt; <span class="number">20</span>) <span class="kw">as </span>i32) - <span class="number">0x3ff</span>;
hx = (hx &amp; <span class="number">0x000fffff</span>) + <span class="number">0x3fe6a09e</span>;
ui = ((hx <span class="kw">as </span>u64) &lt;&lt; <span class="number">32</span>) | (ui &amp; <span class="number">0xffffffff</span>);
x = f64::from_bits(ui);
<span class="kw">let </span>f: f64 = x - <span class="number">1.0</span>;
<span class="kw">let </span>hfsq: f64 = <span class="number">0.5 </span>* f * f;
<span class="kw">let </span>s: f64 = f / (<span class="number">2.0 </span>+ f);
<span class="kw">let </span>z: f64 = s * s;
<span class="kw">let </span>w: f64 = z * z;
<span class="kw">let </span>t1: f64 = w * (LG2 + w * (LG4 + w * LG6));
<span class="kw">let </span>t2: f64 = z * (LG1 + w * (LG3 + w * (LG5 + w * LG7)));
<span class="kw">let </span>r: f64 = t2 + t1;
<span class="kw">let </span>dk: f64 = k <span class="kw">as </span>f64;
s * (hfsq + r) + dk * LN2_LO - hfsq + f + dk * LN2_HI
}
</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>