bigdecimal 3.3.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5446d4c544dfb6172f0b215366aed68dd7a3df1cceef23c2fa7735d55489c93a
-  data.tar.gz: 2f17c5cf3a70a9131446dacbdc6fda43e0ac4dce58f8041446e94b6ad9b5e22c
+  metadata.gz: 218ec856a55103fe791e5478b1d9a2e1256f1d9eebb20ad69f3ab9319a84dda6
+  data.tar.gz: 004e5a6c9481412f548c5244c18620247592c53a39e3b6e65aaa6c3ff9ed8cdc
 SHA512:
-  metadata.gz: ecc33314be340556b87315c8b95b93c9f8657d01c76fd08265cd7cc4028cc8400c804533dc1db810c439761ee5e85aa7c75d7ebc959de40d726c50fd7798852b
-  data.tar.gz: 4e7a4d1271238dbda723e4e89b868250f666744b98476edcb50a55d541aa19ad5e3f85610f572ce4061f42bc13cf34732bf1bf8a1a3f84bd4e060ed99ab221f7
+  metadata.gz: f9c25edb664fe67c7e4b6892629ef41a73183bee8a592b3f15885baac834bfa193b1dbf88622a85db42608f15fc9156046a934c030731159f14d97709b032d5c
+  data.tar.gz: ec44919000395e1b9dd463bdfcfe87b0c8c21999a40099b24b009d453dcfd7cefbfc8e0faf62b6a8c5fe49ab90bada5cee75d1be0bbb97d65a5a698fff5ef26a

data/ext/bigdecimal/bigdecimal.c

@@ -31,7 +31,7 @@
 #include "bits.h"
 #include "static_assert.h"
 
-#define BIGDECIMAL_VERSION "3.3.1"
+#define BIGDECIMAL_VERSION "4.0.0"
 
 /* #define ENABLE_NUMERIC_STRING */
 
@@ -400,37 +400,6 @@ BigDecimal_double_fig(VALUE self)
     return INT2FIX(BIGDECIMAL_DOUBLE_FIGURES);
 }
 
-/*  call-seq:
- *    precs -> array
- *
- *  Returns an Array of two Integer values that represent platform-dependent
- *  internal storage properties.
- *
- *  This method is deprecated and will be removed in the future.
- *  Instead, use BigDecimal#n_significant_digits for obtaining the number of
- *  significant digits in scientific notation, and BigDecimal#precision for
- *  obtaining the number of digits in decimal notation.
- *
- */
-
-static VALUE
-BigDecimal_prec(VALUE self)
-{
-    BDVALUE v;
-    VALUE obj;
-
-    rb_category_warn(RB_WARN_CATEGORY_DEPRECATED,
-                     "BigDecimal#precs is deprecated and will be removed in the future; "
-                     "use BigDecimal#precision instead.");
-
-    v = GetBDValueMust(self);
-    obj = rb_assoc_new(SIZET2NUM(v.real->Prec*VpBaseFig()),
-		       SIZET2NUM(v.real->MaxPrec*VpBaseFig()));
-
-    RB_GC_GUARD(v.bigdecimal);
-    return obj;
-}
-
 static void
 VpCountPrecisionAndScale(Real *p, ssize_t *out_precision, ssize_t *out_scale)
 {
@@ -1867,7 +1836,7 @@ BigDecimal_divmod(VALUE self, VALUE r)
     NULLABLE_BDVALUE div, mod;
 
     if (BigDecimal_DoDivmod(self, r, &div, &mod, false)) {
-        return rb_assoc_new(CheckGetValue(bdvalue_nonnullable(div)), CheckGetValue(bdvalue_nonnullable(mod)));
+        return rb_assoc_new(BigDecimal_to_i(CheckGetValue(bdvalue_nonnullable(div))), CheckGetValue(bdvalue_nonnullable(mod)));
     }
     return DoSomeOne(self,r,rb_intern("divmod"));
 }
@@ -2507,7 +2476,7 @@ BigDecimal_decimal_shift(VALUE self, VALUE v)
     prec = a.real->Prec + shiftDown;
     c = NewZeroWrap(1, prec * BASE_FIG);
     if (shift == 0) {
-        VpAsgn(c.real, a.real, 1);
+        VpAsgn(c.real, a.real, 10);
     } else if (shiftDown) {
         DECDIG carry = 0;
         exponentShift++;
@@ -3593,7 +3562,6 @@ Init_bigdecimal(void)
     rb_define_const(rb_cBigDecimal, "NAN", BIGDECIMAL_LITERAL(NAN, NaN));
 
     /* instance methods */
-    rb_define_method(rb_cBigDecimal, "precs", BigDecimal_prec, 0);
     rb_define_method(rb_cBigDecimal, "precision", BigDecimal_precision, 0);
     rb_define_method(rb_cBigDecimal, "scale", BigDecimal_scale, 0);
     rb_define_method(rb_cBigDecimal, "precision_scale", BigDecimal_precision_scale, 0);
@@ -6166,7 +6134,7 @@ VpFrac(Real *y, Real *x)
     size_t my, ind_y, ind_x;
 
     if (!VpHasVal(x)) {
-	VpAsgn(y, x, 1);
+	VpAsgn(y, x, 10);
 	goto Exit;
     }
 
@@ -6175,7 +6143,7 @@ VpFrac(Real *y, Real *x)
 	goto Exit;
     }
     else if (x->exponent <= 0) {
-	VpAsgn(y, x, 1);
+	VpAsgn(y, x, 10);
 	goto Exit;
     }
 

data/lib/bigdecimal/jacobian.rb

@@ -2,6 +2,8 @@
 
 require 'bigdecimal'
 
+warn "'bigdecimal/jacobian' is deprecated and will be removed in a future release."
+
 # require 'bigdecimal/jacobian'
 #
 # Provides methods to compute the Jacobian matrix of a set of equations at a

data/lib/bigdecimal/ludcmp.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: false
 require 'bigdecimal'
 
+warn "'bigdecimal/ludcmp' is deprecated and will be removed in a future release."
+
 #
 # Solves a*x = b for x, using LU decomposition.
 #

data/lib/bigdecimal/math.rb

@@ -5,15 +5,36 @@ require 'bigdecimal'
 #--
 # Contents:
 #   sqrt(x, prec)
+#   cbrt(x, prec)
+#   hypot(x, y, prec)
 #   sin (x, prec)
 #   cos (x, prec)
 #   tan (x, prec)
+#   asin(x, prec)
+#   acos(x, prec)
 #   atan(x, prec)
+#   atan2(y, x, prec)
+#   sinh (x, prec)
+#   cosh (x, prec)
+#   tanh (x, prec)
+#   asinh(x, prec)
+#   acosh(x, prec)
+#   atanh(x, prec)
+#   log2 (x, prec)
+#   log10(x, prec)
+#   log1p(x, prec)
+#   expm1(x, prec)
+#   erf (x, prec)
+#   erfc(x, prec)
+#   gamma(x, prec)
+#   lgamma(x, prec)
+#   frexp(x)
+#   ldexp(x, exponent)
 #   PI  (prec)
 #   E   (prec) == exp(1.0,prec)
 #
 # where:
-#   x    ... BigDecimal number to be computed.
+#   x, y ... BigDecimal number to be computed.
 #   prec ... Number of digits to be obtained.
 #++
 #
@@ -73,6 +94,53 @@ module BigMath
     end
   end
 
+  # call-seq:
+  #   cbrt(decimal, numeric) -> BigDecimal
+  #
+  # Computes the cube root of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  #   BigMath.cbrt(BigDecimal('2'), 32).to_s
+  #   #=> "0.12599210498948731647672106072782e1"
+  #
+  def cbrt(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :cbrt)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :cbrt)
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+    return BigDecimal::Internal.infinity_computation_result * x.infinite? if x.infinite?
+    return BigDecimal(0) if x.zero?
+
+    x = -x if neg = x < 0
+    ex = x.exponent / 3
+    x = x._decimal_shift(-3 * ex)
+    y = BigDecimal(Math.cbrt(x.to_f), 0)
+    precs = [prec + BigDecimal.double_fig]
+    precs << 2 + precs.last / 2 while precs.last > BigDecimal.double_fig
+    precs.reverse_each do |p|
+      y = (2 * y + x.div(y, p).div(y, p)).div(3, p)
+    end
+    y._decimal_shift(ex).mult(neg ? -1 : 1, prec)
+  end
+
+  # call-seq:
+  #   hypot(x, y, numeric) -> BigDecimal
+  #
+  # Returns sqrt(x**2 + y**2) to the specified number of digits of
+  # precision, +numeric+.
+  #
+  #   BigMath.hypot(BigDecimal('1'), BigDecimal('2'), 32).to_s
+  #   #=> "0.22360679774997896964091736687313e1"
+  #
+  def hypot(x, y, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :hypot)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :hypot)
+    y = BigDecimal::Internal.coerce_to_bigdecimal(y, prec, :hypot)
+    return BigDecimal::Internal.nan_computation_result if x.nan? || y.nan?
+    return BigDecimal::Internal.infinity_computation_result if x.infinite? || y.infinite?
+    prec2 = prec + BigDecimal.double_fig
+    sqrt(x.mult(x, prec2) + y.mult(y, prec2), prec)
+  end
+
   # call-seq:
   #   sin(decimal, numeric) -> BigDecimal
   #
@@ -148,6 +216,57 @@ module BigMath
     sin(x, prec + BigDecimal.double_fig).div(cos(x, prec + BigDecimal.double_fig), prec)
   end
 
+  # call-seq:
+  #   asin(decimal, numeric) -> BigDecimal
+  #
+  # Computes the arcsine of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.asin(BigDecimal('0.5'), 32).to_s
+  #   #=> "0.52359877559829887307710723054658e0"
+  #
+  def asin(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :asin)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :asin)
+    raise Math::DomainError, "Out of domain argument for asin" if x < -1 || x > 1
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+
+    prec2 = prec + BigDecimal.double_fig
+    cos = (1 - x**2).sqrt(prec2)
+    if cos.zero?
+      PI(prec2).div(x > 0 ? 2 : -2, prec)
+    else
+      atan(x.div(cos, prec2), prec)
+    end
+  end
+
+  # call-seq:
+  #   acos(decimal, numeric) -> BigDecimal
+  #
+  # Computes the arccosine of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.acos(BigDecimal('0.5'), 32).to_s
+  #   #=> "0.10471975511965977461542144610932e1"
+  #
+  def acos(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :acos)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :acos)
+    raise Math::DomainError, "Out of domain argument for acos" if x < -1 || x > 1
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+
+    prec2 = prec + BigDecimal.double_fig
+    return (PI(prec2) / 2).sub(asin(x, prec2), prec) if x < 0
+    return PI(prec2).div(2, prec) if x.zero?
+
+    sin = (1 - x**2).sqrt(prec2)
+    atan(sin.div(x, prec2), prec)
+  end
+
   # call-seq:
   #   atan(decimal, numeric) -> BigDecimal
   #
@@ -167,7 +286,7 @@ module BigMath
     pi = PI(n)
     x = -x if neg = x < 0
     return pi.div(neg ? -2 : 2, prec) if x.infinite?
-    return pi.div(neg ? -4 : 4, prec) if x.round(prec) == 1
+    return pi.div(neg ? -4 : 4, prec) if x.round(n) == 1
     x = BigDecimal("1").div(x, n) if inv = x > 1
     x = (-1 + sqrt(1 + x.mult(x, n), n)).div(x, n) if dbl = x > 0.5
     y = x
@@ -188,6 +307,587 @@ module BigMath
     y.mult(1, prec)
   end
 
