ruby-units 0.3.9 → 1.0.0

data/CHANGELOG.txt

@@ -156,4 +156,14 @@ Change Log for Ruby-units
 2006-12-15  0.3.8   * Any object that supports a 'to_unit' method will now be 
                       automatically coerced to a unit during math operations.
                       
-2006-12-15  0.3.9   * forgot to increment the version in the gem file..ooops.                      
+2006-12-15  0.3.9   * forgot to increment the version in the gem file..ooops.
+
+2007-01-12  1.0.0   * Improved handling of complex numbers.  Now you can specify
+                      '1+1i mm'.unit to get a complex unit.
+                    * Taking the root of a negative unit will give you a complex unit
+                    * fixed unary minus to work again
+                    * Math.hypot now takes units.  Both parameters must be the compatible 
+                      units or it will assert.  Units will be converted to a common base 
+                      before use.
+                    * Can now specify units in rational numbers, i.e., '1/4 cup'.unit  
+                    * Seems like a good time to move to 1.0 status

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2006 Kevin C. Olbrich
+Copyright (c) 2006-2007 Kevin C. Olbrich
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.txt

@@ -1,6 +1,6 @@
 =Ruby Units
 
-Version: 0.3.9
+Version: 1.0.0
 
 Kevin C. Olbrich, Ph.D. 
 kevin.olbrich@gmail.com
@@ -10,10 +10,14 @@ http://www.sciwerks.com
 Project page: http://rubyforge.org/projects/ruby-units
 
 ==Introduction
-Many technical applications make use of specialized calculations at some point.  Frequently, these calculations require unit conversions to ensure accurate results.  Needless to say, this is a pain to properly keep track of, and is prone to numerous errors.
+Many technical applications make use of specialized calculations at some point.  
+Frequently, these calculations require unit conversions to ensure accurate results.  
+Needless to say, this is a pain to properly keep track of, and is prone to numerous errors.
   
 ==Solution
-The 'Ruby units' gem is designed so simplify the handling of units for scientific calculations.  The units of each quantity are specified when a Unit object is created and the Unit class will handle all subsequent conversions and manipulations to ensure an accurate result.
+The 'Ruby units' gem is designed so simplify the handling of units for scientific calculations. 
+The units of each quantity are specified when a Unit object is created and the Unit class will 
+handle all subsequent conversions and manipulations to ensure an accurate result.
   
 ==Installation:
 This package may be installed using:
@@ -34,7 +38,8 @@ This package may be installed using:
  unit = u'1 mm'
  unit = '1 mm'.unit
  unit = '1 mm'.u
- 
+ unit = '1/4 cup'.unit            # Rational number 
+ unit = '1+1i mm'.unit            # Complex Number
 
 ==Rules:  
 1. only 1 quantity per unit (with 2 exceptions... 6'5" and '8 lbs 8 oz')
@@ -131,5 +136,6 @@ If only one ":" is present, it is interpreted as the separator between hours and
 works so long as the starting point has an integer scalar
 
 ==Math functions
-All Trig math functions (sin, cos, sinh, ...) can take a unit as their parameter.  It will be converted to radians and then used if possible.
+All Trig math functions (sin, cos, sinh, hypot...) can take a unit as their parameter.  
+It will be converted to radians and then used if possible.
 

data/lib/ruby-units.rb

@@ -2,7 +2,7 @@ require 'mathn'
 require 'rational'
 require 'date'
 require 'parsedate'
-# = Ruby Units 0.3.9
+# = Ruby Units 1.0.0
 #
 # Copyright 2006 by Kevin C. Olbrich, Ph.D.
 # 
@@ -40,7 +40,7 @@ require 'parsedate'
 class Unit < Numeric
   require 'units'
   # pre-generate hashes from unit definitions for performance.  
-  VERSION = '0.3.9'
+  VERSION = '1.0.0'
   @@USER_DEFINITIONS = {}
   @@PREFIX_VALUES = {}
   @@PREFIX_MAP = {}
@@ -54,11 +54,15 @@ class Unit < Numeric
   TIME_REGEX = /(\d+)*:(\d+)*:*(\d+)*[:,]*(\d+)*/
   LBS_OZ_REGEX = /(\d+)\s*(?:#|lbs|pounds)+[\s,]*(\d+)\s*(?:oz|ounces)/
   SCI_NUMBER = %r{([+-]?\d*[.]?\d+(?:[Ee][+-]?)?\d*)}
+  RATIONAL_NUMBER = /(\d+)\/(\d+)/
+  COMPLEX_NUMBER = /#{SCI_NUMBER}?#{SCI_NUMBER}i\b/
   NUMBER_REGEX = /#{SCI_NUMBER}*\s*(.+)?/
   UNIT_STRING_REGEX = /#{SCI_NUMBER}*\s*([^\/]*)\/*(.+)*/
   TOP_REGEX = /([^ \*]+)(?:\^|\*\*)([\d-]+)/
   BOTTOM_REGEX = /([^* ]+)(?:\^|\*\*)(\d+)/
-  
+  UNCERTAIN_REGEX = /#{SCI_NUMBER}\s*\+\/-\s*#{SCI_NUMBER}\s(.+)/
+  COMPLEX_REGEX = /#{COMPLEX_NUMBER}\s?(.+)?/
+  RATIONAL_REGEX = /#{RATIONAL_NUMBER}\s?(.+)?/
   KELVIN = ['<kelvin>']
   FARENHEIT = ['<farenheit>']
   RANKINE = ['<rankine>']
@@ -188,7 +192,7 @@ class Unit < Numeric
         cached = @@cached_units[options[1]] * options[0] 
         copy(cached)
       rescue 
-        initialize("#{options[0]} #{options[1]}")
+        initialize("#{options[0]} #{(options[1].units rescue options[1])}")
       end
       return
     end
@@ -233,7 +237,7 @@ class Unit < Numeric
 
     unary_unit = self.units || ""
     opt_units = options[0].scan(NUMBER_REGEX)[0][1] if String === options[0]
-    unless @@cached_units.keys.include?(opt_units) || (opt_units =~ /(temp|deg(C|K|R|F))|(pounds|lbs[ ,]\d+ ounces|oz)|('\d+")|(ft|feet[ ,]\d+ in|inch|inches)|%|(#{TIME_REGEX})/)
+    unless @@cached_units.keys.include?(opt_units) || (opt_units =~ /(temp|deg(C|K|R|F))|(pounds|lbs[ ,]\d+ ounces|oz)|('\d+")|(ft|feet[ ,]\d+ in|inch|inches)|%|(#{TIME_REGEX})|i\s?(.+)?/)
       @@cached_units[opt_units] = (self.scalar == 1 ? self : opt_units.unit) if opt_units && !opt_units.empty?
     end
     unless @@cached_units.keys.include?(unary_unit) || (unary_unit =~ /(temp|deg)(C|K|R|F)/) then
@@ -345,7 +349,12 @@ class Unit < Numeric
           out = (Time.gm(0) + self).strftime(target_units)
         end
       else
-        out = "#{'%g' % @scalar} #{self.units}".strip
+        out = case @scalar
+        when Rational : 
+          "#{@scalar} #{self.units}"
+        else
+          "#{'%g' % @scalar} #{self.units}"
+        end.strip
       end
       @output = {target_units => out}
       return out
@@ -511,6 +520,13 @@ class Unit < Numeric
     end
   end
   
+  def real
+    return Unit.new(self.scalar.real,self.units)
+  end
+  
+  def imag
+    return Unit.new(self.scalar.imag, self.units)
+  end
 
   # returns the unit raised to the n-th power.  Integers only
   def power(n)
@@ -550,7 +566,7 @@ class Unit < Numeric
       r = ((x/n)*(n-1)).to_int
       r.times {|x| den.delete_at(den.index(item))}
     end
-    q = @scalar**(1/n)    
+    q = @scalar < 0 ? (-1)**Rational(1,n) * (@scalar.abs)**Rational(1,n) : @scalar**Rational(1,n)
     Unit.new(:scalar=>q,:numerator=>num,:denominator=>den)    
   end
   
@@ -643,7 +659,14 @@ class Unit < Numeric
   # converts the unit back to a float if it is unitless.  Otherwise raises an exception
   def to_f
     return @scalar.to_f if self.unitless?
-    raise RuntimeError, "Can't convert to float unless unitless.  Use Unit#scalar"
+    raise RuntimeError, "Can't convert to Float unless unitless.  Use Unit#scalar"
+  end
+  
+  # converts the unit back to a complex if it is unitless.  Otherwise raises an exception
+  
+  def to_c
+    return Complex(@scalar) if self.unitless?
+    raise RuntimeError, "Can't convert to Complex unless unitless.  Use Unit#scalar"
   end
   
   # returns the 'unit' part of the Unit object without the scalar
@@ -688,7 +711,8 @@ class Unit < Numeric
   # negates the scalar of the Unit
   def -@
     return -@scalar if self.unitless?
-    Unit.new(-@scalar,@numerator,@denominator)    
+    #Unit.new(-@scalar,@numerator,@denominator)    
+    -1 * self.dup
   end
   
   # returns abs of scalar, without the units
@@ -707,17 +731,17 @@ class Unit < Numeric
   end
 
   # if unitless, returns an int, otherwise raises an error
-  def to_int
+  def to_i
     return @scalar.to_int if self.unitless?
-    raise RuntimeError, 'Cannot convert to Integer, use Unit#scalar'
+    raise RuntimeError, 'Cannot convert to Integer unless unitless'
   end
+  alias :to_int :to_i
   
   # Tries to make a Time object from current unit.  Assumes the current unit hold the duration in seconds from the epoch.
   def to_time
     Time.at(self)
   end
   alias :time :to_time
-  alias :to_i :to_int
 
   def truncate
     return @scalar.truncate if self.unitless?
@@ -955,11 +979,32 @@ class Unit < Numeric
       unit_string = "#{$1} USD"
     end
     
+
     unit_string.gsub!(/%/,'percent')
     unit_string.gsub!(/'/,'feet')
     unit_string.gsub!(/"/,'inch')
     unit_string.gsub!(/#/,'pound')
-
+    if defined?(Uncertain) && unit_string =~ /(\+\/-|&plusmn;)/
+      value, uncertainty, unit_s = unit_string.scan(UNCERTAIN_REGEX)[0]
+      result = unit_s.unit * Uncertain(value.to_f,uncertainty.to_f)
+      copy(result)
+      return  
+    end
+    
+    if defined?(Complex) && unit_string =~ COMPLEX_NUMBER
+      real, imaginary, unit_s = unit_string.scan(COMPLEX_REGEX)[0]
+      result = Unit(unit_s || '1') * Complex(real.to_f,imaginary.to_f)
+      copy(result)
+      return 
+    end
+    
+    if defined?(Rational) && unit_string =~ RATIONAL_NUMBER
+        numerator, denominator, unit_s = unit_string.scan(RATIONAL_REGEX)[0]
+        result = Unit(unit_s || '1') * Rational(numerator.to_i,denominator.to_i)
+        copy(result)
+        return 
+    end
+    
     unit_string =~ NUMBER_REGEX
     unit = @@cached_units[$2] 
     mult = ($1.empty? ? 1.0 : $1.to_f) rescue 1.0
@@ -1212,7 +1257,11 @@ class String
 end
 
 
-# Allow time objects to use 
+#
+# Time math is handled slightly differently.  The difference is considered to be an exact duration if
+# the subtracted value is in hours, minutes, or seconds.  It is rounded to the nearest day if the offset
+# is in years, decades, or centuries.  This leads to less precise values, but ones that match the 
+# calendar better.
 class Time
   
   class << self
@@ -1263,6 +1312,7 @@ class Time
   end
   
   alias :unit_sub :-
+  
   def -(other)
     case other
     when Unit: 
@@ -1280,61 +1330,70 @@ class Time
   end
 end
 
+# Math will convert unit objects to radians and then attempt to use the value for 
+# trigonometric functions.  
 module Math
+  alias unit_sqrt sqrt
+  def sqrt(n)
+    Unit === n ? n**(1/2) : unit_sqrt(n)
+  end
+  
   alias unit_sin sin
-   def sin(n)
-     if Unit === n
-       unit_sin(n.to('radian').scalar)
-     else
-       unit_sin(n)
-     end
-   end
+  def sin(n)
+   Unit === n ? unit_sin(n.to('radian').scalar) : unit_sin(n)
+  end
 
-   alias unit_cos cos
-    def cos(n)
-      if Unit === n
-        unit_cos(n.to('radian').scalar)
-      else
-        unit_cos(n)
-      end
-    end
+  alias unit_cos cos
+  def cos(n)
+    Unit === n ? unit_cos(n.to('radian').scalar) : unit_cos(n)
+  end
     
-    alias unit_sinh sinh
-     def sinh(n)
-       if Unit === n
-         unit_sinh(n.to('radian').scalar)
-       else
-         unit_sinh(n)
-       end
-     end
+  alias unit_sinh sinh
+  def sinh(n)
+    Unit === n ? unit_sinh(n.to('radian').scalar) : unit_sinh(n)
+  end
 
-     alias unit_cosh cosh
-      def cosh(n)
-        if Unit === n
-          unit_cosh(n.to('radian').scalar)
-        else
-          unit_cosh(n)
-        end
-      end
+  alias unit_cosh cosh
+  def cosh(n)
+    Unit === n ? unit_cosh(n.to('radian').scalar) : unit_cosh(n)
+  end
 
-      alias unit_tan tan
-       def tan(n)
-         if Unit === n
-           unit_tan(n.to('radian').scalar)
-         else
-           unit_tan(n)
-         end
-       end
+  alias unit_tan tan
+  def tan(n)
+   Unit === n ? unit_tan(n.to('radian').scalar) : unit_tan(n)
+  end
 
-       alias unit_tanh tanh
-        def tanh(n)
-          if Unit === n
-            unit_tanh(n.to('radian').scalar)
-          else
-            unit_tanh(n)
-          end
-        end
+  alias unit_tanh tanh
+  def tanh(n)
+    Unit === n ? unit_tanh(n.to('radian').scalar) : unit_tanh(n)
+  end
 
+  alias unit_hypot hypot
+  # Convert parameters to consistent units and perform the function
+  def hypot(x,y)
+    if Unit === x && Unit === y
+      (x**2 + y**2)**(1/2)
+    else
+      unit_hypot(x,y)
+    end
+  end
+  
+  alias unit_atan2 atan2
+  def atan2(x,y)
+    case
+    when (Unit === x && Unit === y) && (x !~ y)
+      raise ArgumentError, "Incompatible Units"
+    when (Unit === x && Unit === y) && (x =~ y)
+      unit_atan2(x.base_scalar, y.base_scalar)
+    else
+      unit_atan2(x,y)
+    end
+  end
+
+   module_function :unit_hypot
+   module_function :hypot
+   module_function :unit_sqrt
+   module_function :sqrt
    module_function :unit_sin
    module_function :sin
    module_function :unit_cos
@@ -1347,6 +1406,9 @@ module Math
    module_function :tan
    module_function :unit_tanh
    module_function :tanh
+   module_function :unit_atan2
+   module_function :atan2
+   
 end
 
 Unit.setup

data/test/test_ruby-units.rb

@@ -129,8 +129,8 @@ class TestRubyUnits < Test::Unit::TestCase
   end 
   
   def test_unary_minus
-    unit1 = Unit.new("1 mm")
-    unit2 = Unit.new("-1 mm")
+    unit1 = Unit.new("1 mm^2")
+    unit2 = Unit.new("-1 mm^2")
     assert_equal unit1, -unit2
   end
   
@@ -847,4 +847,43 @@ class TestRubyUnits < Test::Unit::TestCase
     b = '1 mm'.unit
     assert_equal '2 mm'.unit, b + a
   end
+  
+  def test_create_with_other_unit
+    a = '1 g'.unit
+    b = 0.unit(a)
+    assert_equal b, '0 g'.unit
+  end
+  
+  def test_sqrt
+    assert_equal '1 mm'.unit, Math.sqrt('1 mm^2'.unit)
+    assert_raises(ArgumentError) {Math.sqrt('1 mm'.unit)}
+    assert_equal Math.sqrt("-1 mm^2".unit), '0+1i mm'.unit
+  end
+  
+  def test_hypot
+    assert_equal Math.hypot('3 mm'.unit,'4 mm'.unit), '5 mm'.unit
+    assert_raises(ArgumentError) { Math.hypot('3 mm'.unit, '4 kg'.unit)}
+  end
+  
+  def test_complex
+    assert_equal '1+1i mm'.unit.scalar, Complex(1,1)
+    assert_equal '1+1i mm'.unit.real, '1 mm'.unit
+    assert_equal '1+1i mm'.unit.imag, '1i mm'.unit
+    assert_equal '1+1i'.unit, Complex(1,1)
+    assert_raises (RuntimeError) { '1+1i mm'.unit.to_c}
+  end
+
+  def test_atan2
+    assert_equal Math.atan2('1 mm'.unit,'1 mm'.unit), Math.atan2(1,1)
+    assert_raises (ArgumentError) {Math.atan2('1 mm'.unit, '1 lb'.unit)}
+    assert_raises (ArgumentError) {Math.atan2('1 mm'.unit, 1)}
+  end
+
+  def test_rational_units
+    assert_equal '1/4 cup'.unit, '0.25 cup'.unit
+    assert_equal '1/4 in/s'.unit, '0.25 in/s'.unit
+    assert_equal '1/4'.unit, 0.25
+  end
+
+
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ruby-units
 version: !ruby/object:Gem::Version 
-  version: 0.3.9
-date: 2006-12-15 00:00:00 -05:00
+  version: 1.0.0
+date: 2007-01-12 00:00:00 -05:00
 summary: A model that performs unit conversions and unit math
 require_paths: 
 - lib