hpsqrt 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9e8c696801667af06718bf68800c0bc364372971f6e9708fa3bc99f878bd37a
-  data.tar.gz: '0813db15d0b31c395c14060af5947830fcd5d6c2a95627a83cc4cd9671414de6'
+  metadata.gz: d5bffde79d311243876f44ee4b1ff147ba20af8a9e4ba58350ded7c08d1b2813
+  data.tar.gz: 39d401c261d8db364ef0c2ccd90c670950a80c31b93601713b4c45e8fe69ebac
 SHA512:
-  metadata.gz: 80eda9901b98547e6aef9813d3b737f79de8af71577220c7f4bc34f8c8cef02e4d00dfcb3ada2bd199fd90cf5bf6049de8d7a838dad176fdce3e4d1cfd4f26b4
-  data.tar.gz: dbfff2f96f8889fb21a97847e8b318ad77e2216940ffcca57ec41bfd58767e1c4123df03e9eaf90f92bf4b8ca7bad7ff0e6558c20c9c8620cb02b6489860c5f3
+  metadata.gz: b115f6a582dff2eb3cbd81c4f02d1327a2399e52841d231422e2590a8f13ec36fd5db72a1079881ca3daacd7eb2e7d0ee63db9bc729e1cf442d9a2458d22a118
+  data.tar.gz: b40e5458449e832a20d4f251c4191c4f1264400fb476c8cc3971e8a048f73b5f91f103543bf6e443ea5f41d3dd5586fd2dbb08a6c95760a3b7229682d5c30727

data/README.md

