blob: 3e440d68dd4e044625c500cf398de2a15f71ee29 [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 `&#x2F;home&#x2F;runner&#x2F;.cargo&#x2F;registry&#x2F;src&#x2F;github.com-1ecc6299db9ec823&#x2F;libm-0.2.1&#x2F;src&#x2F;math&#x2F;fmaf.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>fmaf.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" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script src="../../../crates.js"></script><script defer src="../../../main.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.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"><div class="sidebar-menu" role="button">&#9776;</div><a class="sidebar-logo" href="../../../libm/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.png" alt="logo"></div>
</a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../libm/index.html"><img class="rust-logo" src="../../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div>
<input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="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>
</pre><pre class="rust"><code><span class="comment">/* origin: FreeBSD /usr/src/lib/msun/src/s_fmaf.c */</span>
<span class="comment">/*-
* Copyright (c) 2005-2011 David Schultz &lt;das@FreeBSD.ORG&gt;
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS&#39;&#39; AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/</span>
<span class="kw">use</span> <span class="ident">core::f32</span>;
<span class="kw">use</span> <span class="ident">core::ptr::read_volatile</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::fenv</span>::{
<span class="ident">feclearexcept</span>, <span class="ident">fegetround</span>, <span class="ident">feraiseexcept</span>, <span class="ident">fesetround</span>, <span class="ident">fetestexcept</span>, <span class="ident">FE_INEXACT</span>, <span class="ident">FE_TONEAREST</span>,
<span class="ident">FE_TOWARDZERO</span>, <span class="ident">FE_UNDERFLOW</span>,
};
<span class="comment">/*
* Fused multiply-add: Compute x * y + z with a single rounding error.
*
* A double has more than twice as much precision than a float, so
* direct double-precision arithmetic suffices, except where double
* rounding occurs.
*/</span>
<span class="doccomment">/// Floating multiply add (f32)</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Computes `(x*y)+z`, rounded as one ternary operation:</span>
<span class="doccomment">/// Computes the value (as if) to infinite precision and rounds once to the result format,</span>
<span class="doccomment">/// according to the rounding mode characterized by the value of FLT_ROUNDS.</span>
<span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">all</span>(<span class="ident">test</span>, <span class="ident">assert_no_panic</span>), <span class="ident">no_panic::no_panic</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">fmaf</span>(<span class="ident">x</span>: <span class="ident">f32</span>, <span class="ident">y</span>: <span class="ident">f32</span>, <span class="kw-2">mut</span> <span class="ident">z</span>: <span class="ident">f32</span>) -&gt; <span class="ident">f32</span> {
<span class="kw">let</span> <span class="ident">xy</span>: <span class="ident">f64</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span>: <span class="ident">f64</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">ui</span>: <span class="ident">u64</span>;
<span class="kw">let</span> <span class="ident">e</span>: <span class="ident">i32</span>;
<span class="ident">xy</span> <span class="op">=</span> <span class="ident">x</span> <span class="kw">as</span> <span class="ident">f64</span> <span class="op">*</span> <span class="ident">y</span> <span class="kw">as</span> <span class="ident">f64</span>;
<span class="ident">result</span> <span class="op">=</span> <span class="ident">xy</span> <span class="op">+</span> <span class="ident">z</span> <span class="kw">as</span> <span class="ident">f64</span>;
<span class="ident">ui</span> <span class="op">=</span> <span class="ident">result</span>.<span class="ident">to_bits</span>();
<span class="ident">e</span> <span class="op">=</span> (<span class="ident">ui</span> <span class="op">&gt;</span><span class="op">&gt;</span> <span class="number">52</span>) <span class="kw">as</span> <span class="ident">i32</span> <span class="op">&amp;</span> <span class="number">0x7ff</span>;
<span class="comment">/* Common case: The double precision result is fine. */</span>
<span class="kw">if</span> (
<span class="comment">/* not a halfway case */</span>
<span class="ident">ui</span> <span class="op">&amp;</span> <span class="number">0x1fffffff</span>) <span class="op">!</span><span class="op">=</span> <span class="number">0x10000000</span> <span class="op">|</span><span class="op">|</span>
<span class="comment">/* NaN */</span>
<span class="ident">e</span> <span class="op">==</span> <span class="number">0x7ff</span> <span class="op">|</span><span class="op">|</span>
<span class="comment">/* exact */</span>
(<span class="ident">result</span> <span class="op">-</span> <span class="ident">xy</span> <span class="op">==</span> <span class="ident">z</span> <span class="kw">as</span> <span class="ident">f64</span> <span class="op">&amp;&amp;</span> <span class="ident">result</span> <span class="op">-</span> <span class="ident">z</span> <span class="kw">as</span> <span class="ident">f64</span> <span class="op">==</span> <span class="ident">xy</span>) <span class="op">|</span><span class="op">|</span>
<span class="comment">/* not round-to-nearest */</span>
<span class="ident">fegetround</span>() <span class="op">!</span><span class="op">=</span> <span class="ident">FE_TONEAREST</span>
{
<span class="comment">/*
underflow may not be raised correctly, example:
fmaf(0x1p-120f, 0x1p-120f, 0x1p-149f)
*/</span>
<span class="kw">if</span> <span class="ident">e</span> <span class="op">&lt;</span> <span class="number">0x3ff</span> <span class="op">-</span> <span class="number">126</span> <span class="op">&amp;&amp;</span> <span class="ident">e</span> <span class="op">&gt;</span><span class="op">=</span> <span class="number">0x3ff</span> <span class="op">-</span> <span class="number">149</span> <span class="op">&amp;&amp;</span> <span class="ident">fetestexcept</span>(<span class="ident">FE_INEXACT</span>) <span class="op">!</span><span class="op">=</span> <span class="number">0</span> {
<span class="ident">feclearexcept</span>(<span class="ident">FE_INEXACT</span>);
<span class="comment">// prevent `xy + vz` from being CSE&#39;d with `xy + z` above</span>
<span class="kw">let</span> <span class="ident">vz</span>: <span class="ident">f32</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">read_volatile</span>(<span class="kw-2">&amp;</span><span class="ident">z</span>) };
<span class="ident">result</span> <span class="op">=</span> <span class="ident">xy</span> <span class="op">+</span> <span class="ident">vz</span> <span class="kw">as</span> <span class="ident">f64</span>;
<span class="kw">if</span> <span class="ident">fetestexcept</span>(<span class="ident">FE_INEXACT</span>) <span class="op">!</span><span class="op">=</span> <span class="number">0</span> {
<span class="ident">feraiseexcept</span>(<span class="ident">FE_UNDERFLOW</span>);
} <span class="kw">else</span> {
<span class="ident">feraiseexcept</span>(<span class="ident">FE_INEXACT</span>);
}
}
<span class="ident">z</span> <span class="op">=</span> <span class="ident">result</span> <span class="kw">as</span> <span class="ident">f32</span>;
<span class="kw">return</span> <span class="ident">z</span>;
}
<span class="comment">/*
* If result is inexact, and exactly halfway between two float values,
* we need to adjust the low-order bit in the direction of the error.
*/</span>
<span class="ident">fesetround</span>(<span class="ident">FE_TOWARDZERO</span>);
<span class="comment">// prevent `vxy + z` from being CSE&#39;d with `xy + z` above</span>
<span class="kw">let</span> <span class="ident">vxy</span>: <span class="ident">f64</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">read_volatile</span>(<span class="kw-2">&amp;</span><span class="ident">xy</span>) };
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">adjusted_result</span>: <span class="ident">f64</span> <span class="op">=</span> <span class="ident">vxy</span> <span class="op">+</span> <span class="ident">z</span> <span class="kw">as</span> <span class="ident">f64</span>;
<span class="ident">fesetround</span>(<span class="ident">FE_TONEAREST</span>);
<span class="kw">if</span> <span class="ident">result</span> <span class="op">==</span> <span class="ident">adjusted_result</span> {
<span class="ident">ui</span> <span class="op">=</span> <span class="ident">adjusted_result</span>.<span class="ident">to_bits</span>();
<span class="ident">ui</span> <span class="op">+</span><span class="op">=</span> <span class="number">1</span>;
<span class="ident">adjusted_result</span> <span class="op">=</span> <span class="ident">f64::from_bits</span>(<span class="ident">ui</span>);
}
<span class="ident">z</span> <span class="op">=</span> <span class="ident">adjusted_result</span> <span class="kw">as</span> <span class="ident">f32</span>;
<span class="ident">z</span>
}
</code></pre></div>
</section><section id="search" class="content hidden"></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.60.0-nightly (1bd4fdc94 2022-01-12)" ></div>
</body></html>