backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-07-17 12:02:22 +08:00
Code Issues Projects Releases Wiki Activity

Documentation for f7d656cb17

Browse Source
This commit is contained in:
github-actions
2021-09-01 17:00:24 +00:00
parent c6ca215473
commit 2c5806a66b
208 changed files with 5876 additions and 5205 deletions
Download Patch File Download Diff File Expand all files Collapse all files

349
d6/db8/inv__sqrt_8cpp.html Normal file
View File

@@ -0,0 +1,349 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C++: math/inv_sqrt.cpp File Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Algorithms_in_C++
&#160;<span id="projectnumber">1.0.0</span>
</div>
<div id="projectbrief">Set of algorithms implemented in C++.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d6/db8/inv__sqrt_8cpp.html','../../'); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">inv_sqrt.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implementation of <a href="https://medium.com/hard-mode/the-legendary-fast-inverse-square-root-e51fee3b49d9">the inverse square root Root</a>.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;cassert&gt;</code><br />
<code>#include &lt;cmath&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;limits&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for inv_sqrt.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d7/d53/inv__sqrt_8cpp__incl.svg" width="334" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad219034bf5fba657f5035ec5a1d50f52"><td class="memTemplParams" colspan="2">template&lt;typename T = double, char iterations = 2&gt; </td></tr>
<tr class="memitem:ad219034bf5fba657f5035ec5a1d50f52"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../d6/db8/inv__sqrt_8cpp.html#ad219034bf5fba657f5035ec5a1d50f52">Fast_InvSqrt</a> (T x)</td></tr>
<tr class="memdesc:ad219034bf5fba657f5035ec5a1d50f52"><td class="mdescLeft">&#160;</td><td class="mdescRight">for numeric_limits <a href="../../d6/db8/inv__sqrt_8cpp.html#ad219034bf5fba657f5035ec5a1d50f52">More...</a><br /></td></tr>
<tr class="separator:ad219034bf5fba657f5035ec5a1d50f52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2703e5cf3fecde8becd9066b9666b97"><td class="memTemplParams" colspan="2">template&lt;typename T = double&gt; </td></tr>
<tr class="memitem:aa2703e5cf3fecde8becd9066b9666b97"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../d6/db8/inv__sqrt_8cpp.html#aa2703e5cf3fecde8becd9066b9666b97">Standard_InvSqrt</a> (T number)</td></tr>
<tr class="memdesc:aa2703e5cf3fecde8becd9066b9666b97"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the function that calculates the fast inverse square root. The following code is the fast inverse square root with standard lib (cmath) More information can be found at <a href="https://www.linkedin.com/pulse/fast-inverse-square-root-still-armin-kassemi-langroodi">LinkedIn</a> <a href="../../d6/db8/inv__sqrt_8cpp.html#aa2703e5cf3fecde8becd9066b9666b97">More...</a><br /></td></tr>
<tr class="separator:aa2703e5cf3fecde8becd9066b9666b97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8dca7b867074164d5f45b0f3851269d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/db8/inv__sqrt_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a> ()</td></tr>
<tr class="memdesc:aa8dca7b867074164d5f45b0f3851269d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Self-test implementations. <a href="../../d6/db8/inv__sqrt_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">More...</a><br /></td></tr>
<tr class="separator:aa8dca7b867074164d5f45b0f3851269d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/db8/inv__sqrt_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function. <a href="../../d6/db8/inv__sqrt_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">More...</a><br /></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation of <a href="https://medium.com/hard-mode/the-legendary-fast-inverse-square-root-e51fee3b49d9">the inverse square root Root</a>. </p>
<p>Two implementation to calculate inverse inverse root, from Quake III Arena (C++ version) and with a standard library (<code>cmath</code>). This algorithm is used to calculate shadows in Quake III Arena. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ad219034bf5fba657f5035ec5a1d50f52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad219034bf5fba657f5035ec5a1d50f52">&#9670;&nbsp;</a></span>Fast_InvSqrt()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T = double, char iterations = 2&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T Fast_InvSqrt </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>for numeric_limits </p>
<p>for assert for <code><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/sqrt.html">std::sqrt</a></code> for IO operations</p>
<p>This is the function that calculates the fast inverse square root. The following code is the fast inverse square root implementation from Quake III Arena (Adapted for C++). More information can be found at <a href="https://en.wikipedia.org/wiki/Fast_inverse_square_root">Wikipedia</a> </p><dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>floating type </td></tr>
<tr><td class="paramname">iterations</td><td>inverse square root, the greater the number of iterations, the more exact the result will be (1 or 2). </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>value to calculate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the inverse square root </dd></dl>
<div class="fragment"><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">using</span> Tint = <span class="keyword">typename</span> <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/types/conditional.html">std::conditional</a>&lt;<span class="keyword">sizeof</span>(T) == 8, <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/types/integer.html">std::int64_t</a>,</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/types/integer.html">std::int32_t</a>&gt;::type;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; T y = x;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; T x2 = y * 0.5;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; Tint i =</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; *<span class="keyword">reinterpret_cast&lt;</span>Tint *<span class="keyword">&gt;</span>(&amp;y); <span class="comment">// Store floating-point bits in integer</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; i = (<span class="keyword">sizeof</span>(T) == 8 ? 0x5fe6eb50c7b537a9 : 0x5f3759df) -</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; (i &gt;&gt; 1); <span class="comment">// Initial guess for Newton&#39;s method</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; y = *<span class="keyword">reinterpret_cast&lt;</span>T *<span class="keyword">&gt;</span>(&amp;i); <span class="comment">// Convert new bits into float</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; y = y * (1.5 - (x2 * y * y)); <span class="comment">// 1st iteration Newton&#39;s method</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">if</span> (iterations == 2) {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; y = y * (1.5 - (x2 * y * y)); <span class="comment">// 2nd iteration, the more exact result</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; }</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">return</span> y;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;}</div>
<div class="ttc" id="aconditional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/conditional.html">std::conditional</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::int64_t</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">&#9670;&nbsp;</a></span>main()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Main function. </p>
<dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
<div class="fragment"><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; {</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <a class="code" href="../../d6/db8/inv__sqrt_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run self-test implementations</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;The Fast inverse square root of 36 is: &quot;</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; &lt;&lt; Fast_InvSqrt&lt;float, 1&gt;(36.0f) &lt;&lt; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;The Fast inverse square root of 36 is: &quot;</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; &lt;&lt; Fast_InvSqrt&lt;double, 2&gt;(36.0f) &lt;&lt; <span class="stringliteral">&quot; (2 iterations)&quot;</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; &lt;&lt; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;The Fast inverse square root of 100 is: &quot;</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; &lt;&lt; <a class="code" href="../../d6/db8/inv__sqrt_8cpp.html#ad219034bf5fba657f5035ec5a1d50f52">Fast_InvSqrt</a>(100.0f)</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; &lt;&lt; <span class="stringliteral">&quot; (With default template type and iterations: double, 2)&quot;</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; &lt;&lt; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;The Standard inverse square root of 36 is: &quot;</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; &lt;&lt; Standard_InvSqrt&lt;float&gt;(36.0f) &lt;&lt; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;The Standard inverse square root of 100 is: &quot;</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; &lt;&lt; <a class="code" href="../../d6/db8/inv__sqrt_8cpp.html#aa2703e5cf3fecde8becd9066b9666b97">Standard_InvSqrt</a>(100.0f)</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; &lt;&lt; <span class="stringliteral">&quot; (With default template type: double)&quot;</span> &lt;&lt; <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;}</div>
<div class="ttc" id="abasic_ostream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a></div></div>
<div class="ttc" id="aendl_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a></div><div class="ttdeci">T endl(T... args)</div></div>
<div class="ttc" id="ainv__sqrt_8cpp_html_aa2703e5cf3fecde8becd9066b9666b97"><div class="ttname"><a href="../../d6/db8/inv__sqrt_8cpp.html#aa2703e5cf3fecde8becd9066b9666b97">Standard_InvSqrt</a></div><div class="ttdeci">T Standard_InvSqrt(T number)</div><div class="ttdoc">This is the function that calculates the fast inverse square root. The following code is the fast inv...</div><div class="ttdef"><b>Definition:</b> inv_sqrt.cpp:59</div></div>
<div class="ttc" id="ainv__sqrt_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="../../d6/db8/inv__sqrt_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Self-test implementations.</div><div class="ttdef"><b>Definition:</b> inv_sqrt.cpp:68</div></div>
<div class="ttc" id="ainv__sqrt_8cpp_html_ad219034bf5fba657f5035ec5a1d50f52"><div class="ttname"><a href="../../d6/db8/inv__sqrt_8cpp.html#ad219034bf5fba657f5035ec5a1d50f52">Fast_InvSqrt</a></div><div class="ttdeci">T Fast_InvSqrt(T x)</div><div class="ttdoc">for numeric_limits</div><div class="ttdef"><b>Definition:</b> inv_sqrt.cpp:28</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d6/db8/inv__sqrt_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="355" height="190"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="aa2703e5cf3fecde8becd9066b9666b97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2703e5cf3fecde8becd9066b9666b97">&#9670;&nbsp;</a></span>Standard_InvSqrt()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T = double&gt; </div>
<table class="memname">
<tr>
<td class="memname">T Standard_InvSqrt </td>
<td>(</td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>number</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This is the function that calculates the fast inverse square root. The following code is the fast inverse square root with standard lib (cmath) More information can be found at <a href="https://www.linkedin.com/pulse/fast-inverse-square-root-still-armin-kassemi-langroodi">LinkedIn</a> </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>floating type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">number</td><td>value to calculate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the inverse square root </dd></dl>
<div class="fragment"><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; {</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; T squareRoot = <a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/sqrt.html">sqrt</a>(number);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordflow">return</span> 1.0f / squareRoot;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;}</div>
<div class="ttc" id="asqrt_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/math/sqrt.html">std::sqrt</a></div><div class="ttdeci">T sqrt(T... args)</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="aa8dca7b867074164d5f45b0f3851269d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8dca7b867074164d5f45b0f3851269d">&#9670;&nbsp;</a></span>test()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void test </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Self-test implementations. </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<div class="fragment"><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; {</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">const</span> <span class="keywordtype">float</span> epsilon = 1e-3f;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="comment">/* Tests with multiple values */</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; assert(<a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/fabs.html">std::fabs</a>(Standard_InvSqrt&lt;float&gt;(100.0f) - 0.0998449f) &lt; epsilon);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; assert(<a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/fabs.html">std::fabs</a>(Standard_InvSqrt&lt;double&gt;(36.0f) - 0.166667f) &lt; epsilon);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; assert(<a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/fabs.html">std::fabs</a>(<a class="code" href="../../d6/db8/inv__sqrt_8cpp.html#aa2703e5cf3fecde8becd9066b9666b97">Standard_InvSqrt</a>(12.0f) - 0.288423f) &lt; epsilon);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; assert(<a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/fabs.html">std::fabs</a>(Standard_InvSqrt&lt;double&gt;(5.0f) - 0.447141f) &lt; epsilon);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; assert(<a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/fabs.html">std::fabs</a>(Fast_InvSqrt&lt;float, 1&gt;(100.0f) - 0.0998449f) &lt; epsilon);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; assert(<a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/fabs.html">std::fabs</a>(Fast_InvSqrt&lt;double, 1&gt;(36.0f) - 0.166667f) &lt; epsilon);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; assert(<a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/fabs.html">std::fabs</a>(<a class="code" href="../../d6/db8/inv__sqrt_8cpp.html#ad219034bf5fba657f5035ec5a1d50f52">Fast_InvSqrt</a>(12.0f) - 0.288423) &lt; epsilon);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; assert(<a class="codeRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/fabs.html">std::fabs</a>(Fast_InvSqrt&lt;double&gt;(5.0f) - 0.447141) &lt; epsilon);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;}</div>
<div class="ttc" id="afabs_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/math/fabs.html">std::fabs</a></div><div class="ttdeci">T fabs(T... args)</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d6/db8/inv__sqrt_8cpp_aa8dca7b867074164d5f45b0f3851269d_cgraph.svg" width="228" height="139"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_296d53ceaeaa7e099814a6def439fe8a.html">math</a></li><li class="navelem"><a class="el" href="../../d6/db8/inv__sqrt_8cpp.html">inv_sqrt.cpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>

7
d6/db8/inv__sqrt_8cpp.js Normal file
View File

@@ -0,0 +1,7 @@
var inv__sqrt_8cpp =
[
[ "Fast_InvSqrt", "d6/db8/inv__sqrt_8cpp.html#ad219034bf5fba657f5035ec5a1d50f52", null ],
[ "main", "d6/db8/inv__sqrt_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4", null ],
[ "Standard_InvSqrt", "d6/db8/inv__sqrt_8cpp.html#aa2703e5cf3fecde8becd9066b9666b97", null ],
[ "test", "d6/db8/inv__sqrt_8cpp.html#aa8dca7b867074164d5f45b0f3851269d", null ]
];

6
d6/db8/inv__sqrt_8cpp_aa8dca7b867074164d5f45b0f3851269d_cgraph.map Normal file
View File

@@ -0,0 +1,6 @@
<map id="test" name="test">
<area shape="rect" id="node1" title="Self&#45;test implementations." alt="" coords="5,56,49,83"/>
<area shape="rect" id="node2" href="/Users/runner/work/C-Plus-Plus/C-Plus-Plus/doc/cppreference-doxygen-web.tag.xml$cpp/numeric/math/fabs.html#" title=" " alt="" coords="124,5,196,32"/>
<area shape="rect" id="node3" href="$d6/db8/inv__sqrt_8cpp.html#ad219034bf5fba657f5035ec5a1d50f52" title="for numeric_limits" alt="" coords="111,56,209,83"/>
<area shape="rect" id="node4" href="$d6/db8/inv__sqrt_8cpp.html#aa2703e5cf3fecde8becd9066b9666b97" title="This is the function that calculates the fast inverse square root. The following code is the fast inv..." alt="" coords="97,107,223,133"/>
</map>

1
d6/db8/inv__sqrt_8cpp_aa8dca7b867074164d5f45b0f3851269d_cgraph.md5 Normal file
View File

@@ -0,0 +1 @@
713df08187e030e5790bcbb73e786672

67
d6/db8/inv__sqrt_8cpp_aa8dca7b867074164d5f45b0f3851269d_cgraph.svg Normal file
View File

@@ -0,0 +1,67 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.48.0 (20210717.1556)
-->
<!-- Title: test Pages: 1 -->
<svg width="171pt" height="104pt"
viewBox="0.00 0.00 171.00 104.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 100)">
<title>test</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-100 167,-100 167,4 -4,4"/>
<!-- Node1 -->
<g id="node1" class="node">
<title>Node1</title>
<g id="a_node1"><a xlink:title="Self&#45;test implementations.">
<polygon fill="#bfbfbf" stroke="black" points="0,-38.5 0,-57.5 33,-57.5 33,-38.5 0,-38.5"/>
<text text-anchor="middle" x="16.5" y="-45.5" font-family="Helvetica,sans-Serif" font-size="10.00">test</text>
</a>
</g>
</g>
<!-- Node2 -->
<g id="node2" class="node">
<title>Node2</title>
<g id="a_node2"><a target="_blank" xlink:href="http://en.cppreference.com/w/cpp/numeric/math/fabs.html#" xlink:title=" ">
<polygon fill="white" stroke="black" points="89,-76.5 89,-95.5 143,-95.5 143,-76.5 89,-76.5"/>
<text text-anchor="middle" x="116" y="-83.5" font-family="Helvetica,sans-Serif" font-size="10.00">std::fabs</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node2 -->
<g id="edge1" class="edge">
<title>Node1&#45;&gt;Node2</title>
<path fill="none" stroke="midnightblue" d="M33.17,-54.11C46,-59.11 64.64,-66.37 80.88,-72.7"/>
<polygon fill="midnightblue" stroke="midnightblue" points="80.03,-76.13 90.62,-76.5 82.57,-69.6 80.03,-76.13"/>
</g>
<!-- Node3 -->
<g id="node3" class="node">
<title>Node3</title>
<g id="a_node3"><a xlink:href="../../d6/db8/inv__sqrt_8cpp.html#ad219034bf5fba657f5035ec5a1d50f52" target="_top" xlink:title="for numeric_limits">
<polygon fill="white" stroke="black" points="79.5,-38.5 79.5,-57.5 152.5,-57.5 152.5,-38.5 79.5,-38.5"/>
<text text-anchor="middle" x="116" y="-45.5" font-family="Helvetica,sans-Serif" font-size="10.00">Fast_InvSqrt</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node3 -->
<g id="edge2" class="edge">
<title>Node1&#45;&gt;Node3</title>
<path fill="none" stroke="midnightblue" d="M33.17,-48C42.93,-48 56.06,-48 68.94,-48"/>
<polygon fill="midnightblue" stroke="midnightblue" points="69.14,-51.5 79.14,-48 69.14,-44.5 69.14,-51.5"/>
</g>
<!-- Node4 -->
<g id="node4" class="node">
<title>Node4</title>
<g id="a_node4"><a xlink:href="../../d6/db8/inv__sqrt_8cpp.html#aa2703e5cf3fecde8becd9066b9666b97" target="_top" xlink:title="This is the function that calculates the fast inverse square root. The following code is the fast inv...">
<polygon fill="white" stroke="black" points="69,-0.5 69,-19.5 163,-19.5 163,-0.5 69,-0.5"/>
<text text-anchor="middle" x="116" y="-7.5" font-family="Helvetica,sans-Serif" font-size="10.00">Standard_InvSqrt</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node4 -->
<g id="edge3" class="edge">
<title>Node1&#45;&gt;Node4</title>
<path fill="none" stroke="midnightblue" d="M33.17,-41.89C46,-36.89 64.64,-29.63 80.88,-23.3"/>
<polygon fill="midnightblue" stroke="midnightblue" points="82.57,-26.4 90.62,-19.5 80.03,-19.87 82.57,-26.4"/>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 3.2 KiB

8
d6/db8/inv__sqrt_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.map Normal file
View File

@@ -0,0 +1,8 @@
<map id="main" name="main">
<area shape="rect" id="node1" title="Main function." alt="" coords="5,81,56,108"/>
<area shape="rect" id="node2" href="/Users/runner/work/C-Plus-Plus/C-Plus-Plus/doc/cppreference-doxygen-web.tag.xml$cpp/io/manip/endl.html#" title=" " alt="" coords="104,5,176,32"/>
<area shape="rect" id="node3" href="$d6/db8/inv__sqrt_8cpp.html#ad219034bf5fba657f5035ec5a1d50f52" title="for numeric_limits" alt="" coords="238,56,335,83"/>
<area shape="rect" id="node4" href="$d6/db8/inv__sqrt_8cpp.html#aa2703e5cf3fecde8becd9066b9666b97" title="This is the function that calculates the fast inverse square root. The following code is the fast inv..." alt="" coords="224,157,349,184"/>
<area shape="rect" id="node5" href="$d6/db8/inv__sqrt_8cpp.html#aa8dca7b867074164d5f45b0f3851269d" title="Self&#45;test implementations." alt="" coords="118,107,162,133"/>
<area shape="rect" id="node6" href="/Users/runner/work/C-Plus-Plus/C-Plus-Plus/doc/cppreference-doxygen-web.tag.xml$cpp/numeric/math/fabs.html#" title=" " alt="" coords="251,107,323,133"/>
</map>

1
d6/db8/inv__sqrt_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.md5 Normal file
View File

@@ -0,0 +1 @@
26aa19888342a729797997c518375095

109
d6/db8/inv__sqrt_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg Normal file
View File

@@ -0,0 +1,109 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.48.0 (20210717.1556)
-->
<!-- Title: main Pages: 1 -->
<svg width="266pt" height="142pt"
viewBox="0.00 0.00 266.00 142.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 138)">
<title>main</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-138 262,-138 262,4 -4,4"/>
<!-- Node1 -->
<g id="node1" class="node">
<title>Node1</title>
<g id="a_node1"><a xlink:title="Main function.">
<polygon fill="#bfbfbf" stroke="black" points="0,-57.5 0,-76.5 38,-76.5 38,-57.5 0,-57.5"/>
<text text-anchor="middle" x="19" y="-64.5" font-family="Helvetica,sans-Serif" font-size="10.00">main</text>
</a>
</g>
</g>
<!-- Node2 -->
<g id="node2" class="node">
<title>Node2</title>
<g id="a_node2"><a target="_blank" xlink:href="http://en.cppreference.com/w/cpp/io/manip/endl.html#" xlink:title=" ">
<polygon fill="white" stroke="black" points="74,-114.5 74,-133.5 128,-133.5 128,-114.5 74,-114.5"/>
<text text-anchor="middle" x="101" y="-121.5" font-family="Helvetica,sans-Serif" font-size="10.00">std::endl</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node2 -->
<g id="edge1" class="edge">
<title>Node1&#45;&gt;Node2</title>
<path fill="none" stroke="midnightblue" d="M33.57,-76.67C45.83,-85.4 64.08,-98.4 78.35,-108.57"/>
<polygon fill="midnightblue" stroke="midnightblue" points="76.45,-111.52 86.63,-114.47 80.52,-105.82 76.45,-111.52"/>
</g>
<!-- Node3 -->
<g id="node3" class="node">
<title>Node3</title>
<g id="a_node3"><a xlink:href="../../d6/db8/inv__sqrt_8cpp.html#ad219034bf5fba657f5035ec5a1d50f52" target="_top" xlink:title="for numeric_limits">
<polygon fill="white" stroke="black" points="174.5,-76.5 174.5,-95.5 247.5,-95.5 247.5,-76.5 174.5,-76.5"/>
<text text-anchor="middle" x="211" y="-83.5" font-family="Helvetica,sans-Serif" font-size="10.00">Fast_InvSqrt</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node3 -->
<g id="edge2" class="edge">
<title>Node1&#45;&gt;Node3</title>
<path fill="none" stroke="midnightblue" d="M38.22,-68.82C67.01,-71.7 123.92,-77.39 164.33,-81.43"/>
<polygon fill="midnightblue" stroke="midnightblue" points="164.18,-84.94 174.48,-82.45 164.88,-77.97 164.18,-84.94"/>
</g>
<!-- Node4 -->
<g id="node4" class="node">
<title>Node4</title>
<g id="a_node4"><a xlink:href="../../d6/db8/inv__sqrt_8cpp.html#aa2703e5cf3fecde8becd9066b9666b97" target="_top" xlink:title="This is the function that calculates the fast inverse square root. The following code is the fast inv...">
<polygon fill="white" stroke="black" points="164,-0.5 164,-19.5 258,-19.5 258,-0.5 164,-0.5"/>
<text text-anchor="middle" x="211" y="-7.5" font-family="Helvetica,sans-Serif" font-size="10.00">Standard_InvSqrt</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node4 -->
<g id="edge3" class="edge">
<title>Node1&#45;&gt;Node4</title>
<path fill="none" stroke="midnightblue" d="M30.28,-57.48C40.53,-48.57 57.15,-35.65 74,-29 99.14,-19.07 128.69,-14.21 153.81,-11.88"/>
<polygon fill="midnightblue" stroke="midnightblue" points="154.24,-15.36 163.92,-11.05 153.66,-8.38 154.24,-15.36"/>
</g>
<!-- Node5 -->
<g id="node5" class="node">
<title>Node5</title>
<g id="a_node5"><a xlink:href="../../d6/db8/inv__sqrt_8cpp.html#aa8dca7b867074164d5f45b0f3851269d" target="_top" xlink:title="Self&#45;test implementations.">
<polygon fill="white" stroke="black" points="84.5,-38.5 84.5,-57.5 117.5,-57.5 117.5,-38.5 84.5,-38.5"/>
<text text-anchor="middle" x="101" y="-45.5" font-family="Helvetica,sans-Serif" font-size="10.00">test</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node5 -->
<g id="edge4" class="edge">
<title>Node1&#45;&gt;Node5</title>
<path fill="none" stroke="midnightblue" d="M38.15,-62.69C48.92,-60.13 62.74,-56.85 74.58,-54.04"/>
<polygon fill="midnightblue" stroke="midnightblue" points="75.43,-57.43 84.35,-51.72 73.81,-50.62 75.43,-57.43"/>
</g>
<!-- Node5&#45;&gt;Node3 -->
<g id="edge6" class="edge">
<title>Node5&#45;&gt;Node3</title>
<path fill="none" stroke="midnightblue" d="M117.94,-53.61C132.43,-58.71 154.36,-66.42 173.18,-73.04"/>
<polygon fill="midnightblue" stroke="midnightblue" points="172.09,-76.37 182.68,-76.39 174.41,-69.77 172.09,-76.37"/>
</g>
<!-- Node5&#45;&gt;Node4 -->
<g id="edge7" class="edge">
<title>Node5&#45;&gt;Node4</title>
<path fill="none" stroke="midnightblue" d="M117.94,-42.39C132.43,-37.29 154.36,-29.58 173.18,-22.96"/>
<polygon fill="midnightblue" stroke="midnightblue" points="174.41,-26.23 182.68,-19.61 172.09,-19.63 174.41,-26.23"/>
</g>
<!-- Node6 -->
<g id="node6" class="node">
<title>Node6</title>
<g id="a_node6"><a target="_blank" xlink:href="http://en.cppreference.com/w/cpp/numeric/math/fabs.html#" xlink:title=" ">
<polygon fill="white" stroke="black" points="184,-38.5 184,-57.5 238,-57.5 238,-38.5 184,-38.5"/>
<text text-anchor="middle" x="211" y="-45.5" font-family="Helvetica,sans-Serif" font-size="10.00">std::fabs</text>
</a>
</g>
</g>
<!-- Node5&#45;&gt;Node6 -->
<g id="edge5" class="edge">
<title>Node5&#45;&gt;Node6</title>
<path fill="none" stroke="midnightblue" d="M117.94,-48C132.59,-48 154.85,-48 173.82,-48"/>
<polygon fill="midnightblue" stroke="midnightblue" points="173.94,-51.5 183.94,-48 173.94,-44.5 173.94,-51.5"/>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 5.3 KiB