fixed_point 0.2.0 → 0.2.1

data/HISTORY.md

@@ -9,8 +9,7 @@ HISTORY/Changelog
 0.2.0
 -----
 
-  Added to_s method on numbers. Output is now the same as calling .to_f.to_s
-
+ Added to_s method on numbers. Output is now the same as calling .to_f.to_s
 
 0.1.1
 -----

data/Rakefile

@@ -24,11 +24,6 @@ namespace :deploy do
     line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
   end
 
-  #Dir.chdir( './lib/')
-  #puts require NAME
-  #Dir.chdir( './../')
-
-
   desc 'Run Spec'
   #file_list = FileList['spec/*_spec.rb']
   html_path = "spec_results.html"  
@@ -69,7 +64,7 @@ namespace :deploy do
 
   task :push_gem do
     puts "Pushing Gem #{name}-#{version}"
-    #`gem push`
+    `gem push #{name}-#{version}.gem`
     unless $?.success?
         $stderr.puts "Gem Push Failed"
         exit -1
@@ -78,7 +73,7 @@ namespace :deploy do
 
   task :create_git_tag do
     puts "Tagging #{name}-#{version}"
-    #`git tag -a #{version} -m 'Tagging gem release #{version}'`
+    `git tag -a #{version} -m 'Tagging gem release #{version}'`
     unless $?.success?
         $stderr.puts "Tagging Git Failed"
         exit -1
@@ -87,7 +82,7 @@ namespace :deploy do
 
   task :push_tag do
     puts "Push Tag #{version}"
-    #`git push origin #{version}`
+    `git push origin #{version}`
     unless $?.success?
         $stderr.puts "Pushing Git Tag Failed"
         exit -1

data/lib/fixed_point.rb

@@ -1,5 +1,5 @@
 module FixedPoint
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end
 
 begin

data/lib/fixed_point/number.rb

@@ -154,45 +154,59 @@ module FixedPoint
         #  Do not change the Signed format as can not detect that from bit pattern
         @format = Format.new(@format.signed, int_bits, frac_bits)
 
-        ###########################
-        ### Routine to generate source from binary
-        ###########################
-        @source  = 0.0
-        index    = 0
-        set_int.reverse.each_char do |x|
-          if x == "1"
-            #If input is signed then MSB is negative
-            if ((index + 1) == @format.int_bits) and (@format.signed?)
-              @source = @source + -2**index 
-            else  
-              @source = @source + 2**index 
-            end
-          end
-          index = index + 1
-        end
-
-        index = 1
-        set_frac.each_char do |x|
-          if x == "1"
-            @source = @source + 2**-index
-          end
-          index = index + 1
-        end
-        ################################
+        @source  = binary_to_float( set_int, set_frac)
         
         ## Set the Quantised value
         @quantised = @source
 
         return binary
       else 
-        puts "ERROR invalid input binary\(#{text}\)"
+        $stderr.puts "ERROR invalid binary input \(#{text}\)"
         return nil
       end
     end
 
+    ## TODO this feature for version 0.2.1
     def hex=( text )
-      puts "hex = Mehtod not completed"
-      ## Strip leading 0x if present
+      ## Hex numbers do not get delimited
+      ## TODO Strip leading \d+'h (Verilog denominator)
+      
+      if text.match(/(0x)?([0-9a-fA-F]*)/ )
+        # Convert Hex to integer
+        #   integer to binary string
+        binary_bits = $2.to_i(16).to_s(2)
+        
+        #Ensure min length (for reliability manipulating string)
+        binary_bits = binary_bits.rjust(text.size*4, '0')
+       
+        if @format.frac_bits > 0
+          set_frac = binary_bits[-@format.frac_bits, @format.frac_bits]
+        else
+          set_frac = ""
+        end
+        
+        set_int  = binary_bits[-(@format.width)..-(@format.frac_bits+1)]
+
+        ## Was the input word length too Long
+        oversized_bits = binary_bits.size - @format.width 
+        if oversized_bits > 0
+          # give a semantic name to the discarded bits
+          discarded_bits = binary_bits[0,oversized_bits]
+
+          #If data (mix of 1 and 0) contained in the discarded bits raise Error
+          unless all_bits_the_same discarded_bits   
+            $stderr.puts %{Error using hex=#{text}, format is #{@format.width}, truncated data is #{discarded_bits}
+  The MSBs seem to contain data they are not just 0 or 1 padded}
+          end
+        end
+
+        @source    = binary_to_float( set_int, set_frac )
+        @quantised = @source
+
+      else
+        $stderr.puts "ERROR invalid hex input \(#{text}\)"
+        return nil
+      end
     end
 
 
@@ -206,6 +220,14 @@ module FixedPoint
 
     private
 
+    def all_bits_the_same( bin_string )
+      word = bin_string.split('')
+      all_one = word.all?{|x| x == '1' }
+      all_zero = word.all?{|x| x == '0' }
+      return  (all_one || all_zero)
+    end
+
+    
     def check_for_overflow_underflow( source, format)
       overflow  = false
       underflow = false
@@ -299,13 +321,39 @@ module FixedPoint
 
 
 
+    ##
+    def binary_to_float(int_part, frac_part ) 
+      index    = 0
+      value    = 0.0
+      int_part.reverse.each_char do |x|
+        if x == "1"
+          #If input is signed then MSB is negative
+          if ((index + 1) == @format.int_bits) and (@format.signed?)
+            value = value + -2**index 
+          else  
+            value = value + 2**index 
+          end
+        end
+        index = index + 1
+      end
+
+      index = 1
+      frac_part.each_char do |x|
+        if x == "1"
+          value = value + 2**-index
+        end
+        index = index + 1
+      end
+
+      return value
+    end
 
    
-    ## Taking methd out until covered by tests
+    ## Taking method out until covered by tests
     #def normalised
     #  #This use to be only for positive numbers
     #
-    #  # This function shiftes the fixedpoint number 
+    #  # This function shifts the fixedpoint number 
     #  #   so it can be represented as an integer.
     #  return  Integer((@quantised)*(2**@format.frac_bits))
     #end

