ruby-decimal 0.2.1 → 0.2.2

data/History.txt

@@ -7,7 +7,7 @@
 * New functions implemented:
   exp(), ln(), log10(), power().
 
-
+== 0.2.1 2009-06-23
 
 * Bug fixes:
   - Decimal#inspect was always producing debug information; now it uses $DEBUG
@@ -22,3 +22,10 @@
   - setting context exponent limits with elimit
   - require decimal/shortcut to use D for Decimal
 
+== 0.2.2 2009-07-21
+
+* Bug fixes:
+  - Decimal#normal? was incorrect for special values and zero.
+  - After a local context, the global context was set to a copy of the original
+    context, so any previously stored reference to it was now unbound.
+  - Context#normalize was incorrect.

data/README.txt

@@ -120,6 +120,14 @@ Decimal::ExtendedContext in the following examples:
 
   Decimal.context = Decimal::ExtendedContext
 
+Most decimal operations can be executed by using either Context or Decimal methods:
+
+  puts Decimal.context.exp(1)                        -> 2.71828183
+  puts Decimal(1).exp                                -> 2.71828183
+
+If using Context methods, values are automatically converted as if the Decimal() constructor
+was used.
+
 ==Rounding
 
 Results are normally rounded using the precision (number of significant digits)
@@ -241,14 +249,22 @@ Or with a generic method:
   puts Decimal('1.1').convert_to(Integer)            -> 1
   puts Decimal('1.1').convert_to(Rational)           -> 11/10
 
-Conversion is also possible to Float:
+Thera are also GDAS style conversion operations:
+
+    puts Decimal('1.1').to_integral_value              -> 1
+
+And conversion is also possible to Float:
   puts Decimal('1.1').to_f                           -> 1.1
   puts Decimal('1.1').convert_to(Float)              -> 1.1
   puts Float(Decimal('1.1'))                         -> 1.1
 
-And with GDAS style operations:
+Types with predefined bidirectional conversion (Integer and Rational)
+can be operated with Decimal on either side of an operator, and the result will be a Decimal.
+For Float there is no predefined bidirectional conversion (see below how to define it)
+and the result of an operation between Decimal and Float will be of type Float.
 
-  puts Decimal('1.1').to_integral_value              -> 1
+  puts (Decimal(1.1) + 2.0).class                    -> Float
+  puts (2.0 + Decimal(1.1)).class                    -> Float
 
 The conversion system is extensible. For example, we can include BigDecimal into it
 by defining suitable conversion procedures:

data/lib/decimal/decimal.rb

@@ -548,7 +548,7 @@ class Decimal
     # normalizes so that the coefficient has precision digits
     # (this is not the old GDA normalize function)
     def normalize(x)
-      _convert(x).reduce(self)
+      _convert(x).normalize(self)
     end
 
     # Adjusted exponent of x returned as a Decimal value.
@@ -799,20 +799,22 @@ class Decimal
     # of the particular rounding rules used.
     def strict_epsilon(sign=+1)
       return exception(InvalidOperation, "Exact context strict epsilon") if exact?
-      coeff = 1
-      exp   = 1-precision
       # assume radix is even (Decimal.radix%2 == 0)
       case rounding
       when :down, :floor
+        # largest epsilon: 0.0...10 (precision digits shown to the right of the decimal point)
         exp = 1-precision
         coeff = 1
       when :half_even, :half_down #, :up #  :up #     :down,    :half_down, :up05, :floor
+        # next largest:    0.0...050...1 (+precision-1 additional digits here)
         exp = 1-2*precision
         coeff = 1 + Decimal.int_radix_power(precision)/2
       when :half_up
+        # next largest:    0.0...05 (precision digits shown to the right of the decimal point)
         exp = 1-2*precision
         coeff = Decimal.int_radix_power(precision)/2
       when :up, :ceiling, :up05
+        # smallest epsilon
         return minimum_nonzero(sign)
       end
       return Decimal(sign, coeff, exp)
