blob: 3110b503fc52add150b2b9b543f1907ca6b67443 [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/tgamma.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>tgamma.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>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
</pre><pre class="rust"><code><span class="comment">/*
&quot;A Precision Approximation of the Gamma Function&quot; - Cornelius Lanczos (1964)
&quot;Lanczos Implementation of the Gamma Function&quot; - Paul Godfrey (2001)
&quot;An Analysis of the Lanczos Gamma Approximation&quot; - Glendon Ralph Pugh (2004)
approximation method:
(x - 0.5) S(x)
Gamma(x) = (x + g - 0.5) * ----------------
exp(x + g - 0.5)
with
a1 a2 a3 aN
S(x) ~= [ a0 + ----- + ----- + ----- + ... + ----- ]
x + 1 x + 2 x + 3 x + N
with a0, a1, a2, a3,.. aN constants which depend on g.
for x &lt; 0 the following reflection formula is used:
Gamma(x)*Gamma(-x) = -pi/(x sin(pi x))
most ideas and constants are from boost and python
*/
</span><span class="kw">extern crate </span>core;
<span class="kw">use super</span>::{exp, floor, k_cos, k_sin, pow};
<span class="kw">const </span>PI: f64 = <span class="number">3.141592653589793238462643383279502884</span>;
<span class="comment">/* sin(pi x) with x &gt; 0x1p-100, if sin(pi*x)==0 the sign is arbitrary */
</span><span class="kw">fn </span>sinpi(<span class="kw-2">mut </span>x: f64) -&gt; f64 {
<span class="kw">let </span><span class="kw-2">mut </span>n: isize;
<span class="comment">/* argument reduction: x = |x| mod 2 */
/* spurious inexact when x is odd int */
</span>x = x * <span class="number">0.5</span>;
x = <span class="number">2.0 </span>* (x - floor(x));
<span class="comment">/* reduce x into [-.25,.25] */
</span>n = (<span class="number">4.0 </span>* x) <span class="kw">as </span>isize;
n = <span class="macro">div!</span>(n + <span class="number">1</span>, <span class="number">2</span>);
x -= (n <span class="kw">as </span>f64) * <span class="number">0.5</span>;
x <span class="kw-2">*</span>= PI;
<span class="kw">match </span>n {
<span class="number">1 </span>=&gt; k_cos(x, <span class="number">0.0</span>),
<span class="number">2 </span>=&gt; k_sin(-x, <span class="number">0.0</span>, <span class="number">0</span>),
<span class="number">3 </span>=&gt; -k_cos(x, <span class="number">0.0</span>),
<span class="number">0 </span>| <span class="kw">_ </span>=&gt; k_sin(x, <span class="number">0.0</span>, <span class="number">0</span>),
}
}
<span class="kw">const </span>N: usize = <span class="number">12</span>;
<span class="comment">//static const double g = 6.024680040776729583740234375;
</span><span class="kw">const </span>GMHALF: f64 = <span class="number">5.524680040776729583740234375</span>;
<span class="kw">const </span>SNUM: [f64; N + <span class="number">1</span>] = [
<span class="number">23531376880.410759688572007674451636754734846804940</span>,
<span class="number">42919803642.649098768957899047001988850926355848959</span>,
<span class="number">35711959237.355668049440185451547166705960488635843</span>,
<span class="number">17921034426.037209699919755754458931112671403265390</span>,
<span class="number">6039542586.3520280050642916443072979210699388420708</span>,
<span class="number">1439720407.3117216736632230727949123939715485786772</span>,
<span class="number">248874557.86205415651146038641322942321632125127801</span>,
<span class="number">31426415.585400194380614231628318205362874684987640</span>,
<span class="number">2876370.6289353724412254090516208496135991145378768</span>,
<span class="number">186056.26539522349504029498971604569928220784236328</span>,
<span class="number">8071.6720023658162106380029022722506138218516325024</span>,
<span class="number">210.82427775157934587250973392071336271166969580291</span>,
<span class="number">2.5066282746310002701649081771338373386264310793408</span>,
];
<span class="kw">const </span>SDEN: [f64; N + <span class="number">1</span>] = [
<span class="number">0.0</span>,
<span class="number">39916800.0</span>,
<span class="number">120543840.0</span>,
<span class="number">150917976.0</span>,
<span class="number">105258076.0</span>,
<span class="number">45995730.0</span>,
<span class="number">13339535.0</span>,
<span class="number">2637558.0</span>,
<span class="number">357423.0</span>,
<span class="number">32670.0</span>,
<span class="number">1925.0</span>,
<span class="number">66.0</span>,
<span class="number">1.0</span>,
];
<span class="comment">/* n! for small integer n */
</span><span class="kw">const </span>FACT: [f64; <span class="number">23</span>] = [
<span class="number">1.0</span>,
<span class="number">1.0</span>,
<span class="number">2.0</span>,
<span class="number">6.0</span>,
<span class="number">24.0</span>,
<span class="number">120.0</span>,
<span class="number">720.0</span>,
<span class="number">5040.0</span>,
<span class="number">40320.0</span>,
<span class="number">362880.0</span>,
<span class="number">3628800.0</span>,
<span class="number">39916800.0</span>,
<span class="number">479001600.0</span>,
<span class="number">6227020800.0</span>,
<span class="number">87178291200.0</span>,
<span class="number">1307674368000.0</span>,
<span class="number">20922789888000.0</span>,
<span class="number">355687428096000.0</span>,
<span class="number">6402373705728000.0</span>,
<span class="number">121645100408832000.0</span>,
<span class="number">2432902008176640000.0</span>,
<span class="number">51090942171709440000.0</span>,
<span class="number">1124000727777607680000.0</span>,
];
<span class="comment">/* S(x) rational function for positive x */
</span><span class="kw">fn </span>s(x: f64) -&gt; f64 {
<span class="kw">let </span><span class="kw-2">mut </span>num: f64 = <span class="number">0.0</span>;
<span class="kw">let </span><span class="kw-2">mut </span>den: f64 = <span class="number">0.0</span>;
<span class="comment">/* to avoid overflow handle large x differently */
</span><span class="kw">if </span>x &lt; <span class="number">8.0 </span>{
<span class="kw">for </span>i <span class="kw">in </span>(<span class="number">0</span>..=N).rev() {
num = num * x + <span class="macro">i!</span>(SNUM, i);
den = den * x + <span class="macro">i!</span>(SDEN, i);
}
} <span class="kw">else </span>{
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..=N {
num = num / x + <span class="macro">i!</span>(SNUM, i);
den = den / x + <span class="macro">i!</span>(SDEN, i);
}
}
<span class="kw">return </span>num / den;
}
<span class="attribute">#[cfg_attr(all(test, assert_no_panic), no_panic::no_panic)]
</span><span class="kw">pub fn </span>tgamma(<span class="kw-2">mut </span>x: f64) -&gt; f64 {
<span class="kw">let </span>u: u64 = x.to_bits();
<span class="kw">let </span>absx: 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>dy: f64;
<span class="kw">let </span><span class="kw-2">mut </span>z: f64;
<span class="kw">let </span><span class="kw-2">mut </span>r: f64;
<span class="kw">let </span>ix: u32 = ((u &gt;&gt; <span class="number">32</span>) <span class="kw">as </span>u32) &amp; <span class="number">0x7fffffff</span>;
<span class="kw">let </span>sign: bool = (u &gt;&gt; <span class="number">63</span>) != <span class="number">0</span>;
<span class="comment">/* special cases */
</span><span class="kw">if </span>ix &gt;= <span class="number">0x7ff00000 </span>{
<span class="comment">/* tgamma(nan)=nan, tgamma(inf)=inf, tgamma(-inf)=nan with invalid */
</span><span class="kw">return </span>x + core::f64::INFINITY;
}
<span class="kw">if </span>ix &lt; ((<span class="number">0x3ff </span>- <span class="number">54</span>) &lt;&lt; <span class="number">20</span>) {
<span class="comment">/* |x| &lt; 2^-54: tgamma(x) ~ 1/x, +-0 raises div-by-zero */
</span><span class="kw">return </span><span class="number">1.0 </span>/ x;
}
<span class="comment">/* integer arguments */
/* raise inexact when non-integer */
</span><span class="kw">if </span>x == floor(x) {
<span class="kw">if </span>sign {
<span class="kw">return </span><span class="number">0.0 </span>/ <span class="number">0.0</span>;
}
<span class="kw">if </span>x &lt;= FACT.len() <span class="kw">as </span>f64 {
<span class="kw">return </span><span class="macro">i!</span>(FACT, (x <span class="kw">as </span>usize) - <span class="number">1</span>);
}
}
<span class="comment">/* x &gt;= 172: tgamma(x)=inf with overflow */
/* x =&lt; -184: tgamma(x)=+-0 with underflow */
</span><span class="kw">if </span>ix &gt;= <span class="number">0x40670000 </span>{
<span class="comment">/* |x| &gt;= 184 */
</span><span class="kw">if </span>sign {
<span class="kw">let </span>x1p_126 = f64::from_bits(<span class="number">0x3810000000000000</span>); <span class="comment">// 0x1p-126 == 2^-126
</span><span class="macro">force_eval!</span>((x1p_126 / x) <span class="kw">as </span>f32);
<span class="kw">if </span>floor(x) * <span class="number">0.5 </span>== floor(x * <span class="number">0.5</span>) {
<span class="kw">return </span><span class="number">0.0</span>;
} <span class="kw">else </span>{
<span class="kw">return </span>-<span class="number">0.0</span>;
}
}
<span class="kw">let </span>x1p1023 = f64::from_bits(<span class="number">0x7fe0000000000000</span>); <span class="comment">// 0x1p1023 == 2^1023
</span>x <span class="kw-2">*</span>= x1p1023;
<span class="kw">return </span>x;
}
absx = <span class="kw">if </span>sign { -x } <span class="kw">else </span>{ x };
<span class="comment">/* handle the error of x + g - 0.5 */
</span>y = absx + GMHALF;
<span class="kw">if </span>absx &gt; GMHALF {
dy = y - absx;
dy -= GMHALF;
} <span class="kw">else </span>{
dy = y - GMHALF;
dy -= absx;
}
z = absx - <span class="number">0.5</span>;
r = s(absx) * exp(-y);
<span class="kw">if </span>x &lt; <span class="number">0.0 </span>{
<span class="comment">/* reflection formula for negative x */
/* sinpi(absx) is not 0, integers are already handled */
</span>r = -PI / (sinpi(absx) * absx * r);
dy = -dy;
z = -z;
}
r += dy * (GMHALF + <span class="number">0.5</span>) * r / y;
z = pow(y, <span class="number">0.5 </span>* z);
y = r * z * z;
<span class="kw">return </span>y;
}
</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>