data/spec/fixed_point_hex_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+
+describe FixedPoint do
+  it "Create 4 bit hex 7" do
+    format = FixedPoint::Fixdt.new(0, 4, 0)
+    fixt = FixedPoint::Number.new(0, format)
+    
+    fixt.hex = "7"
+    fixt.source.should    == 7.0
+    fixt.to_f.should      == 7.0
+    fixt.to_s.should      == "7.0"
+    fixt.to_i.should      == 7
+    fixt.frac.should      == 0.0
+    fixt.to_h.should      == "7"
+    fixt.to_b.should      == "0111"
+    fixt.overflow?.should  == false
+    fixt.underflow?.should == false
+  end
+  
+  it "Create 4 bit hex F" do
+    format = FixedPoint::Fixdt.new(0, 4, 0)
+    fixt = FixedPoint::Number.new(0, format)
+    
+    fixt.hex = "F"
+    fixt.source.should    == 15.0
+    fixt.to_f.should      == 15.0
+    fixt.to_s.should      == "15.0"
+    fixt.to_i.should      == 15
+    fixt.frac.should      == 0.0
+    fixt.to_h.should      == "f"
+    fixt.to_b.should      == "1111"
+    fixt.overflow?.should  == false
+    fixt.underflow?.should == false
+  end
+  
+  it "Create 4 bit hex F Signed" do
+    format = FixedPoint::Fixdt.new(1, 4, 0)
+    fixt = FixedPoint::Number.new(0, format)
+    
+    fixt.hex = "F"
+    fixt.source.should    == -1.0
+    fixt.to_f.should      == -1.0
+    fixt.to_s.should      == "-1.0"
+    fixt.to_i.should      == -1
+    fixt.frac.should      == 0.0
+    fixt.to_h.should      == "f"
+    fixt.to_b.should      == "1111"
+    fixt.overflow?.should  == false
+    fixt.underflow?.should == false
+  end
+  
+  it "Create 4 bit hex F Signed" do
+    format = FixedPoint::Fixdt.new(1, 4, 0)
+    fixt = FixedPoint::Number.new(0, format)
+    
+    fixt.hex = "F"
+    fixt.source.should    == -1.0
+    fixt.to_f.should      == -1.0
+    fixt.to_s.should      == "-1.0"
+    fixt.to_i.should      == -1
+    fixt.frac.should      == 0.0
+    fixt.to_h.should      == "f"
+    fixt.to_b.should      == "1111"
+    fixt.overflow?.should  == false
+    fixt.underflow?.should == false
+  end
+
+  it "Create 8 bit Signed hex f0 [1,4,4] = -1.0" do
+    format = FixedPoint::Format.new(1, 4, 4)
+    fixt   = FixedPoint::Number.new(0, format)
+    
+    fixt.hex = "f0"
+    fixt.source.should    == -1.0
+    fixt.to_f.should      == -1.0
+    fixt.to_s.should      == "-1.0"
+    fixt.to_i.should      == -1
+    fixt.frac.should      == 0.0
+    fixt.to_h.should      == "f0"
+    fixt.to_b.should      == "1111.0000"
+    fixt.overflow?.should  == false
+    fixt.underflow?.should == false
+  end
+
+  it "hex= should ignore msb past word length" do
+    format = FixedPoint::Format.new(1, 4, 4)
+    fixt   = FixedPoint::Number.new(0, format)
+    
+    fixt.hex = "f80"
+    fixt.source.should    == -8.0
+    fixt.to_f.should      == -8.0
+    fixt.to_s.should      == "-8.0"
+    fixt.to_i.should      == -8
+    fixt.frac.should      == 0.0
+    fixt.to_h.should      == "80"
+    fixt.to_b.should      == "1000.0000"
+    fixt.overflow?.should  == false
+    fixt.underflow?.should == false
+  end
+  
+  it "hex= should ignore truncated MSBs, 0 padded" do
+    format = FixedPoint::Format.new(0, 6, 0)
+    fixt   = FixedPoint::Number.new(0, format)
+    
+    fixt.hex = "00"
+    fixt.source.should    == 0.0
+    fixt.to_f.should      == 0.0
+    fixt.to_s.should      == "0.0"
+    fixt.to_i.should      == 0
+    fixt.frac.should      == 0.0
+    fixt.to_h.should      == "00"
+    fixt.to_b.should      == "000000"
+    fixt.overflow?.should  == false
+    fixt.underflow?.should == false
+  end
+  it "hex= should ignore truncated MSBs, 1 padded" do
+    format = FixedPoint::Format.new(0, 6, 0)
+    fixt   = FixedPoint::Number.new(0, format)
+    
+    fixt.hex = "C0"
+    fixt.source.should    == 0.0
+    fixt.to_f.should      == 0.0
+    fixt.to_s.should      == "0.0"
+    fixt.to_i.should      == 0
+    fixt.frac.should      == 0.0
+    fixt.to_h.should      == "00"
+    fixt.to_b.should      == "000000"
+    fixt.overflow?.should  == false
+    fixt.underflow?.should == false
+  end
+  
+  it "hex= should catch data in truncated MSBs" do
+    format = FixedPoint::Format.new(0, 6, 0)
+    fixt   = FixedPoint::Number.new(0, format)
+    
+    error = %{Error using hex=40, format is 6, truncated data is 01\n  The MSBs seem to contain data they are not just 0 or 1 padded}
+    $stderr.should_receive(:puts).with( error ) 
+    fixt.hex = "40"
+
+    fixt.source.should    == 0.0
+    fixt.to_f.should      == 0.0
+    fixt.to_s.should      == "0.0"
+    fixt.to_i.should      == 0
+    fixt.frac.should      == 0.0
+    fixt.to_h.should      == "00"
+    fixt.to_b.should      == "000000"
+    fixt.overflow?.should  == false
+    fixt.underflow?.should == false
+  end
+
+  #it "hex= should catch data in truncated MSBs" do
+  #  format = FixedPoint::Format.new(0, 6, 0)
+  #  fixt   = FixedPoint::Number.new(0, format)
+  #  
+  #  error = %{Error using hex=80, format is 6, truncated data is 10\n  The MSBs seem to contain data they are not just 0 or 1 padded}
+  #  $stderr.should_receive(:puts).with( error ) 
+  #  fixt.hex = "80"
+
+  #  fixt.source.should    == 0.0
+  #  fixt.to_f.should      == 0.0
+  #  fixt.to_s.should      == "0.0"
+  #  fixt.to_i.should      == 0
+  #  fixt.frac.should      == 0.0
+  #  fixt.to_h.should      == "00"
+  #  fixt.to_b.should      == "000000"
+  #  fixt.overflow?.should  == false
+  #  fixt.underflow?.should == false
+  #end
+
+  it "Bin= check 0x removal " do
+    format = FixedPoint::Format.new(1, 4, 4)
+    fixt   = FixedPoint::Number.new(0, format)
+    
+    fixt.hex = "0xf0"
+    fixt.source.should    == -1.0
+    fixt.to_f.should      == -1.0
+    fixt.to_s.should      == "-1.0"
+    fixt.to_i.should      == -1
+    fixt.frac.should      == 0.0
+    fixt.to_h.should      == "f0"
+    fixt.to_b.should      == "1111.0000"
+    fixt.overflow?.should  == false
+    fixt.underflow?.should == false
+  end
+
+  it "Bin= check 0x removal " do
+    format = FixedPoint::Format.new(1, 4, 4)
+    fixt   = FixedPoint::Number.new(0, format)
+    
+    fixt.hex = "0xf1"
+    fixt.source.should    == -0.9375
+    fixt.to_f.should      == -0.9375
+    fixt.to_s.should      == "-0.9375"
+    fixt.to_i.should      == 0
+    fixt.frac.should      == -0.9375
+    fixt.to_h.should      == "f1"
+    fixt.to_b.should      == "1111.0001"
+    fixt.overflow?.should  == false
+    fixt.underflow?.should == false
+  end
+end
+

