flt 1.3.0 → 1.3.1

data/lib/flt/float.rb

@@ -459,7 +459,7 @@ class Flt::FloatContext
   end
 
   def pi
-    Float::PI
+    Math::PI
   end
 
   def eval

data/lib/flt/num.rb

@@ -3,19 +3,21 @@
 #--
 # =Notes on the representation of Flt::Num numbers.
 #
-# @sign is +1 for plus and -1 for minus
-# @coeff is the integral significand stored as an integer (so leading zeros cannot be kept)
-# @exp is the exponent to be applied to @coeff as an integer or one of :inf, :nan, :snan for special values
+# * @sign is +1 for plus and -1 for minus
+# * @coeff is the integral significand stored as an integer (so leading zeros cannot be kept)
+# * @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)
-# _exp is the exponent as an integer or 'F' for infinity, 'n' for NaN , 'N' for sNaN
-# _is_especial is true for special values (infinity, NaN, sNaN)
+# * _sign is 1 for minus, 0 for plus
+# * _int is the integral significand as a string of digits (leading zeroes are not kept)
+# * _exp is the exponent as an integer or 'F' for infinity, 'n' for NaN , 'N' for sNaN
+# * _is_especial is true for special values (infinity, NaN, sNaN)
 # An additional class _WorkRep is used in Python for non-special decimal values with:
-# sign
-# int (significand as an integer)
-# exp
+# * sign
+# * int (significand as an integer)
+# * exp
 #
 # =Exponent values
 #
@@ -24,9 +26,15 @@
 #
 # The reduce operation (originally called 'normalize') removes trailing 0s and increments the exponent if necessary;
 # the representation is rescaled to use the maximum exponent possible (while maintaining an integral significand.)
+# So, a reduced number uses as few digits as possible to retain it's value; information about digit significance
+# is lost.
 #
-# A classical floating-point normalize opwration would remove leading 0s and decrement the exponent instead,
-# rescaling to the minimum exponent theat maintains the significand value under some conventional limit (1 or the radix).
+# A classical floating-point normalize operation would remove leading 0s and decrement the exponent instead,
+# rescaling to the minimum exponent that maintains the significand value under some conventional limit
+# (1 for fractional normalization; the radix for scientific or adjusted normalization and the maximum
+# integral significand with as many digits as determined by the context precision for integral normalization.)
+# So, normalization is meaningful given some fixed limited precision, as given by the context precision in our case.
+# Normalization uses all the available precision digits and loses information about digit significance too.
 #
 # The logb and adjusted operations return the exponent that applies to the most significand digit (logb as a Decimal
 # and adjusted as an integer.) This is the normalized scientific exponent.
@@ -40,15 +48,25 @@
 # The number of (kept) significand digits is s = a - e + 1
 # where a is the adjusted exponent and e is the internal exponent (the unnormalized integral exponent.)
 #
-# The number of significant digits (excluding leading and trailing zeroes) is sr = a - re + 1
+# The number of significant digits (excluding leading and trailing zeroes) is sr = a - re + 1 = s + e - re
 # where re is the internal exponent of the reduced value.
 #
-# The normalized integral exponent is e - (p - s) = a - p + 1
+# The normalized integral exponent is ei = e - (p - s) = a - p + 1
 # where p is the fixed precision.
 #
-# The normalized fractional exponent is e + s = a + 1
+# The normalized fractional exponent is ef = e + s = a + 1
+#
+# For context c and a number x we have:
+# * e == x.exponent == x.to_int_scale.last == x.integral_exponent
+# * ei == c.normalized_integral_exponent(x) == c.normalize(x).exponent == c.to_normalized_int_scale(x).last
+# * a == c.adjusted_exponent == c.scientific_exponent == c.logb(x).to_i == c.a
+# * re == c.reduce(x).exponent.to_i == c.reduced_exponent # the first uses c because it rounds to it
+# * s == x.number_of_digits == x.digits.size
+# * sr == c.reduce(x).number_of_digits
+# * p == c.precision
+# * ne == x.fractional_exponent
 #
-# ==Example: 0.01204
+# ==Example: 0.0120400
 #
 # * The integral significand is 120400 and the internal exponent that applies to it is e = -7
 # * The number of significand digits is s = 6
@@ -60,13 +78,25 @@
 #
 # ==Exponent limits
 #
-# The (integral) exponent e must be within this limits: etiny <= e <= etop
-# The adjusted exponent a must: emin <= a <= emax
-# emin, emax are the limite of the exponent shown in scientific notation and are use to defined
-# the exponent limits in the contexts.
-# etiny = emin-precision+1 and etop=emax-precision+1 are the limits of the internal exponent.
-# Note that for significands with less than precision digits we can use exponents greater than etop
-# without causing overflow: +Decimal(+1,1,emax) == Decimal(+1,K,etop) where K=10**(precision-1)
+# A context defines the limits for adjusted (scientific) exponents, emin, emax, and equivalently,
+# the limits for internal (integral) exponents, etiny, etop. The emin, emax are the limits of the exponent
+# shown in scientific notation (except for subnormal numbers) and are use to define the context exponent
+# limits. We have etiny == emin-p+1 and etop==emax-p+1 where p is the context precision.
+#
+# For a given context a number with an integral significand not exceeding the context precision in number of digits
+# and with integral exponents e in the range:
+#   etiny <= e <= etop
+# is always valid.
+# The adjusted exponent, a, of valid normal numbers within the context must verify:
+#   emin <= a <= emax
+# If the significand is normalized (uses the full precision of the context)
+# the internal exponent cannot exceed etop. Significands with less digits than the context precision
+# can have internal exponents greater than etop withoug causing overflow:
+#  +DecNum(1,context.emax) == DecNum(10**(context.precision-1),context.etop)
+# The maximum finite value, which has a normalized (full precision) significand has internal exponent e==etop.
+# The minimum normal value and all adjusted subnormal values have e==etiny, but non-adjusted subnormal values
+# can have e<etiny: +DecNum(10,context.etiny-1) == Decimal(1,context.etiny) == context.minimum_nonzero
+# Subnormal numbers have adjusted exponents in the range: context.etiny <= a < context.emin
 #
 # =Interoperatibility with other numeric types
 #
@@ -96,7 +126,6 @@
 #++
 
 require 'flt/support'
-require 'flt/version'
 
 require 'bigdecimal'
 require 'forwardable'
@@ -933,7 +962,7 @@ class Num < Numeric
     # Maximum finite number
     def maximum_finite(sign=+1)
       return exception(InvalidOperation, "Exact context maximum finite value") if exact?
-      # equals +Num(+1, 1, emax)
+      # equals Num(+1, 1, emax+1) - Num(+1, 1, etop)
       # equals Num.infinity.next_minus(self)
       Num(sign, num_class.int_radix_power(precision)-1, etop)
     end
@@ -2260,6 +2289,24 @@ class Num < Numeric
     return Num(dup.sign, coeff/num_class.int_radix_power(nd-end_d), exp)
   end
 
+  # Exponent corresponding to the integral significand with all trailing digits removed.
+  # Does not use any context; equals the value of self.reduce.exponent (but as an integer rather than a Num)
+  # except for special values and when the number is rounded under the context or exceeds its limits.
+  def reduced_exponent
+    if self.special? || self.zero?
+      0
+    else
+      exp = self.exponent
+      dgs = self.digits
+      nd = dgs.size # self.number_of_digits
+        while dgs[nd-1]==0
+        exp += 1
+        nd -= 1
+      end
+      exp
+    end
+  end
+
   # Normalizes (changes quantum) so that the coefficient has precision digits, unless it is subnormal.
   # For surnormal numbers the Subnormal flag is raised an a subnormal is returned with the smallest
   # possible exponent.
@@ -2641,6 +2688,21 @@ class Num < Numeric
   def ==(other)
     (self<=>other) == 0
   end
+
+  # For MRI this is unnecesary, but it is needed for Rubinius because of the coercion done in Numeric#< etc.
+  def <=(other)
+    (self<=>other) <= 0
+  end
+  def <(other)
+    (self<=>other) < 0
+  end
+  def >=(other)
+    (self<=>other) >= 0
+  end
+  def >(other)
+    (self<=>other) > 0
+  end
+
   include Comparable
 
   def hash
@@ -4205,7 +4267,6 @@ class Num < Numeric
       (1...t).to_a.reverse.each do |k|
          w = _div_nearest(m, k) - _div_nearest(yshift*w, m)
       end
-
       return _div_nearest(w*y, m)
     end
 
@@ -4493,4 +4554,4 @@ class Num < Numeric
 
 end # Num
 
-end # Flt
+end # Flt

data/lib/flt/sugar.rb

@@ -102,6 +102,9 @@ end
 
 # Shortcut to define DecNums, e.g. 1._234567890123456789 produces Flt::DecNum('1.234567890123456789')
 # Based on http://coderrr.wordpress.com/2009/12/22/get-arbitrarily-precise-bigdecimals-in-ruby-for-just-one-extra-character/
+# There's a problem with negative numbers with a null integer part: -0._1 is parsed as (-0)._1 and -0 is 0.
+# The problem cannot be solved by redefinition of -@ for integers because -0 is interpreted as 0 by the Ruby parser
+# (no runtime method call is involved). Such numbers have to be entered as -(0._1)
 class Integer
   def method_missing(m, *a, &b)
     return Flt::DecNum("#{self}.#{$1.tr('_','')}")  if m.to_s =~ /^_(\d[_\d]*)$/

data/lib/flt/tolerance.rb

@@ -160,7 +160,7 @@ module Flt
     end
 
     # strongly equals: x == y within tolerance (strict)
-    def seq?
+    def seq?(x, y)
       (x-y).abs <= relative_to_many(:min, x, y)
     end
 

data/lib/flt/version.rb

@@ -1,9 +1,3 @@
 module Flt