@@ -1,8 +1,7 @@
-# HpSqrt
-
-- master: [![Build Status](https://travis-ci.org/yoshida-eth0/ruby-sqrt.svg?branch=master)](https://travis-ci.org/yoshida-eth0/ruby-sqrt)
+[![Build Status](https://travis-ci.org/yoshida-eth0/ruby-sqrt.svg?branch=master)](https://travis-ci.org/yoshida-eth0/ruby-sqrt)
+[![Gem Version](https://badge.fury.io/rb/hpsqrt.svg)](https://badge.fury.io/rb/hpsqrt)
 
-## Overview
+# HpSqrt
 
 High precision square root library for Ruby.
 
@@ -26,85 +25,91 @@ Or install it yourself as:
 
 High precision calculation:
 
-    require 'hpsqrt/core_ext'
-    
-    p Sqrt(2)
-    #  => 1.4142135623730951+0.0i
-    
-    p Sqrt(2) ** 2
-    #  => 2.0+0.0i
-    
-    p Sqrt(3) * Sqrt(5) * Sqrt(15)
-    #  => 15.0+0.0i
-    
-    p Sqrt(1i) ** 4
-    #  => -1.0+0.0i
-    
-    p (Sqrt(7) + Sqrt(11)) * (Sqrt(7) - Sqrt(11))
-    #  => -4.0+0.0i
+```ruby
+require 'hpsqrt/core_ext'
+
+p Sqrt(2)
+#  => 1.4142135623730951+0.0i
+
+p Sqrt(2) ** 2
+#  => 2.0+0.0i
+
+p Sqrt(3) * Sqrt(5) * Sqrt(15)
+#  => 15.0+0.0i
+
+p Sqrt(1i) ** 4
+#  => -1.0+0.0i
+
+p (Sqrt(7) + Sqrt(11)) * (Sqrt(7) - Sqrt(11))
+#  => -4.0+0.0i
+```
 
 Support operators:
 
-    +, -, *, /, %, **, ==
+    +, -, *, /, %, **, ==, <=>
 
 Type casting:
 
-    require 'hpsqrt/core_ext'
-    
-    # to Float
-    p Sqrt(5).to_f
-    #  => 2.23606797749979
-    
-    # to Integer
-    p Sqrt(5).to_i
-    #  => 2
-    
-    # to Rational
-    p Sqrt(4).to_r
-    #  => (2/1)
-    
-    # to Complex
-    p Sqrt(-1i).to_c
-    #  => (0.7071067811865476-0.7071067811865476i) 
-    
-    # to Complex real number
-    p Sqrt(-1i).real
-    #  => 0.7071067811865476
-    
-    # to Complex imaginary number
-    p Sqrt(1i).imag
-    #  => -0.7071067811865476
-    
-    p (Sqrt(5) + Sqrt(7)).expr
-    #  => "√5 + √7" 
+```ruby
+require 'hpsqrt/core_ext'
+
+# to Float
+p Sqrt(5).to_f
+#  => 2.23606797749979
+
+# to Integer
+p Sqrt(5).to_i
+#  => 2
+
+# to Rational
+p Sqrt(4).to_r
+#  => (2/1)
+
+# to Complex
+p Sqrt(-1i).to_c
+#  => (0.7071067811865476-0.7071067811865476i) 
+
+# to Complex real number
+p Sqrt(-1i).real
+#  => 0.7071067811865476
+
+# to Complex imaginary number
+p Sqrt(1i).imag
+#  => -0.7071067811865476
+
+p (Sqrt(5) + Sqrt(7)).expr
+#  => "√5 + √7" 
+```
 
 Type check:
 
-    require 'hpsqrt/core_ext'
-    
-    # real? returns true if imaginary number is 0
-    p Sqrt(5).real?
-    #  => true
-    p Sqrt(1i).real?
-    #  => false
-
-    # imag? returns true if imaginary number is not 0
-    p Sqrt(5).imag?
-    #  => false
-    p Sqrt(1i).imag?
-    #  => true
-    
-    # int? return true if after the real decimal point is 0 and imaginary number is 0
-    p Sqrt(2).int?
-    #  => false
-    p Sqrt(4).int?
-    #  => true
-    
-    # float? return true if after the real decimal point is not 0 and imaginary number is 0
-    p Sqrt(2).float?
-    #  => true
-    p Sqrt(4).float?
-    #  => false
+```ruby
+require 'hpsqrt/core_ext'
+
+# real? returns true if imaginary number is 0
+p Sqrt(5).real?
+#  => true
+p Sqrt(1i).real?
+#  => false
+
+# imag? returns true if imaginary number is not 0
+p Sqrt(5).imag?
+#  => false
+p Sqrt(1i).imag?
+#  => true
+
+# int? return true if after the real decimal point is 0 and imaginary number is 0
+p Sqrt(2).int?
+#  => false
+p Sqrt(4).int?
+#  => true
+
+# float? return true if after the real decimal point is not 0 and imaginary number is 0
+p Sqrt(2).float?
+#  => true
+p Sqrt(4).float?
+#  => false
+```
 
 ## Contributing
 

data/lib/hpsqrt.rb

@@ -23,6 +23,7 @@ class HpSqrt < Numeric
     @cache = {}
     freeze
   end
+  private :initialize
 
   def -@
     terms = @terms.map{|t,c| [t, -c]}.to_h
@@ -119,9 +120,11 @@ class HpSqrt < Numeric
   end
 
   def <=>(other)
-    if self==other
+    if !(Numeric===other)
+      nil
+    elsif self==other
       0
-    elsif !self.real? || !other.real?
+    elsif !self.real? || !other.imag.zero?
       nil
     else
       self.real <=> other.real

data/lib/hpsqrt/term.rb

@@ -5,6 +5,13 @@ class HpSqrt < Numeric
     attr_reader :sqrt
 
     def initialize(number: 1, sqrt: 1)
+      unless Numeric===number
+        raise TypeError, "can't convert %s into %s: %s" % [number.class.name, self.class.name, number.inspect]
+      end
+      unless Numeric===sqrt
+        raise TypeError, "can't convert %s into %s: %s" % [sqrt.class.name, self.class.name, sqrt.inspect]
+      end
+
       @number = number
       @sqrt = sqrt
       freeze

data/lib/hpsqrt/version.rb

@@ -1,3 +1,3 @@
 class HpSqrt < Numeric
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hpsqrt
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Yoshida Tetsuya