+  # call-seq:
+  #   atan2(decimal, decimal, numeric) -> BigDecimal
+  #
+  # Computes the arctangent of y and x to the specified number of digits of
+  # precision, +numeric+.
+  #
+  #   BigMath.atan2(BigDecimal('-1'), BigDecimal('1'), 32).to_s
+  #   #=> "-0.78539816339744830961566084581988e0"
+  #
+  def atan2(y, x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :atan2)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :atan2)
+    y = BigDecimal::Internal.coerce_to_bigdecimal(y, prec, :atan2)
+    return BigDecimal::Internal.nan_computation_result if x.nan? || y.nan?
+
+    if x.infinite? || y.infinite?
+      one = BigDecimal(1)
+      zero = BigDecimal(0)
+      x = x.infinite? ? (x > 0 ? one : -one) : zero
+      y = y.infinite? ? (y > 0 ? one : -one) : y.sign * zero
+    end
+
+    return x.sign >= 0 ? BigDecimal(0) : y.sign * PI(prec) if y.zero?
+
+    y = -y if neg = y < 0
+    xlarge = y.abs < x.abs
+    prec2 = prec + BigDecimal.double_fig
+    if x > 0
+      v = xlarge ? atan(y.div(x, prec2), prec) : PI(prec2) / 2 - atan(x.div(y, prec2), prec2)
+    else
+      v = xlarge ? PI(prec2) - atan(-y.div(x, prec2), prec2) : PI(prec2) / 2 + atan(x.div(-y, prec2), prec2)
+    end
+    v.mult(neg ? -1 : 1, prec)
+  end
+
+  # call-seq:
+  #   sinh(decimal, numeric) -> BigDecimal
+  #
+  # Computes the hyperbolic sine of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.sinh(BigDecimal('1'), 32).to_s
+  #   #=> "0.11752011936438014568823818505956e1"
+  #
+  def sinh(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :sinh)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :sinh)
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+    return BigDecimal::Internal.infinity_computation_result * x.infinite? if x.infinite?
+
+    prec2 = prec + BigDecimal.double_fig
+    prec2 -= x.exponent if x.exponent < 0
+    e = exp(x, prec2)
+    (e - BigDecimal(1).div(e, prec2)).div(2, prec)
+  end
+
+  # call-seq:
+  #   cosh(decimal, numeric) -> BigDecimal
+  #
+  # Computes the hyperbolic cosine of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.cosh(BigDecimal('1'), 32).to_s
+  #   #=> "0.15430806348152437784779056207571e1"
+  #
+  def cosh(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :cosh)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :cosh)
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+    return BigDecimal::Internal.infinity_computation_result if x.infinite?
+
+    prec2 = prec + BigDecimal.double_fig
+    e = exp(x, prec2)
+    (e + BigDecimal(1).div(e, prec2)).div(2, prec)
+  end
+
+  # call-seq:
+  #   tanh(decimal, numeric) -> BigDecimal
+  #
+  # Computes the hyperbolic tangent of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.tanh(BigDecimal('1'), 32).to_s
+  #   #=> "0.76159415595576488811945828260479e0"
+  #
+  def tanh(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :tanh)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :tanh)
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+    return BigDecimal(x.infinite?) if x.infinite?
+
+    prec2 = prec + BigDecimal.double_fig + [-x.exponent, 0].max
+    e = exp(x, prec2)
+    einv = BigDecimal(1).div(e, prec2)
+    (e - einv).div(e + einv, prec)
+  end
+
+  # call-seq:
+  #   asinh(decimal, numeric) -> BigDecimal
+  #
+  # Computes the inverse hyperbolic sine of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.asinh(BigDecimal('1'), 32).to_s
+  #   #=> "0.88137358701954302523260932497979e0"
+  #
+  def asinh(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :asinh)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :asinh)
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+    return BigDecimal::Internal.infinity_computation_result * x.infinite? if x.infinite?
+    return -asinh(-x, prec) if x < 0
+
+    sqrt_prec = prec + [-x.exponent, 0].max + BigDecimal.double_fig
+    log(x + sqrt(x**2 + 1, sqrt_prec), prec)
+  end
+
+  # call-seq:
+  #   acosh(decimal, numeric) -> BigDecimal
+  #
+  # Computes the inverse hyperbolic cosine of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.acosh(BigDecimal('2'), 32).to_s
+  #   #=> "0.1316957896924816708625046347308e1"
+  #
+  def acosh(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :acosh)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :acosh)
+    raise Math::DomainError, "Out of domain argument for acosh" if x < 1
+    return BigDecimal::Internal.infinity_computation_result if x.infinite?
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+
+    log(x + sqrt(x**2 - 1, prec + BigDecimal.double_fig), prec)
+  end
+
+  # call-seq:
+  #   atanh(decimal, numeric) -> BigDecimal
+  #
+  # Computes the inverse hyperbolic tangent of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.atanh(BigDecimal('0.5'), 32).to_s
+  #   #=> "0.54930614433405484569762261846126e0"
+  #
+  def atanh(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :atanh)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :atanh)
+    raise Math::DomainError, "Out of domain argument for atanh" if x < -1 || x > 1
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+    return BigDecimal::Internal.infinity_computation_result if x == 1
+    return -BigDecimal::Internal.infinity_computation_result if x == -1
+
+    prec2 = prec + BigDecimal.double_fig
+    (log(x + 1, prec2) - log(1 - x, prec2)).div(2, prec)
+  end
+
+  # call-seq:
+  #   BigMath.log2(decimal, numeric)    -> BigDecimal
+  #
+  # Computes the base 2 logarithm of +decimal+ to the specified number of
+  # digits of precision, +numeric+.
+  #
+  # If +decimal+ is zero or negative, raises Math::DomainError.
+  #
+  # If +decimal+ is positive infinity, returns Infinity.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.log2(BigDecimal('3'), 32).to_s
+  #   #=> "0.15849625007211561814537389439478e1"
+  #
+  def log2(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :log2)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :log2)
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+    return BigDecimal::Internal.infinity_computation_result if x.infinite? == 1
+
+    prec2 = prec + BigDecimal.double_fig * 3 / 2
+    v = log(x, prec2).div(log(BigDecimal(2), prec2), prec2)
+    # Perform half-up rounding to calculate log2(2**n)==n correctly in every rounding mode
+    v = v.round(prec + BigDecimal.double_fig - (v.exponent < 0 ? v.exponent : 0), BigDecimal::ROUND_HALF_UP)
+    v.mult(1, prec)
+  end
+
+  # call-seq:
+  #   BigMath.log10(decimal, numeric)    -> BigDecimal
+  #
+  # Computes the base 10 logarithm of +decimal+ to the specified number of
+  # digits of precision, +numeric+.
+  #
+  # If +decimal+ is zero or negative, raises Math::DomainError.
+  #
+  # If +decimal+ is positive infinity, returns Infinity.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.log10(BigDecimal('3'), 32).to_s
+  #   #=> "0.47712125471966243729502790325512e0"
+  #
+  def log10(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :log10)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :log10)
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+    return BigDecimal::Internal.infinity_computation_result if x.infinite? == 1
+
+    prec2 = prec + BigDecimal.double_fig * 3 / 2
+    v = log(x, prec2).div(log(BigDecimal(10), prec2), prec2)
+    # Perform half-up rounding to calculate log10(10**n)==n correctly in every rounding mode
+    v = v.round(prec + BigDecimal.double_fig - (v.exponent < 0 ? v.exponent : 0), BigDecimal::ROUND_HALF_UP)
+    v.mult(1, prec)
+  end
+
+  # call-seq:
+  #   BigMath.log1p(decimal, numeric)    -> BigDecimal
+  #
+  # Computes log(1 + decimal) to the specified number of digits of precision, +numeric+.
+  #
+  #   BigMath.log1p(BigDecimal('0.1'), 32).to_s
+  #   #=> "0.95310179804324860043952123280765e-1"
+  #
+  def log1p(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :log1p)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :log1p)
+    raise Math::DomainError, 'Out of domain argument for log1p' if x < -1
+
+    return log(x + 1, prec)
+  end
+
+  # call-seq:
+  #   BigMath.expm1(decimal, numeric)    -> BigDecimal
+  #
+  # Computes exp(decimal) - 1 to the specified number of digits of precision, +numeric+.
+  #
+  #   BigMath.expm1(BigDecimal('0.1'), 32).to_s
+  #   #=> "0.10517091807564762481170782649025e0"
+  #
+  def expm1(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :expm1)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :expm1)
+    return BigDecimal(-1) if x.infinite? == -1
+
+    exp_prec = prec
+    if x < -1
+      # log10(exp(x)) = x * log10(e)
+      lg_e = 0.4342944819032518
+      exp_prec = prec + (lg_e * x).ceil + BigDecimal.double_fig
+    elsif x < 1
+      exp_prec = prec - x.exponent + BigDecimal.double_fig
+    else
+      exp_prec = prec
+    end
+
+    return BigDecimal(-1) if exp_prec <= 0
+
+    exp = exp(x, exp_prec)
+
+    if exp.exponent > prec + BigDecimal.double_fig
+      # Workaroudn for https://github.com/ruby/bigdecimal/issues/464
+      exp
+    else
+      exp.sub(1, prec)
+    end
+  end
+
+  #   erf(decimal, numeric) -> BigDecimal
+  #
+  # Computes the error function of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.erf(BigDecimal('1'), 32).to_s
+  #   #=> "0.84270079294971486934122063508261e0"
+  #
+  def erf(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :erf)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :erf)
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+    return BigDecimal(x.infinite?) if x.infinite?
+    return BigDecimal(0) if x == 0
+    return -erf(-x, prec) if x < 0
+    return BigDecimal(1) if x > 5000000000 # erf(5000000000) > 1 - 1e-10000000000000000000
+
+    if x > 8
+      xf = x.to_f
+      log10_erfc = -xf ** 2 / Math.log(10) - Math.log10(xf * Math::PI ** 0.5)
+      erfc_prec = [prec + log10_erfc.ceil, 1].max
+      erfc = _erfc_asymptotic(x, erfc_prec)
+      if erfc
+        # Workaround for https://github.com/ruby/bigdecimal/issues/464
+        return BigDecimal(1) if erfc.exponent < -prec - BigDecimal.double_fig
+
+        return BigDecimal(1).sub(erfc, prec)
+      end
+    end
+
+    prec2 = prec + BigDecimal.double_fig
+    x_smallprec = x.mult(1, Integer.sqrt(prec2) / 2)
+    # Taylor series of x with small precision is fast
+    erf1 = _erf_taylor(x_smallprec, BigDecimal(0), BigDecimal(0), prec2)
+    # Taylor series converges quickly for small x
+    _erf_taylor(x - x_smallprec, x_smallprec, erf1, prec2).mult(1, prec)
+  end
+
+  # call-seq:
+  #   erfc(decimal, numeric) -> BigDecimal
+  #
+  # Computes the complementary error function of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is NaN, returns NaN.
+  #
+  #   BigMath.erfc(BigDecimal('10'), 32).to_s
+  #   #=> "0.20884875837625447570007862949578e-44"
+  #
+  def erfc(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :erfc)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :erfc)
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+    return BigDecimal(1 - x.infinite?) if x.infinite?
+    return BigDecimal(1).sub(erf(x, prec + BigDecimal.double_fig), prec) if x < 0
+    return BigDecimal(0) if x > 5000000000 # erfc(5000000000) < 1e-10000000000000000000 (underflow)
+
+    if x >= 8
+      y = _erfc_asymptotic(x, prec)
+      return y.mult(1, prec) if y
+    end
+
+    # erfc(x) = 1 - erf(x) < exp(-x**2)/x/sqrt(pi)
+    # Precision of erf(x) needs about log10(exp(-x**2)) extra digits
+    log10 = 2.302585092994046
+    high_prec = prec + BigDecimal.double_fig + (x.ceil**2 / log10).ceil
+    BigDecimal(1).sub(erf(x, high_prec), prec)
+  end
+
+  # Calculates erf(x + a)
+  private_class_method def _erf_taylor(x, a, erf_a, prec) # :nodoc:
+    return erf_a if x.zero?
+    # Let f(x+a) = erf(x+a)*exp((x+a)**2)*sqrt(pi)/2
+    #            = c0 + c1*x + c2*x**2 + c3*x**3 + c4*x**4 + ...
+    # f'(x+a) = 1+2*(x+a)*f(x+a)
+    # f'(x+a) = c1 + 2*c2*x + 3*c3*x**2 + 4*c4*x**3 + 5*c5*x**4 + ...
+    #         = 1+2*(x+a)*(c0 + c1*x + c2*x**2 + c3*x**3 + c4*x**4 + ...)
+    # therefore,
+    # c0 = f(a)
+    # c1 = 2 * a * c0 + 1
+    # c2 = (2 * c0 + 2 * a * c1) / 2
+    # c3 = (2 * c1 + 2 * a * c2) / 3
+    # c4 = (2 * c2 + 2 * a * c3) / 4
+    #
+    # All coefficients are positive when a >= 0
+
+    scale = BigDecimal(2).div(sqrt(PI(prec), prec), prec)
+    c_prev = erf_a.div(scale.mult(exp(-a*a, prec), prec), prec)
+    c_next = (2 * a * c_prev).add(1, prec).mult(x, prec)
+    sum = c_prev.add(c_next, prec)
+
+    2.step do |k|
+      c = (c_prev.mult(x, prec) + a * c_next).mult(2, prec).mult(x, prec).div(k, prec)
+      sum = sum.add(c, prec)
+      c_prev, c_next = c_next, c
+      break if [c_prev, c_next].all? { |c| c.zero?  || (c.exponent < sum.exponent - prec) }
+    end
+    value = sum.mult(scale.mult(exp(-(x + a).mult(x + a, prec), prec), prec), prec)
+    value > 1 ? BigDecimal(1) : value
+  end
+
+  private_class_method def _erfc_asymptotic(x, prec) # :nodoc:
+    # Let f(x) = erfc(x)*sqrt(pi)*exp(x**2)/2
+    # f(x) satisfies the following differential equation:
+    # 2*x*f(x) = f'(x) + 1
+    # From the above equation, we can derive the following asymptotic expansion:
+    # f(x) = (0..kmax).sum { (-1)**k * (2*k)! / 4**k / k! / x**(2*k)) } / x
+
+    # This asymptotic expansion does not converge.
+    # But if there is a k that satisfies (2*k)! / 4**k / k! / x**(2*k) < 10**(-prec),
+    # It is enough to calculate erfc within the given precision.
+    # Using Stirling's approximation, we can simplify this condition to:
+    # sqrt(2)/2 + k*log(k) - k - 2*k*log(x) < -prec*log(10)
+    # and the left side is minimized when k = x**2.
+    prec += BigDecimal.double_fig
+    xf = x.to_f
+    kmax = (1..(xf ** 2).floor).bsearch do |k|
+      Math.log(2) / 2 + k * Math.log(k) - k - 2 * k * Math.log(xf) < -prec * Math.log(10)
+    end
+    return unless kmax
+
+    sum = BigDecimal(1)
+    x2 = x.mult(x, prec)
+    d = BigDecimal(1)
+    (1..kmax).each do |k|
+      d = d.div(x2, prec).mult(1 - 2 * k, prec).div(2, prec)
+      sum = sum.add(d, prec)
+    end
+    sum.div(exp(x2, prec).mult(PI(prec).sqrt(prec), prec), prec).div(x, prec)
+  end
+
+  # call-seq:
+  #   BigMath.gamma(decimal, numeric)    -> BigDecimal
+  #
+  # Computes the gamma function of +decimal+ to the specified number of
+  # digits of precision, +numeric+.
+  #
+  #   BigMath.gamma(BigDecimal('0.5'), 32).to_s
+  #   #=> "0.17724538509055160272981674833411e1"
+  #
+  def gamma(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :gamma)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :gamma)
+    prec2 = prec + BigDecimal.double_fig
+    if x < 0.5
+      raise Math::DomainError, 'Numerical argument is out of domain - gamma' if x.frac.zero?
+
+      # Euler's reflection formula: gamma(z) * gamma(1-z) = pi/sin(pi*z)
+      pi = PI(prec2)
+      sin = _sinpix(x, pi, prec2)
+      return pi.div(gamma(1 - x, prec2).mult(sin, prec2), prec)
+    elsif x.frac.zero? && x < 1000 * prec
+      return _gamma_positive_integer(x, prec2).mult(1, prec)
+    end
+
+    a, sum = _gamma_spouge_sum_part(x, prec2)
+    (x + (a - 1)).power(x - 0.5, prec2).mult(BigMath.exp(1 - x, prec2), prec2).mult(sum, prec)
+  end
+
+  # call-seq:
+  #   BigMath.lgamma(decimal, numeric)    -> [BigDecimal, Integer]
+  #
+  # Computes the natural logarithm of the absolute value of the gamma function
+  # of +decimal+ to the specified number of digits of precision, +numeric+ and its sign.
+  #
+  #   BigMath.lgamma(BigDecimal('0.5'), 32)
+  #   #=> [0.57236494292470008707171367567653e0, 1]
+  #
+  def lgamma(x, prec)
+    prec = BigDecimal::Internal.coerce_validate_prec(prec, :lgamma)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :lgamma)
+    prec2 = prec + BigDecimal.double_fig
+    if x < 0.5
+      return [BigDecimal::INFINITY, 1] if x.frac.zero?
+
+      loop do
+        # Euler's reflection formula: gamma(z) * gamma(1-z) = pi/sin(pi*z)
+        pi = PI(prec2)
+        sin = _sinpix(x, pi, prec2)
+        log_gamma = BigMath.log(pi, prec2).sub(lgamma(1 - x, prec2).first + BigMath.log(sin.abs, prec2), prec)
+        return [log_gamma, sin > 0 ? 1 : -1] if prec2 + log_gamma.exponent > prec + BigDecimal.double_fig
+
+        # Retry with higher precision if loss of significance is too large
+        prec2 = prec2 * 3 / 2
+      end
+    elsif x.frac.zero? && x < 1000 * prec
+      log_gamma = BigMath.log(_gamma_positive_integer(x, prec2), prec)
+      [log_gamma, 1]
+    else
+      # if x is close to 1 or 2, increase precision to reduce loss of significance
+      diff1_exponent = (x - 1).exponent
+      diff2_exponent = (x - 2).exponent
+      extra_prec = [-diff1_exponent, -diff2_exponent, 0].max
+      extremely_near_one = diff1_exponent < -prec2
+      extremely_near_two = diff2_exponent < -prec2
+
+      if extremely_near_one || extremely_near_two
+        # If x is extreamely close to base = 1 or 2, linear interpolation is accurate enough.
+        # Taylor expansion at x = base is: (x - base) * digamma(base) + (x - base) ** 2 * trigamma(base) / 2 + ...
+        # And we can ignore (x - base) ** 2 and higher order terms.
+        base = extremely_near_one ? 1 : 2
+        d = BigDecimal(1)._decimal_shift(1 - prec2)
+        log_gamma_d, sign = lgamma(base + d, prec2)
+        return [log_gamma_d.mult(x - base, prec2).div(d, prec), sign]
+      end
+
+      prec2 += [-diff1_exponent, -diff2_exponent, 0].max
+      a, sum = _gamma_spouge_sum_part(x, prec2)
+      log_gamma = BigMath.log(sum, prec2).add((x - 0.5).mult(BigMath.log(x.add(a - 1, prec2), prec2), prec2) + 1 - x, prec)
+      [log_gamma, 1]
+    end
+  end
+
+  # Returns sum part: sqrt(2*pi) and c[k]/(x+k) terms of Spouge's approximation
+  private_class_method def _gamma_spouge_sum_part(x, prec) # :nodoc:
+    x -= 1
+    # Spouge's approximation
+    # x! = (x + a)**(x + 0.5) * exp(-x - a) * (sqrt(2 * pi)  + (1..a - 1).sum{|k| c[k] / (x + k) } + epsilon)
+    # where c[k] = (-1)**k * (a - k)**(k - 0.5) * exp(a - k) / (k - 1)!
+    # and epsilon is bounded by a**(-0.5) * (2 * pi) ** (-a - 0.5)
+
+    # Estimate required a for given precision
+    a = (prec / Math.log10(2 * Math::PI)).ceil
+
+    # Calculate exponent of c[k] in low precision to estimate required precision
+    low_prec = 16
+    log10f = Math.log(10)
+    x_low_prec = x.mult(1, low_prec)
+    loggamma_k = 0
+    ck_exponents = (1..a-1).map do |k|
+      loggamma_k += Math.log10(k - 1) if k > 1
+      -loggamma_k - k / log10f + (k - 0.5) * Math.log10(a - k) - BigMath.log10(x_low_prec.add(k, low_prec), low_prec)
+    end
+
+    # Estimate exponent of sum by Stirling's approximation
+    approx_sum_exponent = x < 1 ? -Math.log10(a) / 2 : Math.log10(2 * Math::PI) / 2 + x_low_prec.add(0.5, low_prec) * Math.log10(x_low_prec / x_low_prec.add(a, low_prec))
+
+    # Determine required precision of c[k]
+    prec2 = [ck_exponents.max.ceil - approx_sum_exponent.floor, 0].max + prec
+
+    einv = BigMath.exp(-1, prec2)
+    sum = (PI(prec) * 2).sqrt(prec).mult(BigMath.exp(-a, prec), prec)
+    y = BigDecimal(1)
+    (1..a - 1).each do |k|
+      # c[k] = (-1)**k * (a - k)**(k - 0.5) * exp(-k) / (k-1)! / (x + k)
+      y = y.div(1 - k, prec2) if k > 1
+      y = y.mult(einv, prec2)
+      z = y.mult(BigDecimal((a - k) ** k), prec2).div(BigDecimal(a - k).sqrt(prec2).mult(x.add(k, prec2), prec2), prec2)
+      # sum += c[k] / (x + k)
+      sum = sum.add(z, prec2)
+    end
+    [a, sum]
+  end
+
+  private_class_method def _gamma_positive_integer(x, prec) # :nodoc:
+    return x if x == 1
+    numbers = (1..x - 1).map {|i| BigDecimal(i) }
+    while numbers.size > 1
+      numbers = numbers.each_slice(2).map {|a, b| b ? a.mult(b, prec) : a }
+    end
+    numbers.first
+  end
+
+  # Returns sin(pi * x), for gamma reflection formula calculation
+  private_class_method def _sinpix(x, pi, prec) # :nodoc:
+    x = x % 2
+    sign = x > 1 ? -1 : 1
+    x %= 1
+    x = 1 - x if x > 0.5 # to avoid sin(pi*x) loss of precision for x close to 1
+    sign * sin(x.mult(pi, prec), prec)
+  end
+
+  # call-seq:
+  #   frexp(x) -> [BigDecimal, Integer]
+  #
+  # Decomposes +x+ into a normalized fraction and an integral power of ten.
+  #
+  #   BigMath.frexp(BigDecimal(123.456))
+  #   #=> [0.123456e0, 3]
+  #
+  def frexp(x)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, 0, :frexp)
+    return [x, 0] unless x.finite?
+
+    exponent = x.exponent
+    [x._decimal_shift(-exponent), exponent]
+  end
+
+  # call-seq:
+  #   ldexp(fraction, exponent) -> BigDecimal
+  #
+  # Inverse of +frexp+.
+  # Returns the value of fraction * 10**exponent.
+  #
+  #   BigMath.ldexp(BigDecimal("0.123456e0"), 3)
+  #   #=> 0.123456e3
+  #
+  def ldexp(x, exponent)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, 0, :ldexp)
+    x.finite? ? x._decimal_shift(exponent) : x
+  end
+
   # call-seq:
   #   PI(numeric) -> BigDecimal
   #