data/spec/fixed_point_spec.rb

@@ -21,83 +21,83 @@ describe FixedPoint do
     fixt.frac.should      == 0.0
     fixt.to_h.should      == "00000000"
     fixt.to_b.should      == "000000000000.00000000000000000000"  
-end
+  end
 
-it "Integers 0 " do
-  format = FixedPoint::Format.new(1,8,0)
-  fixt   = FixedPoint::Number.new(7.0, format, "_")
-
-  fixt.source.should   == 7.0
-  fixt.to_f.should     == 7.0
-  fixt.to_s.should     == "7.0"
-  fixt.to_i.should     == 7
-  fixt.frac.should     == 0.0
-  fixt.to_h.should     == "07"
-  fixt.to_b.should     == "00000111"
-end
+  it "Integers 0 " do
+    format = FixedPoint::Format.new(1,8,0)
+    fixt   = FixedPoint::Number.new(7.0, format, "_")
 
-it "Different Decimal Mark _ instead of ." do
-  format = FixedPoint::Format.new(1,12,20)
-  fixt   = FixedPoint::Number.new(0, format, "_")
-
-  fixt.source.should   == 0.0
-  fixt.to_f.should     == 0.0
-  fixt.to_s.should     == "0.0"
-  fixt.to_i.should     == 0
-  fixt.frac.should     == 0.0
-  fixt.to_h.should     == "00000000"
-  fixt.to_b.should     == "000000000000_00000000000000000000"
-end
+    fixt.source.should   == 7.0
+    fixt.to_f.should     == 7.0
+    fixt.to_s.should     == "7.0"
+    fixt.to_i.should     == 7
+    fixt.frac.should     == 0.0
+    fixt.to_h.should     == "07"
+    fixt.to_b.should     == "00000111"
+  end
 
-(1...20).to_a.reverse_each do |x|
-  int_bits = 12
-  it "Returns 0.0 for initalise of 0 with #{x} fractional bits" do
-    format = FixedPoint::Format.new(1, int_bits, x)
-    fixt   = FixedPoint::Number.new(0, format)
-    #fixt = FixedPoint::Number.new(0,1,int_bits,x)
+  it "Different Decimal Mark _ instead of ." do
+    format = FixedPoint::Format.new(1,12,20)
+    fixt   = FixedPoint::Number.new(0, format, "_")
 
     fixt.source.should   == 0.0
     fixt.to_f.should     == 0.0
     fixt.to_s.should     == "0.0"
     fixt.to_i.should     == 0
     fixt.frac.should     == 0.0