-  module VERSION #:nodoc:
-    MAJOR = 1
-    MINOR = 3
-    TINY  = 0
-
-    STRING = [MAJOR, MINOR, TINY].join('.')
-  end
+  VERSION = "1.3.1"
 end

data/test/test_define_conversions.rb

@@ -55,7 +55,7 @@ class TestDefineConversions < Test::Unit::TestCase
       end
     end
 
-    assert_raise(TypeError) { DecNum('0') == BigDecimal.new('0') }
+    assert_raise(TypeError, RuntimeError) { DecNum('0') == BigDecimal.new('0') }
     unless Num < Numeric
       # BigDecimal#eql? is weird
       assert_not_equal BigDecimal.new('0'), DecNum('0')
@@ -64,11 +64,11 @@ class TestDefineConversions < Test::Unit::TestCase
       assert_not_equal BigDecimal.new('1.2345'), DecNum('0.0012345000E3')
       assert_raise(TypeError) { BigDecimal.new('7')+DecNum('0.1') }
     end
-    assert_raise(TypeError) { DecNum('7')+BigDecimal.new('0.1') }
-    assert_raise(TypeError) { DecNum(BigDecimal.new('1.1')) }
+    assert_raise(TypeError, RuntimeError) { DecNum('7')+BigDecimal.new('0.1') }
+    assert_raise(TypeError, RuntimeError) { DecNum(BigDecimal.new('1.1')) }
 
     ['0.1', '-0.1', '0.0', '1234567.1234567', '-1234567.1234567', '1.234E7', '1.234E-7'].each do |n|
-      assert_raise(TypeError) { DecNum(n).convert_to(BigDecimal) }
+      assert_raise(TypeError, RuntimeError) { DecNum(n).convert_to(BigDecimal) }
     end
 
   end

data/test/test_sugar.rb

@@ -14,11 +14,11 @@ class TestSugar < Test::Unit::TestCase
                  123456789123._01234567890123456789012345678901234567890123456789
     assert_equal Flt::DecNum('-123456789123.01234567890123456789012345678901234567890123456789'),
                  -123456789123._01234567890123456789012345678901234567890123456789
-    assert_raise(NoMethodError){3._x}
-    assert_raise(NoMethodError){3._3233x}
-    assert_raise(NoMethodError){3._3233x34333}
-    assert_raise(NoMethodError){3.__}
-    assert_raise(NoMethodError){3._}
+    assert_raise(NoMethodError,NameError){3._x}
+    assert_raise(NoMethodError,NameError){3._3233x}
+    assert_raise(NoMethodError,NameError){3._3233x34333}
+    assert_raise(NoMethodError,NameError){3.__}
+    assert_raise(NoMethodError,NameError){3._}
     assert_equal Flt::DecNum, 10._32_23.class
     assert_equal Flt::DecNum('10.3223'), 10._32_23
     assert_equal Flt::DecNum('3.01234567890123456789012345678901234567890123456789'),

metadata

@@ -1,55 +1,60 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: flt
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 1
-  - 3
-  - 0
-  version: 1.3.0
+version: !ruby/object:Gem::Version
+  version: 1.3.1
 platform: ruby
-authors: 
+authors:
 - Javier Goizueta
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-06-22 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: bones
+date: 2014-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 2
-        - 1
-        - 1
-        version: 2.1.1
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: Floating Point Numbers
-email: javier@goizueta.info
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Decimal and binary arbitrary precision floating point numbers in pure
+  Ruby.
+email:
+- jgoizueta@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- History.txt
-- License.txt
-- README.txt
-files: 
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
 - History.txt
 - License.txt
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
+- expand.rb
+- flt.gemspec
 - lib/flt.rb
 - lib/flt/b.rb
 - lib/flt/bigdecimal.rb
@@ -67,19 +72,6 @@ files:
 - lib/flt/trigonometry.rb
 - lib/flt/version.rb
 - setup.rb
-- tasks/ann.rake
-- tasks/bones.rake
-- tasks/gem.rake
-- tasks/git.rake
-- tasks/manifest.rake
-- tasks/notes.rake
-- tasks/post_load.rake
-- tasks/rdoc.rake
-- tasks/rubyforge.rake
-- tasks/setup.rb
-- tasks/spec.rake
-- tasks/svn.rake
-- tasks/test.rake
 - test/all_tests.rb
 - test/generate_trig_data.rb
 - test/helper.rb
@@ -105,50 +97,35 @@ files:
 - test/test_tol.rb
 - test/test_trig.rb
 - test/test_ulp.rb
-has_rdoc: true
-homepage: http://flt.rubyforge.org
-licenses: []
-
+homepage: http://github.com/jgoizueta/flt
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --main
-- README.txt
-- --title
-- Ruby Flt Documentation
-- --opname
-- index.html
-- --line-numbers
-- --inline-source
-- --main
-- README.txt
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: flt
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Floating Point Numbers
-test_files: 
+test_files:
+- test/all_tests.rb
+- test/generate_trig_data.rb
+- test/helper.rb
+- test/reader.rb
 - test/test_basic.rb
 - test/test_bin.rb
 - test/test_bin_arithmetic.rb