@@ -1004,16 +1006,20 @@ class Decimal
       local_context(*args, &blk)
     elsif args.empty?
       # return the current context
-      Thread.current['Decimal.context'] ||= DefaultContext.dup
+      self._context = DefaultContext.dup if _context.nil?
+      _context
     else
       # change the current context
+      # TODO: consider doing _context = ... here
+      # so we would have Decimal.context = c that assigns a duplicate of c
+      # and Decimal.context c to set alias c
       Decimal.context = define_context(*args)
     end
   end
 
   # Change the current context (thread-local).
   def Decimal.context=(c)
-    Thread.current['Decimal.context'] = c.dup
+    self._context = c.dup
   end
 
   # Defines a scope with a local context. A context can be passed which will be
@@ -1021,9 +1027,9 @@ class Decimal
   # options to apply to the local scope.
   # Changes done to the current context are reversed when the scope is exited.
   def Decimal.local_context(*args)
-    keep = context.dup
-    Decimal.context = define_context(*args)
-    result = yield Decimal.context
+    keep = Decimal.context # use this so _context is initialized if necessary
+    Decimal.context = define_context(*args) # this dups the assigned context
+    result = yield _context
     # TODO: consider the convenience of copying the flags from Decimal.context to keep
     # This way a local context does not affect the settings of the previous context,
     # but flags are transferred.
@@ -1031,10 +1037,21 @@ class Decimal
     #   keep.flags = Decimal.context.flags
     # Another alternative to consider: logically or the flags:
     #   keep.flags ||= Decimal.context.flags # (this requires implementing || in Flags)
-    Decimal.context = keep
+    self._context = keep
     result
   end
 
+  class <<self
+    # This is the thread-local context storage low level interface
+    protected
+    def _context #:nodoc:
+      Thread.current['Decimal.context']
+    end
+    def _context=(c) #:nodoc:
+      Thread.current['Decimal.context'] = c
+    end
+  end
+
   # A decimal number with value zero and the specified sign
   def Decimal.zero(sign=+1)
     Decimal.new([sign, 0, 0])
@@ -1301,7 +1318,7 @@ class Decimal
 
   # Returns whether the number is normal
   def normal?(context=nil)
-    return true if special? || zero?
+    return false if special? || zero?
     context = Decimal.define_context(context)
     (context.emin <= self.adjusted_exponent) &&  (self.adjusted_exponent <= context.emax)
   end
@@ -1334,6 +1351,8 @@ class Decimal
     case other
       when *Decimal.context.coercible_types_or_decimal
         [Decimal(other),self]
+      when Float
+        [other, self.to_f]
       else
         super
     end
@@ -2229,7 +2248,7 @@ class Decimal
         end
       end
     else
-      if defined? other.coerce
+      if !self.nan? && defined? other.coerce
         x, y = other.coerce(self)
         x <=> y
       else
@@ -2535,7 +2554,12 @@ class Decimal
       prec = adjusted_exponent + 1
       as_int = true
     end
-    result = plus(:rounding=>r, :precision=>prec)
+    dg = number_of_digits-prec
+    changed = _round(r, dg)
+    coeff = Decimal.int_div_radix_power(@coeff, dg)
+    exp = @exp + dg
+    coeff += 1 if changed==1
+    result = Decimal(@sign, coeff, exp)
     return as_int ? result.to_i : result
   end
 
@@ -3530,9 +3554,10 @@ class Decimal
     if ROUND_ARITHMETIC
       (@coeff % Decimal.int_radix_power(i))==0 ? 0 : -1
     else
+      return 0 if i==0
       d = @coeff.to_s
-      p = d.size - i
-      d[p..-1].match(/\A0+\Z/) ? 0 : -1
+      tail = d[-i..-1]
+      (tail.nil? || tail.match(/\A0*\Z/)) ? 0 : -1
     end
   end
 
@@ -3551,9 +3576,19 @@ class Decimal
         _round_half_up(i)
       end
     else