@@ -244,6 +944,6 @@ module BigMath
   #
   def E(prec)
     prec = BigDecimal::Internal.coerce_validate_prec(prec, :E)
-    BigMath.exp(1, prec)
+    exp(1, prec)
   end
 end

data/lib/bigdecimal/newton.rb

@@ -2,6 +2,8 @@
 require "bigdecimal/ludcmp"
 require "bigdecimal/jacobian"
 
+warn "'bigdecimal/newton' is deprecated and will be removed in a future release."
+
 #
 # newton.rb
 #

data/lib/bigdecimal.rb

@@ -144,10 +144,10 @@ class BigDecimal
       return BigDecimal(1)
     end
 
-    prec = BigDecimal.limit if prec.zero?
+    limit = BigDecimal.limit
     frac_part = y.frac
 
-    if frac_part.zero? && prec.zero?
+    if frac_part.zero? && prec.zero? && limit.zero?
       # Infinite precision calculation for `x ** int` and `x.power(int)`
       int_part = y.fix.to_i
       int_part = -int_part if (neg = int_part < 0)
@@ -167,18 +167,19 @@ class BigDecimal
       return neg ? BigDecimal(1) / ans : ans
     end
 
-    prec = [x.n_significant_digits, y.n_significant_digits, BigDecimal.double_fig].max + BigDecimal.double_fig if prec.zero?
+    result_prec = prec.nonzero? || [x.n_significant_digits, y.n_significant_digits, BigDecimal.double_fig].max + BigDecimal.double_fig
+    result_prec = [result_prec, limit].min if prec.zero? && limit.nonzero?
+
+    prec2 = result_prec + BigDecimal.double_fig
 
     if y < 0
