flt 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d83917f212ce371cb0539547a00b167a49ad62ba
-  data.tar.gz: e8d5884693b1d3bdcfd44ef3e2e2bf4dd864fc8a
+  metadata.gz: d25ad2ad4f96968dfa38899ca80fbc6c42f2693e
+  data.tar.gz: 1dcceec01b59a5601054eaa5acc6ec6974bd5c75
 SHA512:
-  metadata.gz: 726acb0972354c41401c11a05882a77b4897f26c69e9e8ae52ae5b970008a0a10d6dcdb193c289fc1fa6f618db232b5052ba1204ed8c61b314b87892d128646a
-  data.tar.gz: f4757df03b50b6b64692b0cf93009954c13091f780dbc87a7b8886751369f5a83b1a69673098c95529e5b1bdfef049c659d92589316fd23ff58054e0ba54c24c
+  metadata.gz: e997aa12648c1c49d0e56dadb521d338e55c6fcd2082a4e9d46a7c103688950190ecb95bc36b285d4d1d5cfb6d348e7092dec5183d0c13476112b01390475d22
+  data.tar.gz: 28173c3cbd4fb78f986251ddfa7c8528dce13fb8b90e3069822c11a3c35902521c4b8b0eda68bf32d18b3c67c56abc86b2212b7b1b258d86d1e9782b31f5e649

data/History.txt

@@ -1,3 +1,7 @@
+== 1.4.2 2014-10-30
+
+  Change definition of numbers in :free mode with no change of base involved.
+
 == 1.4.1 2014-10-29
 
   Minor correction to allow partially requiring some files

data/lib/flt/dec_num.rb

@@ -104,7 +104,7 @@ class DecNum < Num
   #   DecNum('0.1000')                                  # -> 0.1000
   #   DecNum('0.12345')                                 # -> 0.12345
   #   DecNum('1.2345E-1')                               # -> 0.12345
-  #   DecNum('0.1000', :short)                          # -> 0.1000
+  #   DecNum('0.1000', :short)                          # -> 0.1
   #   DecNum('0.1000',:fixed, :precision=>20)           # -> 0.10000000000000000000
   #   DecNum('0.12345',:fixed, :precision=>20)          # -> 0.12345000000000000000
   #   DecNum('0.100110E3', :base=>2)                    # -> 4.8

data/lib/flt/num.rb

@@ -1,6 +1,37 @@
 # Base classes for floating-point numbers and contexts.
 
 #--
+# TODO: selecting the kind of ulp is awkward; consider one of these options:
+#       * don't support variant ulps; always use Muller's ulp
+#       * use an options hash for the kind of ulp parameter
+#       * keep the kind of ulp in the context
+#       also, note that Tolerance uses only the Muller king of ulp.
+# TODO: move the exception classes from Flt::Num to Flt ? move also Flt::Num::ContextBas to Flt ?
+# TODO: find better name for :all_digits (:preserve_precision, :mantain_precision, ...) ?
+# TODO: should the context determine the mode for cross-base literal-to-Num conversion (:free, :fixed)?
+#           BinNum.context.input = :fixed; x = BinNum('0.1')
+#++
+
+require 'flt/support'
+require 'flt/support/flag_values'
+require 'flt/support/reader'
+require 'flt/support/formatter'
+require 'flt/support/rationalizer'
+
+require 'bigdecimal'
+require 'forwardable'
+require 'rational'
+require 'monitor'
+require 'ostruct'
+
+module Flt
+
+# Generic radix arbitrary-precision, floating-point numbers. This is a base class for
+# floating point types of specific radix.
+#
+# The implementation of floating-point arithmetic is largely based on the Decimal module of Python,
+# written by Eric Price, Facundo Batista, Raymond Hettinger, Aahz and Tim Peters.
+#
 # =Notes on the representation of Flt::Num numbers.
 #
 # * @sign is +1 for plus and -1 for minus
@@ -8,7 +39,7 @@
 # * @exp is the exponent to be applied to @coeff as an integer or one of :inf, :nan, :snan for special values
 #
 # The value represented is @sign*@coeff*b**@exp with b = num_class.radix the radix for the the Num-derived class.
-
+#
 # The original Python Decimal representation has these slots:
 # * _sign is 1 for minus, 0 for plus
 # * _int is the integral significand as a string of digits (leading zeroes are not kept)
@@ -111,39 +142,7 @@
 #
 # The known or 'coercible' types for DecNum are initially Integer and Rational, but this can be extended to
 # other types using define_conversion_from() in a Context object.