+      return 0 if i==0
       d = @coeff.to_s
       p = d.size - i
-      d[p..-1].match(/^5d*$/) ? -1 : _round_half_up(i)
+      rdig = d[p,1]
+      if '6789'.include?(rdig)
+        1
+      elsif '1234'.include?(rdig)
+        -1
+      elsif rdig=='5'
+        d[p+1..-1].match(/^0*$/) ? -1 : +1
+      else # rdig=='0'
+        d[p..-1].match(/^0*$/) ? 0 : -1
+      end
     end
 
   end
@@ -3568,6 +3603,7 @@ class Decimal
         (@coeff % m)==0 ? 0 : -1
       end
     else
+      return 0 if i==0
       d = @coeff.to_s
       p = d.size - i
       if '56789'.include?(d[p,1])
@@ -3589,6 +3625,7 @@ class Decimal
         _round_half_up(i)
       end
     else
+      return 0 if i==0
       d = @coeff.to_s
       p = d.size - i
 
@@ -3679,7 +3716,7 @@ class Decimal
     end
     # adj == -1, 0.1 <= self < 1
     return e + (10**-e - c).to_s.length - 1
- end
+  end
 
   module AuxiliarFunctions #:nodoc:
 

data/lib/decimal/version.rb

@@ -2,7 +2,7 @@ module DecimalSupport
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 2
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/test_define_conversions.rb

@@ -93,7 +93,7 @@ class TestDefineConversions < Test::Unit::TestCase
       assert_equal Decimal('7.1'), Decimal('7')+0.1
     end
     assert_equal Decimal('11'), Decimal(11.0)
-    assert Decimal(11.0).is_a?(Decimal)
+    assert_instance_of Decimal, Decimal(11.0)
 
     Decimal.context.define_conversion_from(Float) do |x, context|
       Decimal.context(context, :exact=>true) do
@@ -109,4 +109,33 @@ class TestDefineConversions < Test::Unit::TestCase
 
   end
 
+  def test_conversion_types
+
+    assert_instance_of Decimal, Decimal(1)+3
+    assert_instance_of Decimal, 3+Decimal(1)
+    assert_instance_of Decimal, Rational(1,5)+Decimal(1)
+    assert_instance_of Decimal, Decimal(1)+Rational(1,5)
+    assert_instance_of Float, Decimal(1)+3.0
+    assert_instance_of Float, 3.0+Decimal(1)
+
+    Decimal.context.define_conversion_from(Float) do |x, context|
+      s,e = Math.frexp(x)
+      significand = Math.ldexp(s, Float::MANT_DIG).to_i
+      exponent = e - Float::MANT_DIG
+      # the number is (as a Rational) significand * exponent**Float::RADIX
+      Decimal(significand*(Float::RADIX**exponent ))
+    end
+
+    assert_instance_of Decimal, Decimal(1)+3.0
+    assert_instance_of Decimal, 3.0+Decimal(1)
+
+    Decimal.context.define_conversion_from(BigDecimal) do |x, context|
+      Decimal(x.to_s) # or use x.split etc.
+    end
+
+    assert_instance_of Decimal, Decimal(1)+BigDecimal('3')
+    assert_instance_of Decimal, BigDecimal('3')+Decimal(1)
+
+  end
+
 end

data/test/test_round.rb

@@ -43,6 +43,11 @@ class TestRound < Test::Unit::TestCase
     assert_equal 100, Decimal('100.99999').truncate
     assert_equal(-100, Decimal('-100.99999').truncate)
 
+    assert_equal(10,  Decimal('9.99999').round(:rounding=>:half_up))
+    assert_equal(1,  Decimal('0.999999').round(:rounding=>:half_up))
+    assert_equal(0,  Decimal('0.0999999').round(:rounding=>:half_up))
+    assert_equal(1,  Decimal('0.0999999').round(:rounding=>:up))
+
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-decimal
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Javier Goizueta
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-23 00:00:00 +02:00
+date: 2009-07-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency