phys-units 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0ec7810800a733cda3aa7f753bf10d11b76891d
-  data.tar.gz: b2c93b618d876183ea89ebfab9e6f353a6160746
+  metadata.gz: 08a3f10419f3f682ae605f4cc4995f0d99605354
+  data.tar.gz: d947bfc917e8484eeb87fc178f315b1e0982331c
 SHA512:
-  metadata.gz: b0b1ea5529d3017813abe2c056b8eda47db00f47dd3cf0405fd0551182f551bdd95493352ea0ff8ecce1091e5269a593411c09d1caa705514d9c39520e8d54b5
-  data.tar.gz: 7d4bdf5a200c37d8d9cd7b0416bbaa7812a988905b358ea93e88dd635f056226305a6c57bbae0bfe27c48ef7ed9080a64ca91a28fcabc9b66675b4ab082443fd
+  metadata.gz: ef99074dc223bb887a79162e0928181eda392b87a1fae825c8a09691aca17083417125a9dee1548058b917f41344742ac7366f3dd1cc867cb37bff3a9eab9d86
+  data.tar.gz: e8a23b4054cee7acfd274d274272ddda9cb2975efc316083030afffeb52c1debf1d86ec51b076231054d7bab85b17e813e9ce762dbb79ae055b91725c548ac10

data/README.md

@@ -18,6 +18,10 @@ Or install from source tree:
 
     $ ruby setup.rb
 
+Load Phys-Units library in your Ruby script:
+
+      require 'phys/units'
+
 ## Overview
 
 ### Phys::Quantity
@@ -25,15 +29,16 @@ is the primary class of Phys-Units library, intended to be manipulated by users.
 This class represents Physical Quantities with a Unit of measurement.
 It contains *Value* and *Unit*.
 
-* *Value*
-  must be a class instance having arithmetic methods,
+* *Value* of the quantity is given as the first parameter of
+  Quantity constructor (alias is `Quantity[]`).
+  It must be a class instance having arithmetic methods,
   but it is not necessary to be a Numeric.
   This is a duck typing way.
 
         Phys::Quantity[2.5,"miles"].value  #=> 2.5
 
-* *Unit*
-  is an instance of Phys::Unit class obtained by parsing *expr* string.
+* *Unit* is an instance of Phys::Unit class.
+  It is created from the second argument of Quantity constructor.
 
         Phys::Quantity[2.5,"miles"].unit   #=> #<Phys::Unit 1609.344,{"m"=>1},@expr="5280 ft">
 
@@ -62,7 +67,7 @@ It has *Factor* and *Dimension*:
     Q[123,'mile'] / Q[2,'hr']     #=> Phys::Quantity[61,'mile/hr']
     Q[61,'miles/hr'].want('m/s')  #=> Phys::Quantity[27.26944,'m/s']
     Q[1.0,'are'] == Q[10,'m']**2  #=> true
-    Q[70,'tempF'] + Q[10,'tempC'] #=> Phys::Quantity[88,'tempF']
+    Q[70,'tempF'] + Q[10,'degC']  #=> Phys::Quantity[88,'tempF']
     Q[20,'tempC'].want('tempF')   #=> Phys::Quantity[68,'tempF']
     Math.cos(Q[60,'degree'].to_f) #=> 0.5
 
@@ -84,7 +89,7 @@ It has *Factor* and *Dimension*:
 Phys-Units library is differentiated from many other units libraries for Ruby,
 by the following features:
 
-* Compatible with GNU Units except nonlinear units.
+* Compatible with GNU Units except currency and nonlinear units.
 * Provides 2331 units, 85 prefixes, including UTF-8 unit names.
 * Defines Units by reading GNU Units text data
   (see [load_units.rb](https://github.com/masa16/phys-units/blob/master/lib/phys/units/load_units.rb)),
@@ -127,6 +132,8 @@ Caution: The use of Mix-in may cause conflicts with other library.
 ## Platforms tested
 
 * ruby 2.0.0p0 (2013-02-24 revision 39474) [x86_64-linux]
+* ruby 1.9.3p392 (2013-02-22 revision 39386) [x86_64-linux]
+* ruby 1.8.7 (2012-10-12 patchlevel 371) [x86_64-linux]
 
 ## Copying License
 

data/lib/phys/units/parse.rb

@@ -677,7 +677,7 @@ Racc_debug_parser = false
 
 module_eval(<<'.,.,', 'parse.y', 23)
   def _reduce_2(val, _values, result)
-     result = Unit.inverse(val[1]) 
+     result = Unit.cast(val[1]).inverse 
     result
   end
 .,.,

data/lib/phys/units/parse.y

@@ -21,7 +21,7 @@ class Parse
 rule
 
  target:  expr
-       |  DIV list { result = Unit.inverse(val[1]) }
+       |  DIV list { result = Unit.cast(val[1]).inverse }
        ;
 
  expr: list

data/lib/phys/units/quantity.rb

@@ -18,16 +18,17 @@ module Phys
   # intended to be manipulated by users.
   # This class represents Physical Quantities with a Unit of measurement.
   # It contains *Value* and *Unit*.
-  # * *Value* of the quantity
-  #   must be an instance having arithmetic methods,
+  # * *Value* of the quantity is given as the first parameter of
+  #   Quantity constructor (alias is +Quantity[]+).
+  #   It must be a class instance having arithmetic methods,
   #   but it is not necessary to be a Numeric.
   #   This is a duck typing way.
   #        Phys::Quantity[2.5,"miles"].value    #=> 2.5
   #        Phys::Quantity[NArray.float(5).indgen,"miles"].want("m").value
   #        #=> NArray.float(5):
   #            [ 0.0, 1609.34, 3218.69, 4828.03, 6437.38 ]
-  # * *Unit*
-  #   is an instance of Phys::Unit class obtained by parsing *expr* string.
+  # * *Unit* is an instance of Phys::Unit class.
+  #   It is created from the second argument of Quantity constructor.
   #   see document of Phys::Unit.
   #        Phys::Quantity[2.5,"miles"].unit #=> #<Phys::Unit 1609.344,{"m"=>1},@expr="5280 ft">
   #
@@ -39,7 +40,7 @@ module Phys
   #   Q[123,'mile'] / Q[2,'hr']     #=> Phys::Quantity[61,'mile/hr']
   #   Q[61,'miles/hr'].want('m/s')  #=> Phys::Quantity[27.26944,'m/s']
   #   Q[1.0,'are'] == Q[10,'m']**2  #=> true
-  #   Q[70,'tempF'] + Q[10,'tempC'] #=> Phys::Quantity[88,'tempF']
+  #   Q[70,'tempF'] + Q[10,'degC']  #=> Phys::Quantity[88,'tempF']
   #   Q[20,'tempC'].want('tempF')   #=> Phys::Quantity[68,'tempF']
   #   Math.cos(Q[60,'degree'].to_f) #=> 0.5
   #
@@ -51,31 +52,29 @@ module Phys
 
     class << self
       # Alias to Phys::Quantity.new.
-      #   @param [Object]      value  Value of quantity.
-      #   @param [String,Symbol] expr  Unit string to be parsed later.
-      # @overload initialize(value,unit)
-      #   @param [Object]      value  Value of quantity.
-      #   @param [Phys::Unit]  unit   This unit is copyed if exists.
-      # @overload initialize(value)
-      #   @param [Object]      value  Value of dimensionless quantity.
+      # @param [Object]  value  Value of quantity.
+      # @param [String,Symbol,Phys::Unit]  unit
+      #  * If +unit+ String or Symbol, it is regarded as a unit expression (to be parsed later).
+      #  * If +unit+ is Phys::Unit, it is used as the unit of new quantity.
+      #  * If +unit+ is not provided, the quantity is regarded as dimensionless.
       # @return [Phys::Quantity]
       # @raise [TypeError] if invalid arg types.
       # @raise [Phys::UnitError] if unit conversion is failed.
-      def [](value,expr=nil)
-        self.new(value,expr)
+      def [](value,unit=nil)
+        self.new(value,unit)
       end
     end
 
     # Initialize a new quantity.
     # @overload initialize(value,expr,unit=nil)
     #   @param [Object]     value  Value of quantity.
-    #   @param [String,Symbol] expr  Unit string to be parsed later.
-    #   @param [Phys::Unit] unit   This unit is copyed if exists.
+    #   @param [String,Symbol] expr  Unit expression.
+    #   @param [Phys::Unit] unit   If exists, this parameter is used as the unit of new quantity.
     # @overload initialize(value,unit)
     #   @param [Object]     value  Value of quantity.
-    #   @param [Phys::Unit] unit   This unit is copyed if exists.
+    #   @param [Phys::Unit] unit   This parameter is used as the unit of new quantity.
     # @overload initialize(value)
-    #   @param [Object]     value  Value of dimensionless quantity.
+    #   @param [Object]     value  Value of a dimensionless quantity.
     # @raise [TypeError] if invalid arg types.
     # @raise [Phys::UnitError] if unit conversion is failed.
     #
@@ -291,8 +290,8 @@ module Phys
       @value > @unit.convert(other)
     end
 
-    # Closeness. Returns +true+ if difference between +self+ and +other+ is
-    # smaller than +epsilon+ times sum of their absolute values.
+    # Closeness. Returns +true+ if
+    #   (self-other).abs <= (self.abs+other.abs) * epsilon
     # Before the comparison, it converts +other+ to the unit of +self+.
     # @param  [Phys::Quantity] other
     # @param  [Numeric] epsilon
@@ -301,7 +300,7 @@ module Phys
     def close_to(other,epsilon=Float::EPSILON)
       other_value = @unit.convert(other)
       abs_sum = @value.abs+other_value.abs
-      abs_sum==0 || (@value-other_value).abs/abs_sum <= epsilon
+      (@value-other_value).abs <= abs_sum*epsilon
     end
 
     # Exponentiation.
@@ -365,6 +364,9 @@ module Phys
     # If the +other+ param is *not* Phys::Quantity,
     # +other+ is regarded as a dimensionless value.
     # The values and units are divided respectively.
+    # Note that the method of the value's class is used.
+    # @example
+    #   Phys::Quantity[3,:m]/2 #=> Phys::Quantity[1,"m"]
     # @param  [Object] other
     # @return [Phys::Quantity] a quantity
     # @raise  [Phys::UnitError] if unit is not operable.
@@ -555,7 +557,7 @@ module Phys
       self.class.to_s+"["+Unit::Utils.num_inspect(@value)+expr+"]"+sufx
     end
 
-    # Comformability of quantity. Returns true if unit conversion between +self+ and +x+ is possible.
+    # Conformability of quantity. Returns true if unit conversion between +self+ and +x+ is possible.
     # @param [Object] x  other object (Unit or Quantity or Numeric or something else)
     # @return [Boolean]
     def ===(x)

data/lib/phys/units/unit.rb

@@ -43,12 +43,13 @@ module Phys
   #
   class Unit
 
-    # @visibility private
+    # Hash table of registered units.
     LIST = {}
-    # @visibility private
+    # Hash table of registered prefixes.
     PREFIX = {}
 
-    # @visibility private
+    # Regex for registered prefixes.
+    # @return [Regexp]
     def self.prefix_regex
       @@prefix_regex
     end
@@ -58,11 +59,12 @@ module Phys
     #   @param [Numeric] factor  Unit scale factor.
     #   @param [Hash] dimension  Dimension hash.
     # @overload initialize(expr,name=nil)
-    #   @param [String] expr  Unit string to be parsed later.
-    #   @param [String] name  Name of this unit.
+    #   @param [String] expr  Expression of the unit. It is parsed lazily, i.e.,
+    #     parsed not when this instance is created, but when @factor and @dim is used.
+    #   @param [String] name  Name of the unit.
     # @overload initialize(unit,name=nil)
-    #   @param [Phys::Unit] unit  Copy contents from the argument.
-    #   @param [String] name  Name of this unit.
+    #   @param [Phys::Unit] unit  Its contents is used for new unit.
+    #   @param [String] name  Name of the unit.
     # @raise  [TypeError] if invalid arg types.
     #
     def initialize(a1,a2=nil)
@@ -83,7 +85,7 @@ module Phys
       end
     end
 
-    # Unit expression to be parsed.
+    # Expression of the unit.
     # @return [String, NilClass]
     attr_reader :expr
 
@@ -199,6 +201,12 @@ module Phys
     end
     alias string_form unit_string
 
+    # Returns self name or unit_string
+    # @return [String]
+    def to_s
+      @name || unit_string
+    end
+
     # Conversion Factor to base unit, including dimension-value.
     # @return [Numeric]
     # @example
@@ -221,7 +229,7 @@ module Phys
     end
 
     # Returns true if scalar unit.
-    # *Scalar* means the unit does not have any dimension
+    # *Scalar* means this unit does not have any dimension
     # including dimensionless-units, and its factor is one.
     # @return [Boolean]
     def scalar?
@@ -306,7 +314,13 @@ module Phys
     # @return [Phys::Quantity]
     # @raise [UnitError] if unit conversion is failed.
     def convert_scale(quantity)
-      convert(quantity)
+      if Quantity===quantity
+        assert_same_dimension(quantity.unit)
+        v = quantity.value * quantity.unit.conversion_factor
+        v = v / self.conversion_factor
+      else
+        quantity / to_numeric
+      end
     end
 
     # Convert from a value in this unit to a value in base unit.
@@ -459,7 +473,7 @@ module Phys
       if scalar?
         return x
       elsif x.scalar?
-        return self
+        return self.dup
       end
       check_operable2(x)
       dims = dimension_binop(x){|a,b| a+b}
@@ -477,7 +491,7 @@ module Phys
       if scalar?
         return x.inverse
       elsif x.scalar?
-        return self
+        return self.dup
       end
       check_operable2(x)
       dims = dimension_binop(x){|a,b| a-b}
@@ -496,11 +510,6 @@ module Phys
       Unit.new(Rational(1,self.factor), dims)
     end
 
-    # @visibility private
-    def self.inverse(x)
-      Unit.cast(x).inverse
-    end
-
     # Exponentiation of units.
     # This units must be operable.
     # @param  [Numeric] x  numeric
@@ -515,8 +524,11 @@ module Phys
 
     # @visibility private
     def self.func(fn, x)
-      fn = 'log' if fn == 'ln'
       m = Unit.new(x).to_numeric
+      if fn == 'log2' && RUBY_VERSION<'1.9.0'
+        return Unit.new( Math.log(m)/Math.log(2) )
+      end
+      fn = 'log' if fn == 'ln'
       Unit.new( Math.send(fn,m) )
     end
 
@@ -547,7 +559,7 @@ module Phys
 
   # BaseUnit is a class to represent units defined by "!"
   # in the data form of GNU units.
-  # It includes SI units and dimensinless units such as radian.
+  # It includes SI units and dimensionless units such as radian.
   class BaseUnit < Unit
 
     def self.define(name,expr,dimval=nil)
@@ -601,7 +613,19 @@ module Phys
 
 
   # OffsetUnit is a class to represent units with offset value.
-  # Allows Farenheight/Celsius temperature.
+  # Allows Fahrenheit/Celsius temperature.
+  # Unit operations are not allowed.
+  # @example
+  #  require 'phys/units'
+  #
+  #  Phys::Quantity[20,:tempC].want(:tempF)                #=> Phys::Quantity[68,'tempF']
+  #  Phys::Quantity[3,:tempC] + Phys::Quantity[10,:degF]   #=> Phys::Quantity[(77/9),"tempC"]
+  #  Phys::Quantity[3,:tempC] * Phys::Quantity[3,:m]       #=> UnitError
+  #  Phys::Quantity[3,:tempC] ** 2                         #=> UnitError
+  #
+  #  # Next examples currently work, but I suggest the use of degC and degF.
+  #  Phys::Quantity[3,:tempC] + Phys::Quantity[10,:tempF]  #=> Phys::Quantity[(77/9),"tempC"]
+  #  Phys::Quantity[3,:tempC] * 2                          #=> Phys::Quantity[6,"tempC"]
   class OffsetUnit < Unit
 
     def self.define(name,unit,offset=nil)
@@ -616,20 +640,6 @@ module Phys
       @offset = offset
     end
 
-    # Convert a quantity to this unit only in scale.
-    # @param [Phys::Quantity] quantity to be converted.
-    # @return [Phys::Quantity]
-    # @raise [UnitError] if unit conversion is failed.
-    def convert_scale(quantity)
-      if Quantity===quantity
-        assert_same_dimension(quantity.unit)
-        v = quantity.value * quantity.unit.conversion_factor
-        v = v / self.conversion_factor
-      else
-        raise UnitError,"not Quantity: #{quantity.inspect}"
-      end
-    end
-
     # Convert from a value in this unit to a value in base unit.
     # @param [Numeric] value
     # @return [Numeric]
@@ -644,6 +654,7 @@ module Phys
       (value - @offset) / conversion_factor
     end
 
+    # Returns false
     def operable?
       false
     end

data/lib/phys/units/unit_class.rb

@@ -18,9 +18,11 @@ module Phys
         false
       end
 
-      # Define a new Unit. Expression is not parsed at the time of this method.
-      # @param [String,Symbol] name Name of this unit.
-      # @param [String] expr Expression.
+      # Define a new Unit. Expression is parsed lazily, i.e., parsed
+      # not when this method is called, but when @factor and @dim is used.
+      # Note that the result of unit calculation depends on the timing of unit definition.
+      # @param [String,Symbol] name  Name of the unit.
+      # @param [String] expr  Expression of the unit.
       def define(name,expr)
         case name
         when String
@@ -49,8 +51,9 @@ module Phys
 
 
       # Force the argument to be Phys::Unit.
-      # @param [Phys::Unit,Numeric]
+      # @param [Object] x
       # @return [Phys::Unit]
+      # @raise  [TypeError] if invalid type for units.
       def cast(x)
         case x
         when Unit

data/lib/phys/units/units_mixin.rb

@@ -14,6 +14,8 @@ module Phys
   # Defines method with unit name.
   # *Caution*: Variable names may conflict with unit names.
   # @example
+  #   require 'phys/units'
+  #
   #   Phys::UnitsMixin.module_eval do
   #     puts 123.4*km
   #     puts (23*mile/hr).want(m/s)
@@ -60,6 +62,8 @@ module Phys
   # ActiveSupport-like mix-in.
   # *Caution*: This kind of global change will cause unexpected problems.
   # @example
+  #   require 'phys/units'
+  #
   #   class Numeric
   #     include Phys::UnitsNumericMixin
   #   end

data/lib/phys/units/version.rb

@@ -1,5 +1,5 @@
 module Phys
   class Unit
-    VERSION = "0.9.4"
+    VERSION = "0.9.5"
   end
 end

data/lib/phys/units.rb

@@ -1,3 +1,6 @@
+if RUBY_VERSION<'1.9.0'
+  require "rational"
+end
 require "phys/units/version"
 require "phys/units/errors.rb"
 require "phys/units/unit_class.rb"

data/misc/misc_units.dat

@@ -0,0 +1,7 @@
+# http://www.tokyo-dome.co.jp/dome/facilities/
+tokyodome_area          46755 m^2
+tokyodome_volume        1240000 m^3
+
+# http://www.tokyo-skytree.jp/archive/spec/
+skytree_height          634 m
+skytree                 skytree_height

data/misc/mkunitspec.rb

@@ -8,6 +8,7 @@ def close_values(a,b)
 end
 
 puts <<EOL
+# -*- coding: utf-8 -*-
 $LOAD_PATH.unshift File.dirname(__FILE__)
 require "helper"
 

data/spec/all_units_spec.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 $LOAD_PATH.unshift File.dirname(__FILE__)
 require "helper"
 

data/spec/quantity_spec.rb

@@ -126,10 +126,10 @@ describe "Phys::Quantity" do
   end
 
   context "Temperature" do
-    describe Q[1,"tempC"] - Q[1,"tempC"] do
+    describe Q[1,"tempC"] - Q[1,"degC"] do
       it {should == Q[0,"tempC"]}
     end
-    describe Q[50,"tempF"] + Q[10,"tempC"] do
+    describe Q[50,"tempF"] + Q[10,"degC"] do
       it {should == Q[68,"tempF"]}
     end
     describe Q[0,"tempC"].want("tempF") do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phys-units
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Masahiro TANAKA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-05 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,6 +65,7 @@ files:
 - lib/phys/units/units_mixin.rb
 - lib/phys/units/utils.rb
 - lib/phys/units/version.rb
+- misc/misc_units.dat
 - misc/mkjpspec.rb
 - misc/mkunitspec.rb
 - misc/readme.jp.md