-#++
-
-#--
-# TODO: selecting the kind of ulp is awkward; consider one of these options:
-#       * don't support variant ulps; always use Muller's ulp
-#       * use an options hash for the kind of ulp parameter
-#       * keep the kind of ulp in the context
-#       also, note that Tolerance uses only the Muller king of ulp.
-# TODO: move the exception classes from Flt::Num to Flt ? move also Flt::Num::ContextBas to Flt ?
-# TODO: find better name for :all_digits (:preserve_precision, :mantain_precision, ...) ?
-# TODO: should the context determine the mode for cross-base literal-to-Num conversion (:free, :fixed)?
-#           BinNum.context.input = :fixed; x = BinNum('0.1')
-#++
-
-require 'flt/support'
-require 'flt/support/flag_values'
-require 'flt/support/reader'
-require 'flt/support/formatter'
-require 'flt/support/rationalizer'
-
-require 'bigdecimal'
-require 'forwardable'
-require 'rational'
-require 'monitor'
-require 'ostruct'
-
-module Flt
-
-# Generic radix arbitrary-precision, floating-point numbers. This is a base class for
-# floating point types of specific radix.
 #
-# The implementation of floating-point arithmetic is largely based on the Decimal module of Python,
-# written by Eric Price, Facundo Batista, Raymond Hettinger, Aahz and Tim Peters.
 class Num < Numeric
 
   extend Support # allows use of unqualified FlagValues(), Flags(), etc.
@@ -1446,7 +1445,13 @@ class Num < Numeric
   #   meaning here that if the digit is changed and the value converted back to a literal of the same base and
   #   precision, the original literal will not be obtained.
   # * :short is a variation of :free in which only the minimun number of digits that are necessary to
-  #   produce the original literal when the value is converted back with the same original precision.
+  #   produce the original literal when the value is converted back with the same original precision;
+  #   namely, given an input in base b1, its :short representation in base 2 is the shortest number in base b2
+  #   such that when converted back to base b2 with the same precision that the input had, the result is identical
+  #   to the input:
+  #     short = Num[b2].new(input, :short, base: b1)
+  #     Num[b1].context.precision = precision_of_inpu
+  #     Num[b1].new(short.to_s(base: b2), :fixed, base: b2)) == Num[b1].new(input, :free, base: b1)
   # * :fixed will round and normalize the value to the precision specified by the context (normalize meaning
   #   that exaclty the number of digits specified by the precision will be generated, even if the original
   #   literal has fewer digits.) This may fail returning NaN (and raising Inexact) if the context precision is
@@ -1544,8 +1549,23 @@ class Num < Numeric
             mode ||= :free
           end
 
-          if [:free, :short].include?(mode) && base == num_class.radix
+          if mode == :free && base == num_class.radix
             # simple case, the job is already done
+            #
+            # :free mode with same base must not be handled by the Reader;
+            # note that if we used the Reader for the same base case in :free mode,
+            # an extra 'significative' digit would be added, because that digit
+            # is significative in the sense that (under non-directed rounding,
+            # and with the significance interpretation of Reader wit the all-digits option)
+            # it's not free to take any value without affecting the value of
+            # the other digits: e.g. input: '0.1', the result of :free
+            # conversion with the Reader is '0.10' because de last digit is not free;
+            # if it was 9 for example the actual value would round to '0.2' with the input
+            # precision given here.
+            #
+            # On the other hand, :short, should be handled by the Reader even when
+            # the input and output bases are the same because we want to find the shortest
+            # number that can be converted back to the input with the same input precision.
           else
             rounding = context.rounding
             reader = Support::Reader.new(:mode=>mode)

data/lib/flt/support/rationalizer_extra.rb

@@ -1,9 +1,9 @@
-# Some rationalization algorithms currently not being used
-
 module Flt
   module Support
 
     class Rationalizer
+      # Some rationalization algorithms currently not being used
+
 
       # Simple Rationalization by Joe Horn
       def rationalize_Horn_simple(x, smallest_denominator = false)

data/lib/flt/version.rb

@@ -1,3 +1,3 @@
 module Flt
-  VERSION = "1.4.1"
+  VERSION = "1.4.2"
 end

data/test/test_num_constructor.rb

@@ -41,13 +41,13 @@ class TestNumConstructor < Test::Unit::TestCase
     assert_equal [1, 1, -1], DecNum('0.1', :free).split
     assert_equal [1, 1000, -4], DecNum('0.1000', :free).split
     assert_equal [1, 1, -1],  DecNum('0.1',:short).split
-    assert_equal [1, 1000, -4], DecNum('0.1000',:short).split
+    assert_equal [1, 1, -1], DecNum('0.1000',:short).split
 
     assert_equal [1, 1, -3], BinNum('0.1E-2', :free, :base=>2).split
     assert_equal [1, 1, -1], BinNum('0.1', :free, :base=>2).split
     assert_equal [1, 8, -4], BinNum('0.1000', :free, :base=>2).split
     assert_equal [1, 1, -1], BinNum('0.1',:short, :base=>2).split
-    assert_equal [1, 8, -4], BinNum('0.1000',:short, :base=>2).split
+    assert_equal [1, 1, -1], BinNum('0.1000',:short, :base=>2).split
   end
 
   def test_literal_free_base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flt
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Javier Goizueta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler