bigdecimal 3.2.3-java → 3.3.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72ea230b182767a2c32bc9dafe2cb3b39165960ca8683b5afaab7dd9cfcae7fb
-  data.tar.gz: f34cbd33b43a2ca0441d1f9b070fee1d27dc3ad9bba3e0df1f6774d688d18b68
+  metadata.gz: 7b3e1def7d1cfc2c72b5aa0a460ef768973e6c704a1225663e8df144718ac23a
+  data.tar.gz: 41e414cf6a1348e4567ce0b06928abb2c757a3a4f5de05ebcb1d78ff54140afe
 SHA512:
-  metadata.gz: 55cb0f29873b8685d9cfeb14627fe9ecfed5e735a08cd82730da1d736d83b0f630f48e4ee0df164ba799ac0e54dbfbea629712b131d5e9355d07b4ed755edabb
-  data.tar.gz: 8d0ac09e425579924920109a14290858b03bc70cd66ec3acae334593df0b786e922220a683f20bf2bd35900d1e5ebca1aa9cd3ed0463b20edc34ec3fbce2f01c
+  metadata.gz: c5880f8f1e8ed360116110107cf448894118a6714ecc916b3be74c056dab9e258b82620db42ace5a4b0b5833445859403e401fd2ba3a6c7d5aecaea1068986da
+  data.tar.gz: 33d209590eaa3132f31495884df9a5f08eae7382d349df1977c03b69d6e48c3a3bab0dee6fc5c99ead0690e5dee4f74364976d99381290b7c71f0ab4e93d7f07

data/lib/bigdecimal/math.rb

@@ -7,6 +7,7 @@ require 'bigdecimal'
 #   sqrt(x, prec)
 #   sin (x, prec)
 #   cos (x, prec)
+#   tan (x, prec)
 #   atan(x, prec)
 #   PI  (prec)
 #   E   (prec) == exp(1.0,prec)
@@ -24,8 +25,8 @@ require 'bigdecimal'
 #
 #   include BigMath
 #
-#   a = BigDecimal((PI(100)/2).to_s)
-#   puts sin(a,100) # => 0.99999999999999999999......e0
+#   a = BigDecimal((PI(49)/2).to_s)
+#   puts sin(a,100) # => 0.9999999999...9999999986e0
 #
 module BigMath
   module_function
@@ -36,13 +37,42 @@ module BigMath
   # Computes the square root of +decimal+ to the specified number of digits of
   # precision, +numeric+.
   #
-  #   BigMath.sqrt(BigDecimal('2'), 16).to_s
-  #   #=> "0.1414213562373095048801688724e1"
+  #   BigMath.sqrt(BigDecimal('2'), 32).to_s
+  #   #=> "0.14142135623730950488016887242097e1"
   #
   def sqrt(x, prec)
+    BigDecimal::Internal.validate_prec(prec, :sqrt)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :sqrt)
     x.sqrt(prec)
   end
 
+
+  # Returns [sign, reduced_x] where reduced_x is in -pi/2..pi/2
+  # and satisfies sin(x) = sign * sin(reduced_x)
+  # If add_half_pi is true, adds pi/2 to x before reduction.
+  # Precision of pi is adjusted to ensure reduced_x has the required precision.
+  private_class_method def _sin_periodic_reduction(x, prec, add_half_pi: false) # :nodoc:
+    return [1, x] if -Math::PI/2 <= x && x <= Math::PI/2 && !add_half_pi
+
+    mod_prec = prec + BigDecimal.double_fig
+    pi_extra_prec = [x.exponent, 0].max + BigDecimal.double_fig
+    while true
+      pi = PI(mod_prec + pi_extra_prec)
+      half_pi = pi / 2
+      div, mod = (add_half_pi ? x + pi : x + half_pi).divmod(pi)
+      mod -= half_pi
+      if mod.zero? || mod_prec + mod.exponent <= 0
+        # mod is too small to estimate required pi precision
+        mod_prec = mod_prec * 3 / 2 + BigDecimal.double_fig
+      elsif mod_prec + mod.exponent < prec
+        # Estimate required precision of pi
+        mod_prec = prec - mod.exponent + BigDecimal.double_fig
+      else
+        return [div % 2 == 0 ? 1 : -1, mod.mult(1, prec)]
+      end
+    end
+  end
+
   # call-seq:
   #   sin(decimal, numeric) -> BigDecimal
   #
@@ -51,42 +81,33 @@ module BigMath
   #
   # If +decimal+ is Infinity or NaN, returns NaN.
   #
-  #   BigMath.sin(BigMath.PI(5)/4, 5).to_s
-  #   #=> "0.70710678118654752440082036563292800375e0"
+  #   BigMath.sin(BigMath.PI(5)/4, 32).to_s
+  #   #=> "0.70710807985947359435812921837984e0"
   #
   def sin(x, prec)
-    raise ArgumentError, "Zero or negative precision for sin" if prec <= 0
-    return BigDecimal("NaN") if x.infinite? || x.nan?
+    BigDecimal::Internal.validate_prec(prec, :sin)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :sin)
+    return BigDecimal::Internal.nan_computation_result if x.infinite? || x.nan?
     n    = prec + BigDecimal.double_fig
     one  = BigDecimal("1")
     two  = BigDecimal("2")
-    x = -x if neg = x < 0
-    if x > 6
-      twopi = two * BigMath.PI(prec + x.exponent)
-      if x > 30
-        x %= twopi
-      else
-        x -= twopi while x > twopi
-      end
-    end
+    sign, x = _sin_periodic_reduction(x, n)
     x1   = x
     x2   = x.mult(x,n)
-    sign = 1
     y    = x
     d    = y
     i    = one
     z    = one
     while d.nonzero? && ((m = n - (y.exponent - d.exponent).abs) > 0)
       m = BigDecimal.double_fig if m < BigDecimal.double_fig
-      sign = -sign
-      x1  = x2.mult(x1,n)
+      x1  = -x2.mult(x1,n)
       i  += two
       z  *= (i-one) * i
-      d   = sign * x1.div(z,m)
+      d   = x1.div(z,m)
       y  += d
     end
     y = BigDecimal("1") if y > 1
-    neg ? -y : y
+    y.mult(sign, prec)
   end
 
   # call-seq:
@@ -97,41 +118,34 @@ module BigMath
   #
   # If +decimal+ is Infinity or NaN, returns NaN.
   #
-  #   BigMath.cos(BigMath.PI(4), 16).to_s
-  #   #=> "-0.999999999999999999999999999999856613163740061349e0"
+  #   BigMath.cos(BigMath.PI(16), 32).to_s
+  #   #=> "-0.99999999999999999999999999999997e0"
   #
   def cos(x, prec)
-    raise ArgumentError, "Zero or negative precision for cos" if prec <= 0
-    return BigDecimal("NaN") if x.infinite? || x.nan?
-    n    = prec + BigDecimal.double_fig
-    one  = BigDecimal("1")
-    two  = BigDecimal("2")
-    x = -x if x < 0
-    if x > 6
-      twopi = two * BigMath.PI(prec + x.exponent)
-      if x > 30
-        x %= twopi
-      else
-        x -= twopi while x > twopi
-      end
-    end
-    x1 = one
-    x2 = x.mult(x,n)
-    sign = 1
-    y = one
-    d = y
-    i = BigDecimal("0")
-    z = one
-    while d.nonzero? && ((m = n - (y.exponent - d.exponent).abs) > 0)
-      m = BigDecimal.double_fig if m < BigDecimal.double_fig
-      sign = -sign
-      x1  = x2.mult(x1,n)
-      i  += two
-      z  *= (i-one) * i
-      d   = sign * x1.div(z,m)
-      y  += d
-    end
-    y < -1 ? BigDecimal("-1") : y > 1 ? BigDecimal("1") : y
+    BigDecimal::Internal.validate_prec(prec, :cos)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :cos)
+    return BigDecimal::Internal.nan_computation_result if x.infinite? || x.nan?
+    sign, x = _sin_periodic_reduction(x, prec + BigDecimal.double_fig, add_half_pi: true)
+    sign * sin(x, prec)
+  end
+
+  # call-seq:
+  #   tan(decimal, numeric) -> BigDecimal
+  #
+  # Computes the tangent of +decimal+ to the specified number of digits of
+  # precision, +numeric+.
+  #
+  # If +decimal+ is Infinity or NaN, returns NaN.
+  #
+  #   BigMath.tan(BigDecimal("0.0"), 4).to_s
+  #   #=> "0.0"
+  #
+  #   BigMath.tan(BigMath.PI(24) / 4, 32).to_s
+  #   #=> "0.99999999999999999999999830836025e0"
+  #
+  def tan(x, prec)
+    BigDecimal::Internal.validate_prec(prec, :tan)
+    sin(x, prec + BigDecimal.double_fig).div(cos(x, prec + BigDecimal.double_fig), prec)
   end
 
   # call-seq:
@@ -142,17 +156,18 @@ module BigMath
   #
   # If +decimal+ is NaN, returns NaN.
   #
