fixed_point 0.1.0 → 0.1.1

data/HISTORY.md

@@ -1,6 +1,11 @@
 HISTORY/Changelog
 =================
 
+0.1.1
+-----
+
+ Depreciated .fraction method, use .frac instead
+
 0.1.0
 -----
 

data/README.md

@@ -25,6 +25,36 @@ Checkout the examples folder, but here are a few:
     puts fix_num.to_h # Hexadecimal
     puts fix_num.to_b # Binary
     
+Building tables:
+
+    require 'fixed_point'
+    
+    #Signed 8 bit, (4 bit Integer, 4 bit fractional)
+    format = FixedPoint::Format.new(1,4,4)
+
+    table_for_conversion = [ 
+      2.7505, 2.5, 2.25, 2, 0.5, 0, -0.5, -4.5   
+    ]
+
+    table_for_conversion.each do |num|
+      fixt   = FixedPoint::Number.new(num, format, '_')
+      puts "#{format.width}'b#{fixt.to_b}  // Quantised %7.4f  Source %7.4f" % [ fixt.to_f, fixt.source]
+    end
+
+Returns:
+
+    8'b0010_1100  // Quantised  2.7500  Source  2.7505
+    8'b0010_1000  // Quantised  2.5000  Source  2.5000
+    8'b0010_0100  // Quantised  2.2500  Source  2.2500
+    8'b0010_0000  // Quantised  2.0000  Source  2.0000
+    8'b0000_1000  // Quantised  0.5000  Source  0.5000
+    8'b0000_0000  // Quantised  0.0000  Source  0.0000
+    8'b1111_1000  // Quantised -0.5000  Source -0.5000
+    8'b1011_1000  // Quantised -4.5000  Source -4.5000
+
+
+
+
 TODO
 ----
 

data/examples/table_generation.rb

@@ -0,0 +1,46 @@
+
+begin
+  require 'rubygems'
+  require 'fixed_point'
+rescue
+  require_relative '../lib/fixed_point'
+end
+
+
+puts
+puts 'Unsigned 4 bit Integer'
+
+#Unsigned, 4 bit integer
+format = FixedPoint::Format.new(0,4,0)
+
+(0...16).each do |num|
+  fixt   = FixedPoint::Number.new(num, format)
+  puts "#{format.width}'b#{fixt.to_b}  // #{fixt.to_f} "
+end
+
+
+
+puts
+puts 'Signed 8 bit (6 bit int, 2 bit frac)'
+
+format = FixedPoint::Format.new(1,4,4)
+
+table_for_conversion = [ 
+  2.7505, 2.5, 2.25, 2, 0.5, 0, -0.5, -4.5   
+]
+
+table_for_conversion.each do |num|
+  fixt   = FixedPoint::Number.new(num, format, '_')
+  puts "#{format.width}'b#{fixt.to_b}  // Quantised #{fixt.to_f}  Source #{fixt.source}"
+end
+
+
+puts
+puts 'As above, in hex and better string formatting in comments'
+
+## NB "%min_length.frac_length" % float_number, min_length wil lpad with saces as required
+table_for_conversion.each do |num|
+  fixt   = FixedPoint::Number.new(num, format, '_')
+  puts "#{format.width}'h#{fixt.to_h}  // Quantised %7.4f  Source %7.4f" % [ fixt.to_f, fixt.source]
+end
+

data/lib/fixed_point.rb

@@ -1,5 +1,5 @@
 module FixedPoint
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end
 
 begin

data/lib/fixed_point/number.rb

@@ -13,9 +13,6 @@ module FixedPoint
     ############################################
 
 
-    ####################################
-    ### Init
-    ####################################
     def initialize(number, input_format=Format.new(1,12,20), decimal_mark=".")
       @source       = number
       @format       = input_format
@@ -28,12 +25,15 @@ module FixedPoint
     end
 
     ####################################
-    ### Number overflow/underflow flags 
+    ### Numerical overflow flag 
     ####################################
     def overflow?
       @overflow
     end
 
+    ####################################
+    ### Numerical underflow flag 
+    ####################################
     def underflow?
       @underflow
     end
@@ -41,64 +41,62 @@ module FixedPoint
     ####################################
     ### Methods to return number formats
     ####################################
+
+    # Alias for binary.
     def bin
       binary
     end
 
+    # Alias for hexadecimal.
     def hex
       hexadecimal
     end
 
-    #To Binary form
+    # Alias for binary.
     def to_b
       binary
     end
 
-    #To Hexadecimal form
+    # Alias for hexadecimal.
     def to_h
       hexadecimal
     end
 
-    #To Floating Point form, quantised version of _source_
+    #Floating Point form of the quantised value.
     def to_f
       @quantised
     end
 
-    #To Integer, limited integer part of _source_ 
+    #Integer, integer part of quantised value.
     def to_i
       @quantised.to_i
     end
 
-    # Method returns fractional section of fixed point type
-    # not a to_ method as it is not representative of the whole number
+    # Fractional section of quantised value.
     def frac
       (@quantised - to_i)
     end
 
-    def fraction
-      frac
-    end
-    
     ####################################
-    ### Methods to calculate formats
+    ### Calculate Binary format
     ####################################
     def binary
       #Take signed quantised value and create binary string
-      if (@quantised < 0) and fraction.nonzero?
+      if (@quantised < 0) and frac.nonzero?
         # Fractional numbers not negative
         # So the integer part is 1 less than other wise would be and add 1+frac
         ret_bin_int = (@format.max_int_unsigned + to_i  )
-        frac_value  = 1 + fraction
+        frac_value  = 1 + frac
       end
 
-      if (@quantised < 0) and fraction.zero?
+      if (@quantised < 0) and frac.zero?
         ret_bin_int = (@format.max_int_unsigned + to_i + 1 )
-        frac_value  = fraction
+        frac_value  = frac
       end
 
       if @quantised >= 0
         ret_bin_int = self.to_i
-        frac_value  = fraction
+        frac_value  = frac
       end
 
       ## Convert to binary String and extend to correct length
@@ -118,6 +116,9 @@ module FixedPoint
       return binary_string
     end 
 
+    ####################################
+    ### Calculate Hexadecimal format
+    ####################################
     def hexadecimal
       #Clean Binary code (remove _ - . etc)
       clean_binary = to_b.scan(/[01]/).join('')
@@ -185,8 +186,10 @@ module FixedPoint
       end
     end
 
-    #def hex=( text )
-    #end
+    def hex=( text )
+      puts "hex = Mehtod not completed"
+      ## Strip leading 0x if present
+    end
 
 
     #TODO

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fixed_point
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Morgan Prior
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-21 00:00:00 +00:00
+date: 2012-01-22 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +32,7 @@ files:
 - README.md
 - HISTORY.md
 - Rakefile
+- examples/table_generation.rb
 - lib/fixed_point/fixdt.rb
 - lib/fixed_point/format.rb
 - lib/fixed_point/number.rb