BEGIN LICENSE BLOCK ***** Version: EPL 2.0/GPL 2.0/LGPL 2.1 The contents of this file are subject to the Eclipse Public License Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.eclipse.org/legal/epl-v20.html Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. Copyright (C) 2001 Chad Fowler Copyright (C) 2001-2002 Jan Arne Petersen Copyright (C) 2002 Benoit Cerrina Copyright (C) 2002-2004 Thomas E Enebo Copyright (C) 2004 Stefan Matthias Aust Alternatively, the contents of this file may be used under the terms of either of the GNU General Public License Version 2 or later (the "GPL"), or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which case the provisions of the GPL or the LGPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of either the GPL or the LGPL, and not to allow others to use your version of this file under the terms of the EPL, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL or the LGPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the EPL, the GPL or the LGPL. END LICENSE BLOCK
/***** BEGIN LICENSE BLOCK ***** * Version: EPL 2.0/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Eclipse Public * License Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.eclipse.org/legal/epl-v20.html * * Software distributed under the License is distributed on an "AS * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or * implied. See the License for the specific language governing * rights and limitations under the License. * * Copyright (C) 2001 Chad Fowler <chadfowler@chadfowler.com> * Copyright (C) 2001-2002 Jan Arne Petersen <jpetersen@uni-bonn.de> * Copyright (C) 2002 Benoit Cerrina <b.cerrina@wanadoo.fr> * Copyright (C) 2002-2004 Thomas E Enebo <enebo@acm.org> * Copyright (C) 2004 Stefan Matthias Aust <sma@3plus4.de> * * Alternatively, the contents of this file may be used under the terms of * either of the GNU General Public License Version 2 or later (the "GPL"), * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the EPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the EPL, the GPL or the LGPL. ***** END LICENSE BLOCK *****/
package org.jruby; import org.jruby.anno.JRubyMethod; import org.jruby.anno.JRubyModule; import org.jruby.runtime.ThreadContext; import org.jruby.runtime.Visibility; import org.jruby.runtime.builtin.IRubyObject; @JRubyModule(name="Math") public class RubyMath {
Create the Math module and add it to the Ruby runtime.
/** Create the Math module and add it to the Ruby runtime. * */
public static RubyModule createMathModule(Ruby runtime) { RubyModule result = runtime.defineModule("Math"); runtime.setMath(result); result.defineConstant("E", RubyFloat.newFloat(runtime, Math.E)); result.defineConstant("PI", RubyFloat.newFloat(runtime, Math.PI)); result.defineAnnotatedMethods(RubyMath.class); return result; } private static void domainCheck(IRubyObject recv, double value, String msg) { if (Double.isNaN(value)) { throw recv.getRuntime().newErrnoEDOMError(msg); } } private static void domainCheck19(IRubyObject recv, double value, String msg) { if (Double.isNaN(value)) { throw recv.getRuntime().newMathDomainError(msg); } } public static double chebylevSerie(double x, double coef[]) { double b0, b1, b2, twox; int i; b1 = 0.0; b0 = 0.0; b2 = 0.0; twox = 2.0 * x; for (i = coef.length-1; i >= 0; i--) { b2 = b1; b1 = b0; b0 = twox * b1 - b2 + coef[i]; } return 0.5*(b0 - b2); } public static double sign(double x, double y) { double abs = ((x < 0) ? -x : x); return (y < 0.0) ? -abs : abs; } @JRubyMethod(name = "atan2", required = 2, module = true, visibility = Visibility.PRIVATE) public static RubyFloat atan2(ThreadContext context, IRubyObject recv, IRubyObject x, IRubyObject y) { double valuea = RubyNumeric.num2dbl(context, x); double valueb = RubyNumeric.num2dbl(context, y); return RubyFloat.newFloat(context.runtime, Math.atan2(valuea, valueb)); } @Deprecated public static RubyFloat atan219(ThreadContext context, IRubyObject recv, IRubyObject x, IRubyObject y) { return atan2(context, recv, x, y); } @JRubyMethod(name = "cos", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat cos(ThreadContext context, IRubyObject recv, IRubyObject x) { return RubyFloat.newFloat(context.runtime, Math.cos(RubyNumeric.num2dbl(context, x))); } @Deprecated public static RubyFloat cos19(ThreadContext context, IRubyObject recv, IRubyObject x) { return cos(context, recv, x); } @JRubyMethod(name = "sin", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat sin(ThreadContext context, IRubyObject recv, IRubyObject x) { return RubyFloat.newFloat(context.runtime, Math.sin(RubyNumeric.num2dbl(context, x))); } @Deprecated public static RubyFloat sin19(ThreadContext context, IRubyObject recv, IRubyObject x) { return sin(context, recv, x); } @JRubyMethod(name = "tan", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat tan(ThreadContext context, IRubyObject recv, IRubyObject x) { return RubyFloat.newFloat(context.runtime, Math.tan(RubyNumeric.num2dbl(context, x))); } @Deprecated public static RubyFloat tan19(ThreadContext context, IRubyObject recv, IRubyObject x) { return tan(context, recv, x); } @JRubyMethod(name = "asin", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat asin(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyNumeric.num2dbl(context, x); if (value < -1.0 || value > 1.0) throw context.runtime.newMathDomainError("asin"); return RubyFloat.newFloat(context.runtime, Math.asin(value)); } @Deprecated public static RubyFloat asin19(ThreadContext context, IRubyObject recv, IRubyObject x) { return asin(context, recv, x); } @JRubyMethod(name = "acos", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat acos(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyNumeric.num2dbl(context, x); if (value < -1.0 || value > 1.0) throw context.runtime.newMathDomainError("acos"); return RubyFloat.newFloat(context.runtime, Math.acos(value)); } @Deprecated public static RubyFloat acos19(ThreadContext context, IRubyObject recv, IRubyObject x) { return acos(context, recv, x); } @JRubyMethod(name = "atan", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat atan(ThreadContext context, IRubyObject recv, IRubyObject x) { return RubyFloat.newFloat(context.runtime, Math.atan(RubyNumeric.num2dbl(context, x))); } @Deprecated public static RubyFloat atan19(ThreadContext context, IRubyObject recv, IRubyObject x) { return atan(context, recv, x); } @JRubyMethod(name = "cosh", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat cosh(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyNumeric.num2dbl(context, x); return RubyFloat.newFloat(context.runtime, (Math.exp(value) + Math.exp(-value)) / 2.0); } @Deprecated public static RubyFloat cosh19(ThreadContext context, IRubyObject recv, IRubyObject x) { return cosh(context, recv, x); } @JRubyMethod(name = "sinh", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat sinh(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyNumeric.num2dbl(context, x); return RubyFloat.newFloat(context.runtime, (Math.exp(value) - Math.exp(-value)) / 2.0); } @Deprecated public static RubyFloat sinh19(ThreadContext context, IRubyObject recv, IRubyObject x) { return sinh(context, recv, x); } @JRubyMethod(name = "tanh", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat tanh(ThreadContext context, IRubyObject recv, IRubyObject x) { return RubyFloat.newFloat(context.runtime, Math.tanh(RubyNumeric.num2dbl(context, x))); } @Deprecated public static RubyFloat tanh19(ThreadContext context, IRubyObject recv, IRubyObject x) { return tanh(context, recv, x); } @JRubyMethod(name = "acosh", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat acosh(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyNumeric.num2dbl(context, x); double result; if (Double.isNaN(value)) { result = Double.NaN; } else if (value < 1) { throw context.runtime.newMathDomainError("acosh"); } else if (value < 94906265.62) { result = Math.log(value + Math.sqrt(value * value - 1.0)); } else{ result = 0.69314718055994530941723212145818 + Math.log(value); } return RubyFloat.newFloat(context.runtime,result); } @Deprecated public static RubyFloat acosh19(ThreadContext context, IRubyObject recv, IRubyObject x) { return acosh(context, recv, x); } public static final double[] ASINH_COEF = { -.12820039911738186343372127359268e+0, -.58811761189951767565211757138362e-1, .47274654322124815640725249756029e-2, -.49383631626536172101360174790273e-3, .58506207058557412287494835259321e-4, -.74669983289313681354755069217188e-5, .10011693583558199265966192015812e-5, -.13903543858708333608616472258886e-6, .19823169483172793547317360237148e-7, -.28847468417848843612747272800317e-8, .42672965467159937953457514995907e-9, -.63976084654366357868752632309681e-10, .96991686089064704147878293131179e-11, -.14844276972043770830246658365696e-11, .22903737939027447988040184378983e-12, -.35588395132732645159978942651310e-13, .55639694080056789953374539088554e-14, -.87462509599624678045666593520162e-15, .13815248844526692155868802298129e-15, -.21916688282900363984955142264149e-16, .34904658524827565638313923706880e-17 }; @JRubyMethod(name = "asinh", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat asinh(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyNumeric.num2dbl(context, x); double y = Math.abs(value); double result; if (Double.isNaN(value)) { result = Double.NaN; } else if (y <= 1.05367e-08) { result = value; } else if (y <= 1.0) { result = value * (1.0 + chebylevSerie(2.0 * value * value - 1.0, ASINH_COEF)); } else if (y < 94906265.62) { result = Math.log(value + Math.sqrt(value * value + 1.0)); } else { result = 0.69314718055994530941723212145818 + Math.log(y); if (value < 0) result *= -1; } return RubyFloat.newFloat(context.runtime, result); } @Deprecated public static RubyFloat asinh19(ThreadContext context, IRubyObject recv, IRubyObject x) { return asinh(context, recv, x); } public static final double[] ATANH_COEF = { .9439510239319549230842892218633e-1, .4919843705578615947200034576668e-1, .2102593522455432763479327331752e-2, .1073554449776116584640731045276e-3, .5978267249293031478642787517872e-5, .3505062030889134845966834886200e-6, .2126374343765340350896219314431e-7, .1321694535715527192129801723055e-8, .8365875501178070364623604052959e-10, .5370503749311002163881434587772e-11, .3486659470157107922971245784290e-12, .2284549509603433015524024119722e-13, .1508407105944793044874229067558e-14, .1002418816804109126136995722837e-15, .6698674738165069539715526882986e-17, .4497954546494931083083327624533e-18 }; @JRubyMethod(name = "atanh", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat atanh(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyNumeric.num2dbl(context, x); if (value < -1.0 || value > 1.0) throw context.runtime.newMathDomainError("atanh"); final double y = Math.abs(value); final double result; if (Double.isNaN(value)) { result = Double.NaN; } else if (y < 1.82501e-08) { result = value; } else if (y <= 0.5) { result = value * (1.0 + chebylevSerie(8.0 * value * value - 1.0, ATANH_COEF)); } else if (y < 1.0) { result = 0.5 * Math.log((1.0 + value) / (1.0 - value)); } else if (y == 1.0) { result = value * Double.POSITIVE_INFINITY; } else { result = Double.NaN; } return RubyFloat.newFloat(context.runtime, result); } @Deprecated public static RubyFloat atanh_19(ThreadContext context, IRubyObject recv, IRubyObject x) { return atanh(context, recv, x); } @JRubyMethod(name = "exp", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat exp(ThreadContext context, IRubyObject recv, IRubyObject exponent) { return RubyFloat.newFloat(context.runtime, Math.exp(RubyNumeric.num2dbl(context, exponent))); } @Deprecated public static RubyFloat exp19(ThreadContext context, IRubyObject recv, IRubyObject exponent) { return exp(context, recv, exponent); } private static RubyFloat logCommon(ThreadContext context, double value, double base, String msg) { if (value < 0 || base < 0) throw context.runtime.newMathDomainError(msg); return RubyFloat.newFloat(context.runtime, Math.log(value) / Math.log(base)); }
Returns the natural logarithm of x.
/** Returns the natural logarithm of x. * */
@JRubyMethod(name = "log", module = true, visibility = Visibility.PRIVATE) public static RubyFloat log(ThreadContext context, IRubyObject recv, IRubyObject val) { double value = RubyNumeric.num2dbl(context, val); return logCommon(context, value, Math.E, "log"); } @JRubyMethod(name = "log", module = true, visibility = Visibility.PRIVATE) public static RubyFloat log(ThreadContext context, IRubyObject recv, IRubyObject val, IRubyObject base) { double value = RubyNumeric.num2dbl(context, val); double _base = RubyNumeric.num2dbl(context, base); return logCommon(context, value, _base, "log"); } public static RubyFloat log(ThreadContext context, IRubyObject recv, IRubyObject... args) { if (args.length == 2) { return log(context, recv, args[0], args[1]); } return log(context, recv, args[0]); } @Deprecated public static RubyFloat log_19(ThreadContext context, IRubyObject recv, IRubyObject[] args) { return log(context, recv, args); }
Returns the base 10 logarithm of x.
/** Returns the base 10 logarithm of x. * */
@JRubyMethod(name = "log10", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat log10(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyNumeric.num2dbl(context, x); if (value < 0) { throw context.runtime.newMathDomainError("log10"); } return RubyFloat.newFloat(context.runtime, Math.log10(value)); } @Deprecated public static RubyFloat log10_19(ThreadContext context, IRubyObject recv, IRubyObject x) { return log10(context, recv, x); }
Returns the base 2 logarithm of x.
/** Returns the base 2 logarithm of x. * */
@JRubyMethod(name = "log2", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat log2(ThreadContext context, IRubyObject recv, IRubyObject x) { return logCommon(context, RubyNumeric.num2dbl(context, x), 2, "log2"); } @Deprecated public static RubyFloat log2_19(ThreadContext context, IRubyObject recv, IRubyObject x) { return log2(context, recv, x); } @JRubyMethod(name = "sqrt", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat sqrt(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyNumeric.num2dbl(context, x); if (value < 0) throw context.runtime.newMathDomainError("sqrt"); return RubyFloat.newFloat(context.runtime, value == 0.0 ? 0.0 : Math.sqrt(value)); } @Deprecated public static RubyFloat sqrt19(ThreadContext context, IRubyObject recv, IRubyObject x) { return sqrt(context, recv, x); } @JRubyMethod(name = "cbrt", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat cbrt(ThreadContext context, IRubyObject recv, IRubyObject x) { double result = Math.cbrt(RubyNumeric.num2dbl(context, x)); domainCheck(recv, result, "cbrt"); return RubyFloat.newFloat(context.runtime, result); } public static RubyFloat hypot(ThreadContext context, IRubyObject recv, IRubyObject x, IRubyObject y) { return hypot19(context, recv, x, y); } @JRubyMethod(name = "hypot", required = 2, module = true, visibility = Visibility.PRIVATE) public static RubyFloat hypot19(ThreadContext context, IRubyObject recv, IRubyObject x, IRubyObject y) { double valuea = RubyNumeric.num2dbl(context, x); double valueb = RubyNumeric.num2dbl(context, y); double result; if (Math.abs(valuea) > Math.abs(valueb)) { result = valueb / valuea; result = Math.abs(valuea) * Math.sqrt(1 + result * result); } else if (valueb != 0) { result = valuea / valueb; result = Math.abs(valueb) * Math.sqrt(1 + result * result); } else if (Double.isNaN(valuea) || Double.isNaN(valueb)) { result = Double.NaN; } else { result = 0; } return RubyFloat.newFloat(context.runtime,result); } /* * x = mantissa * 2 ** exponent * * Where mantissa is in the range of [.5, 1) * */ @JRubyMethod(name = "frexp", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyArray frexp(ThreadContext context, IRubyObject recv, IRubyObject other) { double mantissa = RubyNumeric.num2dbl(context, other); short sign = 1; long exponent = 0; if (!Double.isInfinite(mantissa) && mantissa != 0.0) { // Make mantissa same sign so we only have one code path. if (mantissa < 0) { mantissa = -mantissa; sign = -1; } // Increase value to hit lower range. for (; mantissa < 0.5; mantissa *= 2.0, exponent -=1) { } // Decrease value to hit upper range. for (; mantissa >= 1.0; mantissa *= 0.5, exponent +=1) { } } return RubyArray.newArray(context.runtime, RubyFloat.newFloat(context.runtime, sign * mantissa), RubyNumeric.int2fix(context.runtime, exponent)); } @Deprecated public static RubyArray frexp19(ThreadContext context, IRubyObject recv, IRubyObject other) { return frexp(context, recv, other); } /* * r = x * 2 ** y */ @JRubyMethod(name = "ldexp", required = 2, module = true, visibility = Visibility.PRIVATE) public static RubyFloat ldexp(ThreadContext context, IRubyObject recv, IRubyObject mantissa, IRubyObject exponent) { return RubyFloat.newFloat(context.runtime, RubyNumeric.num2dbl(context, mantissa) * Math.pow(2.0, RubyNumeric.num2int(exponent))); } public static RubyFloat ldexp19(ThreadContext context, IRubyObject recv, IRubyObject mantissa, IRubyObject exponent) { return ldexp(context, recv, mantissa, exponent); } public static final double[] ERFC_COEF = { -.490461212346918080399845440334e-1, -.142261205103713642378247418996e0, .100355821875997955757546767129e-1, -.576876469976748476508270255092e-3, .274199312521960610344221607915e-4, -.110431755073445076041353812959e-5, .384887554203450369499613114982e-7, -.118085825338754669696317518016e-8, .323342158260509096464029309534e-10, -.799101594700454875816073747086e-12, .179907251139614556119672454866e-13, -.371863548781869263823168282095e-15, .710359900371425297116899083947e-17, -.126124551191552258324954248533e-18 }; @JRubyMethod(name = "erf", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat erf(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyNumeric.num2dbl(context, x); double result; double y = Math.abs(value); if (y <= 1.49012e-08) { result = 2 * value / 1.77245385090551602729816748334; } else if (y <= 1) { result = value * (1 + chebylevSerie(2 * value * value - 1, ERFC_COEF)); } else if (y < 6.013687357) { result = sign(1 - erfc(context, recv, RubyFloat.newFloat(context.runtime, y)).value, value); } else if (Double.isNaN(y)) { result = Double.NaN; } else { result = sign(1, value); } return RubyFloat.newFloat(context.runtime,result); } public static RubyFloat erf19(ThreadContext context, IRubyObject recv, IRubyObject x) { return erf(context, recv, x); } public static final double[] ERFC2_COEF = { -.69601346602309501127391508262e-1, -.411013393626208934898221208467e-1, .391449586668962688156114370524e-2, -.490639565054897916128093545077e-3, .715747900137703638076089414183e-4, -.115307163413123283380823284791e-4, .199467059020199763505231486771e-5, -.364266647159922287393611843071e-6, .694437261000501258993127721463e-7, -.137122090210436601953460514121e-7, .278838966100713713196386034809e-8, -.581416472433116155186479105032e-9, .123892049175275318118016881795e-9, -.269063914530674343239042493789e-10, .594261435084791098244470968384e-11, -.133238673575811957928775442057e-11, .30280468061771320171736972433e-12, -.696664881494103258879586758895e-13, .162085454105392296981289322763e-13, -.380993446525049199987691305773e-14, .904048781597883114936897101298e-15, -.2164006195089607347809812047e-15, .522210223399585498460798024417e-16, -.126972960236455533637241552778e-16, .310914550427619758383622741295e-17, -.766376292032038552400956671481e-18, .190081925136274520253692973329e-18 }; public static final double[] ERFCC_COEF = { .715179310202924774503697709496e-1, -.265324343376067157558893386681e-1, .171115397792085588332699194606e-2, -.163751663458517884163746404749e-3, .198712935005520364995974806758e-4, -.284371241276655508750175183152e-5, .460616130896313036969379968464e-6, -.822775302587920842057766536366e-7, .159214187277090112989358340826e-7, -.329507136225284321486631665072e-8, .72234397604005554658126115389e-9, -.166485581339872959344695966886e-9, .401039258823766482077671768814e-10, -.100481621442573113272170176283e-10, .260827591330033380859341009439e-11, -.699111056040402486557697812476e-12, .192949233326170708624205749803e-12, -.547013118875433106490125085271e-13, .158966330976269744839084032762e-13, -.47268939801975548392036958429e-14, .14358733767849847867287399784e-14, -.444951056181735839417250062829e-15, .140481088476823343737305537466e-15, -.451381838776421089625963281623e-16, .147452154104513307787018713262e-16, -.489262140694577615436841552532e-17, .164761214141064673895301522827e-17, -.562681717632940809299928521323e-18, .194744338223207851429197867821e-18 }; @JRubyMethod(name = "erfc", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat erfc(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyNumeric.num2dbl(context, x); double result; double y = Math.abs(value); if (value <= -6.013687357) { result = 2; } else if (y < 1.49012e-08) { result = 1 - 2 * value / 1.77245385090551602729816748334; } else { double ysq = y*y; if (y < 1) { result = 1 - value * (1 + chebylevSerie(2 * ysq - 1, ERFC_COEF)); } else if (y <= 4.0) { result = Math.exp(-ysq)/y*(0.5+chebylevSerie((8.0 / ysq - 5.0) / 3.0, ERFC2_COEF)); if (value < 0) result = 2.0 - result; if (value < 0) result = 2.0 - result; if (value < 0) result = 2.0 - result; } else { result = Math.exp(-ysq) / y * (0.5 + chebylevSerie(8.0 / ysq - 1, ERFCC_COEF)); if (value < 0) result = 2.0 - result; } } return RubyFloat.newFloat(context.runtime,result); } @Deprecated public static RubyFloat erfc19(ThreadContext context, IRubyObject recv, IRubyObject x) { return erfc(context, recv, x); } private static final double FACTORIAL[] = { /* 0! */ 1.0, /* 1! */ 1.0, /* 2! */ 2.0, /* 3! */ 6.0, /* 4! */ 24.0, /* 5! */ 120.0, /* 6! */ 720.0, /* 7! */ 5040.0, /* 8! */ 40320.0, /* 9! */ 362880.0, /* 10! */ 3628800.0, /* 11! */ 39916800.0, /* 12! */ 479001600.0, /* 13! */ 6227020800.0, /* 14! */ 87178291200.0, /* 15! */ 1307674368000.0, /* 16! */ 20922789888000.0, /* 17! */ 355687428096000.0, /* 18! */ 6402373705728000.0, /* 19! */ 121645100408832000.0, /* 20! */ 2432902008176640000.0, /* 21! */ 51090942171709440000.0, /* 22! */ 1124000727777607680000.0 }; private static final double NEMES_GAMMA_COEFF[] = { 1.00000000000000000000000000000000000, 0 , 0.08333333333333333333333333333333333, 0 , 0.00069444444444444444444444444444444, 0 , 0.00065861992945326278659611992945326, 0 , -0.00053287817827748383303938859494415, 0 , 0.00079278588700608376534302460228386, 0 , -0.00184758189322033028400606295961969, 0 , 0.00625067824784941846328836824623616, 0 , -0.02901710246301150993444701506844402, 0 , 0.17718457242491308890302832366796470, 0 , -1.37747681703993534399676348903067470 };
Based on Gergő Nemes's Gamma Function approximation formula, we compute approximate value of Gamma function of x.
Params:
  • recv – Math module
  • x – a real number
See Also:
Returns:Γ(x) for real number x
/** * Based on Gerg&#337; Nemes's Gamma Function approximation formula, we compute * approximate value of Gamma function of x. * @param recv Math module * @param x a real number * @return &Gamma;(x) for real number x * @see <a href="http://www.ebyte.it/library/downloads/2008_MTH_Nemes_GammaApproximationUpdate.pdf"> * New asymptotic expansion for the &Gamma;(x) function</a> */
@JRubyMethod(name = "gamma", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyFloat gamma(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyKernel.new_float(context.runtime, x).value; double result = nemes_gamma(value); /* note nemes_gamma can return Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY * when value is an integer less than 1. * We treat 0 as a special case to avoid Domain error. */ if (Double.isInfinite(result)) { if (value < 0) { result = Double.NaN; } else { if (value == 0 && 1 / value < 0) { result = Double.NEGATIVE_INFINITY; } else { result = Double.POSITIVE_INFINITY; } } } if (Double.isNaN(value)) { return RubyFloat.newFloat(context.runtime, Double.NaN); } domainCheck19(recv, result, "gamma"); return RubyFloat.newFloat(context.runtime, result); }
Based on Gergő Nemes's Gamma Function approximation formula, we compute Log Gamma function for real number x.
Params:
  • recv – Math module
  • x – a real number
See Also:
Returns:2-element array [ln(Γ(x)), sgn] for real number x, where sgn is the sign of Γ(x) when exponentiated
/** * Based on Gerg&#337; Nemes's Gamma Function approximation formula, we compute * Log Gamma function for real number x. * @param recv Math module * @param x a real number * @return 2-element array [ln(&Gamma;(x)), sgn] for real number x, * where sgn is the sign of &Gamma;(x) when exponentiated * @see #gamma(ThreadContext, org.jruby.runtime.builtin.IRubyObject, org.jruby.runtime.builtin.IRubyObject) */
@JRubyMethod(name = "lgamma", required = 1, module = true, visibility = Visibility.PRIVATE) public static RubyArray lgamma(ThreadContext context, IRubyObject recv, IRubyObject x) { double value = RubyKernel.new_float(context.runtime, x).value; // JRUBY-4653: Could this error checking done more elegantly? if (value < 0 && Double.isInfinite(value)) throw context.runtime.newMathDomainError("lgamma"); NemesLogGamma l = new NemesLogGamma(value); return RubyArray.newArray(context.runtime, RubyFloat.newFloat(context.runtime, l.value), RubyInteger.int2fix(context.runtime, (int) l.sign)); } public static double nemes_gamma(double x) { double int_part = (int) x; if ((x - int_part) == 0.0 && 0 < int_part && int_part <= FACTORIAL.length) { return FACTORIAL[(int) int_part - 1]; } NemesLogGamma l = new NemesLogGamma(x); return l.sign * Math.exp(l.value); }
Inner class to help with Γ functions
/** * Inner class to help with &Gamma; functions */
public static class NemesLogGamma { public final double value; public final double sign; public NemesLogGamma(double x) { if (Double.isInfinite(x)) { value = Double.POSITIVE_INFINITY; sign = 1; return; } if (Double.isNaN(x)) { value = Double.NaN; sign = 1; return; } double int_part = (int) x; sign = signum(x, int_part); if ((x - int_part) == 0.0 && 0 < int_part && int_part <= FACTORIAL.length) { value = Math.log(FACTORIAL[(int) int_part - 1]); } else if (x < 10) { double rising_factorial = 1; for (int i = 0; i < (int) Math.abs(x) - int_part + 10; i++) { rising_factorial *= (x + i); } NemesLogGamma l = new NemesLogGamma(x + (int) Math.abs(x) - int_part + 10); value = l.value - Math.log(Math.abs(rising_factorial)); } else { double temp = 0.0; for (int i = 0; i < NEMES_GAMMA_COEFF.length; i++) { temp += NEMES_GAMMA_COEFF[i] * 1.0 / Math.pow(x, i); } value = x * (Math.log(x) - 1 + Math.log(temp)) + (Math.log(2) + Math.log(Math.PI) - Math.log(x)) / 2.0; } } private static int signum(final double x, final double int_part) { return ( (int_part % 2 == 0 && (x - int_part) != 0.0 && (x < 0)) || negZero(x) ) ? -1 : 1; } private static boolean negZero(final double x) { return x == 0.0 && Double.doubleToRawLongBits(x) != 0; // detect -0.0 (since in Java: `0.0 == -0.0`) } } }