-  #   BigMath.atan(BigDecimal('-1'), 16).to_s
-  #   #=> "-0.785398163397448309615660845819878471907514682065e0"
+  #   BigMath.atan(BigDecimal('-1'), 32).to_s
+  #   #=> "-0.78539816339744830961566084581988e0"
   #
   def atan(x, prec)
-    raise ArgumentError, "Zero or negative precision for atan" if prec <= 0
-    return BigDecimal("NaN") if x.nan?
-    pi = PI(prec)
+    BigDecimal::Internal.validate_prec(prec, :atan)
+    x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :atan)
+    return BigDecimal::Internal.nan_computation_result if x.nan?
+    n = prec + BigDecimal.double_fig
+    pi = PI(n)
     x = -x if neg = x < 0
     return pi.div(neg ? -2 : 2, prec) if x.infinite?
-    return pi / (neg ? -4 : 4) if x.round(prec) == 1
-    n = prec + BigDecimal.double_fig
+    return pi.div(neg ? -4 : 4, prec) if x.round(prec) == 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
@@ -170,7 +185,7 @@ module BigMath
     y *= 2 if dbl
     y = pi / 2 - y if inv
     y = -y if neg
-    y
+    y.mult(1, prec)
   end
 
   # call-seq:
@@ -179,11 +194,11 @@ module BigMath
   # Computes the value of pi to the specified number of digits of precision,
   # +numeric+.
   #
-  #   BigMath.PI(10).to_s
-  #   #=> "0.3141592653589793238462643388813853786957412e1"
+  #   BigMath.PI(32).to_s
+  #   #=> "0.31415926535897932384626433832795e1"
   #
   def PI(prec)
-    raise ArgumentError, "Zero or negative precision for PI" if prec <= 0
+    BigDecimal::Internal.validate_prec(prec, :PI)
     n      = prec + BigDecimal.double_fig
     zero   = BigDecimal("0")
     one    = BigDecimal("1")
@@ -215,7 +230,7 @@ module BigMath
       pi  = pi + d
       k   = k+two
     end
-    pi
+    pi.mult(1, prec)
   end
 
   # call-seq:
@@ -224,11 +239,11 @@ module BigMath
   # Computes e (the base of natural logarithms) to the specified number of
   # digits of precision, +numeric+.
   #
-  #   BigMath.E(10).to_s
-  #   #=> "0.271828182845904523536028752390026306410273e1"
+  #   BigMath.E(32).to_s
+  #   #=> "0.27182818284590452353602874713527e1"
   #
   def E(prec)
-    raise ArgumentError, "Zero or negative precision for E" if prec <= 0
+    BigDecimal::Internal.validate_prec(prec, :E)
     BigMath.exp(1, prec)
   end
 end

data/lib/bigdecimal/util.rb

@@ -119,8 +119,11 @@ class Rational < Numeric
   #
   # Returns the value as a BigDecimal.
   #
-  # The required +precision+ parameter is used to determine the number of
-  # significant digits for the result.
+  # The +precision+ parameter is used to determine the number of
+  # significant digits for the result. When +precision+ is set to +0+,
+  # the number of digits to represent the float being converted is determined
+  # automatically.
+  # The default +precision+ is +0+.
   #
   #     require 'bigdecimal'
   #     require 'bigdecimal/util'
@@ -129,7 +132,7 @@ class Rational < Numeric
   #
   # See also Kernel.BigDecimal.
   #
-  def to_d(precision)
+  def to_d(precision=0)
     BigDecimal(self, precision)
   end
 end
@@ -141,29 +144,27 @@ class Complex < Numeric
   #     cmp.to_d(precision)  -> bigdecimal
   #
   # Returns the value as a BigDecimal.
+  # If the imaginary part is not +0+, an error is raised
   #
-  # The +precision+ parameter is required for a rational complex number.
-  # This parameter is used to determine the number of significant digits
-  # for the result.
+  # The +precision+ parameter is used to determine the number of
+  # significant digits for the result. When +precision+ is set to +0+,
+  # the number of digits to represent the float being converted is determined
+  # automatically.
+  # The default +precision+ is +0+.
   #
   #     require 'bigdecimal'
   #     require 'bigdecimal/util'
   #
   #     Complex(0.1234567, 0).to_d(4)   # => 0.1235e0
   #     Complex(Rational(22, 7), 0).to_d(3)   # => 0.314e1
+  #     Complex(1, 1).to_d   # raises ArgumentError
   #
   # See also Kernel.BigDecimal.
   #
-  def to_d(*args)
+  def to_d(precision=0)
     BigDecimal(self) unless self.imag.zero? # to raise error
 
-    if args.length == 0
-      case self.real
-      when Rational
-        BigDecimal(self.real) # to raise error
-      end
-    end
-    self.real.to_d(*args)
+    BigDecimal(self.real, precision)
   end
 end
 

data/lib/bigdecimal.rb

@@ -1,6 +1,11 @@
 if RUBY_ENGINE == 'jruby'
   JRuby::Util.load_ext("org.jruby.ext.bigdecimal.BigDecimalLibrary")
-  return
+
+  class BigDecimal
+    def _decimal_shift(i) # :nodoc:
+      to_java.move_point_right(i).to_d
+    end
+  end
 else
   require 'bigdecimal.so'
 end
@@ -15,7 +20,7 @@ class BigDecimal
       when BigDecimal
         return x
       when Integer, Float
-        return BigDecimal(x)
+        return BigDecimal(x, 0)
       when Rational
         return BigDecimal(x, [prec, 2 * BigDecimal.double_fig].max)
       end
@@ -160,22 +165,32 @@ class BigDecimal
       return BigDecimal(1).div(inv, prec)
     end
 
-    int_part = y.fix.to_i
     prec2 = prec + BigDecimal.double_fig
-    pow_prec = prec2 + (int_part > 0 ? y.exponent : 0)
-    ans = BigDecimal(1)
-    n = 1
-    xn = x
-    while true
-      ans = ans.mult(xn, pow_prec) if int_part.allbits?(n)
-      n <<= 1
-      break if n > int_part
-      xn = xn.mult(xn, pow_prec)
-    end
-    unless frac_part.zero?
-      ans = ans.mult(BigMath.exp(BigMath.log(x, prec2).mult(frac_part, prec2), prec2), prec2)
+
+    if frac_part.zero? && y.exponent < Math.log(prec) * 5 + 20
+      # Use exponentiation by squaring if y is an integer and not too large
+      pow_prec = prec2 + y.exponent
+      n = 1
+      xn = x
+      ans = BigDecimal(1)
+      int_part = y.fix.to_i
+      while true
+        ans = ans.mult(xn, pow_prec) if int_part.allbits?(n)
+        n <<= 1
+        break if n > int_part
+        xn = xn.mult(xn, pow_prec)
+      end
+      ans.mult(1, prec)
+    else
+      if x > 1
+        # 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)
     end
-    ans.mult(1, prec)
   end
 
   # Returns the square root of the value.
@@ -190,23 +205,19 @@ class BigDecimal
     raise FloatDomainError, "sqrt of 'NaN'(Not a Number)" if nan?
     return self if zero?
 
-    limit = BigDecimal.limit.nonzero? if prec == 0
-
-    # BigDecimal#sqrt calculates at least n_significant_digits precision.
-    # This feature maybe problematic for some cases.
-    n_digits = n_significant_digits
-    prec = [prec, n_digits].max
+    if prec == 0
+      prec = BigDecimal.limit.nonzero? || n_significant_digits + BigDecimal.double_fig
+    end
 
     ex = exponent / 2
     x = _decimal_shift(-2 * ex)
-    y = BigDecimal(Math.sqrt(x.to_f))
+    y = BigDecimal(Math.sqrt(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 = y.add(x.div(y, p), p).div(2, p)
     end
-    y = y.mult(1, limit) if limit
-    y._decimal_shift(ex)
+    y._decimal_shift(ex).mult(1, prec)
   end
 end
 
@@ -232,56 +243,67 @@ module BigMath
 
     x = BigDecimal::Internal.coerce_to_bigdecimal(x, prec, :log)
     return BigDecimal::Internal.nan_computation_result if x.nan?
-    raise Math::DomainError, 'Zero or negative argument for log' if x <= 0
+    raise Math::DomainError, 'Negative argument for log' if x < 0
+    return -BigDecimal::Internal.infinity_computation_result if x.zero?
     return BigDecimal::Internal.infinity_computation_result if x.infinite?
     return BigDecimal(0) if x == 1
 
+    prec2 = prec + BigDecimal.double_fig
     BigDecimal.save_limit do
       BigDecimal.limit(0)
       if x > 10 || x < 0.1
-        log10 = log(BigDecimal(10), prec)
+        log10 = log(BigDecimal(10), prec2)
         exponent = x.exponent
         x = x._decimal_shift(-exponent)
         if x < 0.3
           x *= 10
           exponent -= 1
         end
-        return log10 * exponent + log(x, prec)
+        return (log10 * exponent).add(log(x, prec2), prec)
       end
 
       x_minus_one_exponent = (x - 1).exponent
-      prec += BigDecimal.double_fig
 
       # log(x) = log(sqrt(sqrt(sqrt(sqrt(x))))) * 2**sqrt_steps
-      sqrt_steps = [Integer.sqrt(prec) + 3 * x_minus_one_exponent, 0].max
+      sqrt_steps = [Integer.sqrt(prec2) + 3 * x_minus_one_exponent, 0].max
 
       lg2 = 0.3010299956639812
-      prec2 = prec + [-x_minus_one_exponent, 0].max + (sqrt_steps * lg2).ceil
+      sqrt_prec = prec2 + [-x_minus_one_exponent, 0].max + (sqrt_steps * lg2).ceil
 
       sqrt_steps.times do
-        x = x.sqrt(prec2)
-
-        # Workaround for https://github.com/ruby/bigdecimal/issues/354
-        x = x.mult(1, prec2 + BigDecimal.double_fig)
+        x = x.sqrt(sqrt_prec)
       end
 
       # Taylor series for log(x) around 1
       # log(x) = -log((1 + X) / (1 - X)) where X = (x - 1) / (x + 1)
       # log(x) = 2 * (X + X**3 / 3 + X**5 / 5 + X**7 / 7 + ...)
-      x = (x - 1).div(x + 1, prec2)
+      x = (x - 1).div(x + 1, sqrt_prec)
       y = x
-      x2 = x.mult(x, prec)
+      x2 = x.mult(x, prec2)
       1.step do |i|
-        n = prec + x.exponent - y.exponent + x2.exponent
+        n = prec2 + x.exponent - y.exponent + x2.exponent
         break if n <= 0 || x.zero?
         x = x.mult(x2.round(n - x2.exponent), n)
-        y = y.add(x.div(2 * i + 1, n), prec)
+        y = y.add(x.div(2 * i + 1, n), prec2)
       end
 
       y.mult(2 ** (sqrt_steps + 1), prec)
     end
   end
 
+  # Taylor series for exp(x) around 0
+  private_class_method def self._exp_taylor(x, prec) # :nodoc:
+    xn = BigDecimal(1)
+    y = BigDecimal(1)
+    1.step do |i|
+      n = prec + xn.exponent
+      break if n <= 0 || xn.zero?
+      xn = xn.mult(x, n).div(i, n)
+      y = y.add(xn, prec)
+    end
+    y
+  end
+
   # call-seq:
   #   BigMath.exp(decimal, numeric)    -> BigDecimal
   #
@@ -298,23 +320,17 @@ module BigMath
     return BigDecimal::Internal.nan_computation_result if x.nan?
     return x.positive? ? BigDecimal::Internal.infinity_computation_result : BigDecimal(0) if x.infinite?
     return BigDecimal(1) if x.zero?
-    return BigDecimal(1).div(exp(-x, prec), prec) if x < 0
 
     # exp(x * 10**cnt) = exp(x)**(10**cnt)
-    cnt = x > 1 ? x.exponent : 0
+    cnt = x < -1 || x > 1 ? x.exponent : 0
     prec2 = prec + BigDecimal.double_fig + cnt
     x = x._decimal_shift(-cnt)
-    xn = BigDecimal(1)
-    y = BigDecimal(1)
 
-    # Taylor series for exp(x) around 0
-    1.step do |i|
-      n = prec2 + xn.exponent
-      break if n <= 0 || xn.zero?
-      x = x.mult(1, n)
-      xn = xn.mult(x, n).div(i, n)
-      y = y.add(xn, prec2)
-    end
+    # Calculation of exp(small_prec) is fast because calculation of x**n is fast
+    # Calculation of exp(small_abs) converges fast.
+    # exp(x) = exp(small_prec_part + small_abs_part) = exp(small_prec_part) * exp(small_abs_part)
+    x_small_prec = x.round(Integer.sqrt(prec2))
+    y = _exp_taylor(x_small_prec, prec2).mult(_exp_taylor(x.sub(x_small_prec, prec2), prec2), prec2)
 
     # calculate exp(x * 10**cnt) from exp(x)
     # exp(x * 10**k) = exp(x * 10**(k - 1)) ** 10

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigdecimal
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.3.0
 platform: java
 authors:
 - Kenta Murata
@@ -9,7 +9,7 @@ authors:
 - Shigeo Kobayashi
 bindir: bin
 cert_chain: []
-date: 2025-09-03 00:00:00.000000000 Z
+date: 2025-10-07 00:00:00.000000000 Z
 dependencies: []
 description: This library provides arbitrary-precision decimal floating-point number
   class.