-    #Calculate hex length and fill with 0's
-    hex = ""
-    hex_length = ((x.to_f+int_bits.to_f)/4).ceil
-    hex_length.times { hex += "0" }
-    fixt.to_h.should     == hex
-    #Calculate binary fractional length and fill with 0's
-    lsbs = ""
-    x.times { lsbs += "0" }
-    fixt.to_b.should     == "000000000000.#{lsbs}"
-end
-end
+    fixt.to_h.should     == "00000000"
+    fixt.to_b.should     == "000000000000_00000000000000000000"
+  end
 
+  (1...20).to_a.reverse_each do |x|
+    int_bits = 12
+    it "Returns 0.0 for initalise of 0 with #{x} fractional bits" do
+      format = FixedPoint::Format.new(1, int_bits, x)
+      fixt   = FixedPoint::Number.new(0, format)
+      #fixt = FixedPoint::Number.new(0,1,int_bits,x)
+
+      fixt.source.should   == 0.0
+      fixt.to_f.should     == 0.0
+      fixt.to_s.should     == "0.0"
+      fixt.to_i.should     == 0
+      fixt.frac.should     == 0.0
+      #Calculate hex length and fill with 0's
+      hex = ""
+      hex_length = ((x.to_f+int_bits.to_f)/4).ceil
+      hex_length.times { hex += "0" }
+      fixt.to_h.should     == hex
+      #Calculate binary fractional length and fill with 0's
+      lsbs = ""
+      x.times { lsbs += "0" }
+      fixt.to_b.should     == "000000000000.#{lsbs}"
+    end
+  end
 
-it "Zero fractional bits " do
-  format = FixedPoint::Format.new(1,12,0)
-  fixt   = FixedPoint::Number.new(0, format, "_")
 
-  fixt.source.should   == 0.0
-  fixt.to_f.should     == 0.0
-  fixt.to_s.should     == "0.0"
-  fixt.to_i.should     == 0
-  fixt.frac.should     == 0.0
-  fixt.to_h.should     == "000"
-  fixt.to_b.should     == "000000000000"
-end
+  it "Zero fractional bits " do
+    format = FixedPoint::Format.new(1,12,0)
+    fixt   = FixedPoint::Number.new(0, format, "_")
 
+    fixt.source.should   == 0.0
+    fixt.to_f.should     == 0.0
+    fixt.to_s.should     == "0.0"
+    fixt.to_i.should     == 0
+    fixt.frac.should     == 0.0
+    fixt.to_h.should     == "000"
+    fixt.to_b.should     == "000000000000"
+  end
 
-it "returns 2.5 for initalise of 2.5" do
-  fixt = FixedPoint::Number.new(2.5)
 
-  fixt.source.should   == 2.5
-  fixt.to_f.should     == 2.5
-  fixt.to_s.should     == "2.5"
-  fixt.to_i.should     == 2
-  fixt.frac.should     == 0.5
-  fixt.to_h.should     == "00280000"
-  fixt.to_b.should     == "000000000010.10000000000000000000"
+  it "returns 2.5 for initalise of 2.5" do
+    fixt = FixedPoint::Number.new(2.5)
+
+    fixt.source.should   == 2.5
+    fixt.to_f.should     == 2.5
+    fixt.to_s.should     == "2.5"
+    fixt.to_i.should     == 2
+    fixt.frac.should     == 0.5
+    fixt.to_h.should     == "00280000"
+    fixt.to_b.should     == "000000000010.10000000000000000000"
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fixed_point
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-10 00:00:00.000000000 Z
+date: 2012-05-22 00:00:00.000000000 Z
 dependencies: []
 description: Fixed Point numerical type for simulating fixed point calculations
 email: fixed_point_gem@amaras-tech.co.uk
@@ -26,6 +26,7 @@ files:
 - lib/fixed_point/format.rb
 - lib/fixed_point/number.rb
 - lib/fixed_point.rb
+- spec/fixed_point_hex_spec.rb
 - spec/fixed_point_negative_spec.rb
 - spec/fixed_point_spec.rb
 - spec/spec_helper.rb