-      inv = x.power(-y, prec)
+      inv = x.power(-y, prec2)
       return BigDecimal(0) if inv.infinite?
       return BigDecimal::Internal.infinity_computation_result if inv.zero?
-      return BigDecimal(1).div(inv, prec)
+      return BigDecimal(1).div(inv, result_prec)
     end
 
-    prec2 = prec + BigDecimal.double_fig
-
-    if frac_part.zero? && y.exponent < Math.log(prec) * 5 + 20
+    if frac_part.zero? && y.exponent < Math.log(result_prec) * 5 + 20
       # Use exponentiation by squaring if y is an integer and not too large
       pow_prec = prec2 + y.exponent
       n = 1
@@ -191,16 +192,16 @@ class BigDecimal
         break if n > int_part
         xn = xn.mult(xn, pow_prec)
       end
-      ans.mult(1, prec)
+      ans.mult(1, result_prec)
     else
-      if x > 1
+      if x > 1 && x.finite?
         # To calculate exp(z, prec), z needs prec+max(z.exponent, 0) precision if z > 0.
         # Estimate (y*log(x)).exponent
         logx_exponent = x < 2 ? (x - 1).exponent : Math.log10(x.exponent).round
         ylogx_exponent = y.exponent + logx_exponent
         prec2 += [ylogx_exponent, 0].max
       end
-      BigMath.exp(BigMath.log(x, prec2).mult(y, prec2), prec)
+      BigMath.exp(BigMath.log(x, prec2).mult(y, prec2), result_prec)
     end
   end
 
@@ -217,7 +218,9 @@ class BigDecimal
     return self if zero?
 
     if prec == 0
-      prec = BigDecimal.limit.nonzero? || n_significant_digits + BigDecimal.double_fig
+      limit = BigDecimal.limit
+      prec = n_significant_digits + BigDecimal.double_fig
+      prec = [limit, prec].min if limit.nonzero?
     end
 
     ex = exponent / 2
@@ -235,6 +238,7 @@ end
 # Core BigMath methods for BigDecimal (log, exp) are defined here.
 # Other methods (sin, cos, atan) are defined in 'bigdecimal/math.rb'.
 module BigMath
+  module_function
 
   # call-seq:
   #   BigMath.log(decimal, numeric)    -> BigDecimal
@@ -248,7 +252,7 @@ module BigMath
   #
   # If +decimal+ is NaN, returns NaN.
   #
-  def self.log(x, prec)
+  def log(x, prec)
     prec = BigDecimal::Internal.coerce_validate_prec(prec, :log)
     raise Math::DomainError, 'Complex argument for BigMath.log' if Complex === x
 
@@ -303,7 +307,7 @@ module BigMath
   end
 
   # Taylor series for exp(x) around 0
-  private_class_method def self._exp_taylor(x, prec) # :nodoc:
+  private_class_method def _exp_taylor(x, prec) # :nodoc:
     xn = BigDecimal(1)
     y = BigDecimal(1)
     1.step do |i|
@@ -325,7 +329,7 @@ module BigMath
   #
   # If +decimal+ is NaN, returns NaN.
   #
-  def self.exp(x, prec)
+  def exp(x, prec)
     prec = BigDecimal::Internal.coerce_validate_prec(prec, :exp)
     x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :exp)
     return BigDecimal::Internal.nan_computation_result if x.nan?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigdecimal
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Kenta Murata
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Arbitrary-precision decimal floating-point number library.
 test_files: []