blob: 2f16454ed57c8156ec9ab7f22585d498cda33ef0 [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/sqrtf.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>sqrtf.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>
</pre><pre class="rust"><code><span class="comment">/* origin: FreeBSD /usr/src/lib/msun/src/e_sqrtf.c */
/*
* Conversion to float by Ian Lance Taylor, Cygnus Support, ian@cygnus.com.
*/
/*
* ====================================================
* 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="attribute">#[cfg_attr(all(test, assert_no_panic), no_panic::no_panic)]
</span><span class="kw">pub fn </span>sqrtf(x: f32) -&gt; f32 {
<span class="comment">// On wasm32 we know that LLVM&#39;s intrinsic will compile to an optimized
// `f32.sqrt` native instruction, so we can leverage this for both code size
// and speed.
</span><span class="macro">llvm_intrinsically_optimized! </span>{
<span class="attribute">#[cfg(target_arch = <span class="string">&quot;wasm32&quot;</span>)] </span>{
<span class="kw">return if </span>x &lt; <span class="number">0.0 </span>{
::core::f32::NAN
} <span class="kw">else </span>{
<span class="kw">unsafe </span>{ ::core::intrinsics::sqrtf32(x) }
}
}
}
<span class="attribute">#[cfg(target_feature = <span class="string">&quot;sse&quot;</span>)]
</span>{
<span class="comment">// Note: This path is unlikely since LLVM will usually have already
// optimized sqrt calls into hardware instructions if sse is available,
// but if someone does end up here they&#39;ll apprected the speed increase.
</span><span class="attribute">#[cfg(target_arch = <span class="string">&quot;x86&quot;</span>)]
</span><span class="kw">use </span>core::arch::x86::<span class="kw-2">*</span>;
<span class="attribute">#[cfg(target_arch = <span class="string">&quot;x86_64&quot;</span>)]
</span><span class="kw">use </span>core::arch::x86_64::<span class="kw-2">*</span>;
<span class="kw">unsafe </span>{
<span class="kw">let </span>m = _mm_set_ss(x);
<span class="kw">let </span>m_sqrt = _mm_sqrt_ss(m);
_mm_cvtss_f32(m_sqrt)
}
}
<span class="attribute">#[cfg(not(target_feature = <span class="string">&quot;sse&quot;</span>))]
</span>{
<span class="kw">const </span>TINY: f32 = <span class="number">1.0e-30</span>;
<span class="kw">let </span><span class="kw-2">mut </span>z: f32;
<span class="kw">let </span>sign: i32 = <span class="number">0x80000000u32 </span><span class="kw">as </span>i32;
<span class="kw">let </span><span class="kw-2">mut </span>ix: i32;
<span class="kw">let </span><span class="kw-2">mut </span>s: i32;
<span class="kw">let </span><span class="kw-2">mut </span>q: i32;
<span class="kw">let </span><span class="kw-2">mut </span>m: i32;
<span class="kw">let </span><span class="kw-2">mut </span>t: i32;
<span class="kw">let </span><span class="kw-2">mut </span>i: i32;
<span class="kw">let </span><span class="kw-2">mut </span>r: u32;
ix = x.to_bits() <span class="kw">as </span>i32;
<span class="comment">/* take care of Inf and NaN */
</span><span class="kw">if </span>(ix <span class="kw">as </span>u32 &amp; <span class="number">0x7f800000</span>) == <span class="number">0x7f800000 </span>{
<span class="kw">return </span>x * x + x; <span class="comment">/* sqrt(NaN)=NaN, sqrt(+inf)=+inf, sqrt(-inf)=sNaN */
</span>}
<span class="comment">/* take care of zero */
</span><span class="kw">if </span>ix &lt;= <span class="number">0 </span>{
<span class="kw">if </span>(ix &amp; !sign) == <span class="number">0 </span>{
<span class="kw">return </span>x; <span class="comment">/* sqrt(+-0) = +-0 */
</span>}
<span class="kw">if </span>ix &lt; <span class="number">0 </span>{
<span class="kw">return </span>(x - x) / (x - x); <span class="comment">/* sqrt(-ve) = sNaN */
</span>}
}
<span class="comment">/* normalize x */
</span>m = ix &gt;&gt; <span class="number">23</span>;
<span class="kw">if </span>m == <span class="number">0 </span>{
<span class="comment">/* subnormal x */
</span>i = <span class="number">0</span>;
<span class="kw">while </span>ix &amp; <span class="number">0x00800000 </span>== <span class="number">0 </span>{
ix &lt;&lt;= <span class="number">1</span>;
i = i + <span class="number">1</span>;
}
m -= i - <span class="number">1</span>;
}
m -= <span class="number">127</span>; <span class="comment">/* unbias exponent */
</span>ix = (ix &amp; <span class="number">0x007fffff</span>) | <span class="number">0x00800000</span>;
<span class="kw">if </span>m &amp; <span class="number">1 </span>== <span class="number">1 </span>{
<span class="comment">/* odd m, double x to make it even */
</span>ix += ix;
}
m &gt;&gt;= <span class="number">1</span>; <span class="comment">/* m = [m/2] */
/* generate sqrt(x) bit by bit */
</span>ix += ix;
q = <span class="number">0</span>;
s = <span class="number">0</span>;
r = <span class="number">0x01000000</span>; <span class="comment">/* r = moving bit from right to left */
</span><span class="kw">while </span>r != <span class="number">0 </span>{
t = s + r <span class="kw">as </span>i32;
<span class="kw">if </span>t &lt;= ix {
s = t + r <span class="kw">as </span>i32;
ix -= t;
q += r <span class="kw">as </span>i32;
}
ix += ix;
r &gt;&gt;= <span class="number">1</span>;
}
<span class="comment">/* use floating add to find out rounding direction */
</span><span class="kw">if </span>ix != <span class="number">0 </span>{
z = <span class="number">1.0 </span>- TINY; <span class="comment">/* raise inexact flag */
</span><span class="kw">if </span>z &gt;= <span class="number">1.0 </span>{
z = <span class="number">1.0 </span>+ TINY;
<span class="kw">if </span>z &gt; <span class="number">1.0 </span>{
q += <span class="number">2</span>;
} <span class="kw">else </span>{
q += q &amp; <span class="number">1</span>;
}
}
}
ix = (q &gt;&gt; <span class="number">1</span>) + <span class="number">0x3f000000</span>;
ix += m &lt;&lt; <span class="number">23</span>;
f32::from_bits(ix <span class="kw">as </span>u32)
}
}
<span class="comment">// PowerPC tests are failing on LLVM 13: https://github.com/rust-lang/rust/issues/88520
</span><span class="attribute">#[cfg(not(target_arch = <span class="string">&quot;powerpc64&quot;</span>))]
#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span>core::f32::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>sanity_check() {
<span class="macro">assert_eq!</span>(sqrtf(<span class="number">100.0</span>), <span class="number">10.0</span>);
<span class="macro">assert_eq!</span>(sqrtf(<span class="number">4.0</span>), <span class="number">2.0</span>);
}
<span class="doccomment">/// The spec: https://en.cppreference.com/w/cpp/numeric/math/sqrt
</span><span class="attribute">#[test]
</span><span class="kw">fn </span>spec_tests() {
<span class="comment">// Not Asserted: FE_INVALID exception is raised if argument is negative.
</span><span class="macro">assert!</span>(sqrtf(-<span class="number">1.0</span>).is_nan());
<span class="macro">assert!</span>(sqrtf(NAN).is_nan());
<span class="kw">for </span>f <span class="kw">in </span>[<span class="number">0.0</span>, -<span class="number">0.0</span>, INFINITY].iter().copied() {
<span class="macro">assert_eq!</span>(sqrtf(f), f);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>conformance_tests() {
<span class="kw">let </span>values = [
<span class="number">3.14159265359f32</span>,
<span class="number">10000.0f32</span>,
f32::from_bits(<span class="number">0x0000000f</span>),
INFINITY,
];
<span class="kw">let </span>results = [<span class="number">1071833029u32</span>, <span class="number">1120403456u32</span>, <span class="number">456082799u32</span>, <span class="number">2139095040u32</span>];
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..values.len() {
<span class="kw">let </span>bits = f32::to_bits(sqrtf(values[i]));
<span class="macro">assert_eq!</span>(results[i], bits);
}
}
}
</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>