phys-units 0.9.2 → 0.9.3

data/lib/phys/units/unit_class.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # phys/units/unit_class.rb
 #
@@ -14,11 +13,15 @@ module Phys
 
     class << self
 
+      # @visibility private
       def debug
         false
       end
 
-      def define(name,expr,v=nil)
+      # Define New Unit.  Expression is not parsed in this method.
+      # @param [String] name Name of this unit.
+      # @param [String] expr Expression.
+      def define(name,expr)
         if !(String===name)
           raise TypeError,"unit name should be string : #{name.inspect}"
         end
@@ -27,37 +30,47 @@ module Phys
           if PREFIX[name]
             warn "prefix definition is overwritten: #{name}" if debug
           end
-          PREFIX[name] = self.new(name,expr)
+          PREFIX[name] = self.new(expr,name)
         else
           if LIST[name]
             warn "unit definition is overwritten: #{name}" if debug
           end
           if expr.kind_of?(String) && /^!/ =~ expr
             dimless = (expr == "!dimensionless")
-            LIST[name] = BaseUnit.new(name,dimless,v)
+            LIST[name] = BaseUnit.new(name,dimless)
           else
-            LIST[name] = self.new(name,expr,v)
+            LIST[name] = self.new(expr,name)
           end
         end
       end
 
+
+      # Force argument to be Phys::Unit.
+      # @return [Phys::Unit]
       def cast(x)
         if x.kind_of?(Unit)
           x
         else
-          Unit.new(x) 
+          Unit.new(x)
         end
       end
 
+      # Used in Parser.
+      # @visibility private
       def word(x)
         find_unit(x) or raise UnitError, "Undefined unit: #{x.inspect}"
-        #find_unit(x) || define(x,nil)
       end
 
+      # Searches a registered unit and then Parse as a unit string
+      # if not registered.
+      # @return [Phys::Unit]
       def parse(x)
         find_unit(x) || Unit.cast(Parse.new.parse(x))
       end
+      alias [] parse
 
+      # Searches a registered unit.
+      # @return [Phys::Unit, NilClass]
       def find_unit(x)
         if Numeric===x
           Unit.new(x)
@@ -69,13 +82,13 @@ module Phys
         end
       end
 
-      alias [] find_unit
-
+      # @visibility private
       def unit_stem(x)
         ( /(.{2,}(?:s|z|ch))es$/ =~ x && LIST[$1] ) ||
           ( /(.{2,})s$/ =~ x && LIST[$1] )
       end
 
+      # @visibility private
       def find_prefix(x)
         Unit.prefix_regex =~ x
         pre,post = $1,$2
@@ -86,10 +99,12 @@ module Phys
 
 #--
 
-      def unit_chars
+      # @visibility private
+      def unit_exclude_chars
         '\\s*+\\/<=>()\\[\\]^{|}~\\\\'
       end
 
+      # @visibility private
       def control_units_dat(var,skip,line)
         case line
         when /!\s*end(\w+)/
@@ -114,7 +129,10 @@ module Phys
         #puts "skip=#{skip.inspect} var=#{var.inspect}"
       end
 
-      def import_units(data=nil,locale=nil)
+      # Import Units.dat from text.
+      # @param [String] data Text string of Units.dat.
+      # @param [String] locale (optional) Set "en_GB" for UK units.
+      def import_units(data,locale=nil)
         str = ""
         locale ||= ENV['LC_ALL'] || ENV['LANG']
         if /^(\w+)\./ =~ locale

data/lib/phys/units/utils.rb

@@ -9,6 +9,7 @@
 
 module Phys
   class Unit
+    # @visibility private
     module Utils
       module_function
 
@@ -75,12 +76,12 @@ module Phys
           end
           ud,nd = n_trail_zero(d)
           if nd > 3
-            return Rational(n,ud).inspect + 
+            return Rational(n,ud).inspect +
               ("*%.0e"%10**(-nd))
           end
           un,nn = n_trail_zero(n)
           if nn > 3
-            return Rational(un,d).inspect + 
+            return Rational(un,d).inspect +
               ("*%.0e"%10**(nn))
           end
         end

data/lib/phys/units/version.rb

@@ -1,5 +1,5 @@
 module Phys
   class Unit
-    VERSION = "0.9.2"
+    VERSION = "0.9.3"
   end
 end

data/misc/mkjpspec.rb

@@ -0,0 +1,149 @@
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)+"/../lib"
+require "phys/units/jp"
+
+def main
+  puts <<EOL
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require "phys/units/jp"
+require "helper"
+
+describe "Japanese Units" do
+EOL
+
+  $data.each_line do |line|
+    line.chomp!
+    if /([^#]*)\s*#?/ =~ line
+      line = $1
+    end
+    if /^([^\s()\[\]{}!*|\/^#]+)\s+([^#]+)/ =~ line
+      name,repr = $1,$2.strip
+      name =$1 if /(.*)-$/ =~ name
+      #u = Phys::Unit::LIST[name]
+      q = Phys::Quantity[1,name]
+      u = q.unit
+      #p [name,u,q]
+      f = "%.9g" % u.conversion_factor
+      s = u.base_unit.string_form
+      s2 = (s=='') ? "" : ",#{s.inspect}"
+      #p [name,name.size,f,s]
+      puts <<EOL
+  describe Q[1,#{name.inspect}] do
+    it {should be_a_quantity_close_to Q[#{f}#{s2}] }
+  end
+EOL
+    end
+  end
+
+  puts <<EOL
+end
+EOL
+end
+
+$data = <<EOL
+# Japanese Number units
+一-             1
+二-             2
+三-             3
+四-             4
+五-             5
+六-             6
+七-             7
+八-             8
+九-             9
+十-             10
+百-             10^2
+千-             10^3
+万-             10^4
+億-             10^8
+兆-             10^12
+京-             10^16
+垓-             10^20
+秭-             10^24
+秭-             10^24
+穰-             10^28
+溝-             10^32
+澗-             10^36
+正-             10^40
+載-             10^44
+極-             10^48
+恒河沙-         10^52
+阿僧祇-         10^56
+那由他-         10^60
+不可思議-       10^64
+無量大数-       10^68
+#
+割-             1|10
+分-             1|100
+厘-             1|1000
+釐-             1|1000
+毛-             1|10^4
+毫-             1|10^4
+糸-             1|10^4
+絲-             1|10^4
+忽-             1|10^5
+微-             1|10^6
+繊-             1|10^7
+沙-             1|10^8
+塵-             1|10^9
+埃-             1|10^10
+渺-             1|10^11
+漠-             1|10^12
+模糊-           1|10^13
+逡巡-           1|10^14
+須臾-           1|10^15
+瞬息-           1|10^16
+弾指-           1|10^17
+刹那-           1|10^18
+六徳-           1|10^19
+虚空-           1|10^20
+清浄-           1|10^21
+阿頼耶-         1|10^22
+阿摩羅-         1|10^23
+涅槃寂静-       1|10^24
+#
+# Traditional Japanese units (shakkanhou)
+#
+# Japanese Length Measures
+尺              shaku           # =10/33メートル≒0.303 0303メートル
+寸              1|10 尺
+里              36 町           # ≒3927.272 727メートル
+町              60 間           # ≒109.090 909メートル
+間              6 尺            # ≒1.818 182メートル
+丈              10 尺           # ≒3.030 303メートル
+曲尺            尺
+鯨尺            kujirajaku      # 10|8 shaku
+#
+# Japanese Area Measures
+坪              tsubo           # = 400/121平方メートル[3] ≒3.305 785平方メートル
+畝              30 坪           # ≒99.173 554平方メートル
+反              10 畝           # ≒991.7355平方メートル
+段              反              # ≒991.7355平方メートル
+#歩              坪
+#町              10 反          # ≒9917.355平方メートル
+#合              1|10 坪        # ≒0.330 5785平方メートル#
+#勺              1|100 坪       #
+#
+# Japanese architecture is based on a "standard" size of tatami mat.
+江戸間          edoma           # (5.8*2.9) shaku^2
+京間            kyouma          # (6.3*3.15) shaku^2
+中京間          chuukyouma      # (6*3) shaku^2
+畳              tatami
+#
+# Japanese Volume Measures
+升              shou            # 10合 = 2401/1331リットル ≒1.803 906 837リットル
+斗              10 升           # ≒ 18.039 068リットル
+石              10 斗           # ≒ 180.390 684リットル
+合              1|10 升         # 10勺 ≒0.180 390 684リットル
+勺              1|10 合
+#
+# Japanese Weight Measures
+貫              1000 匁         # = 100両 = 3.75キログラム
+斤              160 匁          # = 600グラム
+両              10 匁           # = 37.5グラム
+匁              momme           # = 3.75グラム
+#
+EOL
+
+main

data/misc/mkunitspec.rb

@@ -0,0 +1,60 @@
+$LOAD_PATH << "./lib"
+require 'phys/units'
+
+$debug=false
+
+def close_values(a,b)
+  (a-b).abs < (a.abs+b.abs)*3e-8
+end
+
+puts <<EOL
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require "helper"
+
+describe "Unit Conversion" do
+EOL
+
+keys = Phys::Unit::LIST.keys
+keys.each do |k,u|
+  puts k  if $debug
+  u = Phys::Unit::LIST[k]
+  f = u.conversion_factor
+  s = u.base_unit.string_form
+  #s = '1' if s==''
+  puts "#{k}, #{u.name}, #{u.string_form}, #{u.factor} base: #{f}, #{s}" if $debug
+  n = u.name
+  if /'/ =~ n
+    c = "units "#{n}" '#{s}'"
+    puts c if $debug
+    next
+  else
+    c = "units '#{n}' '#{s}'"
+  end
+  puts c if $debug
+  x = `#{c}`
+  puts x if $debug
+
+  if /\* ([\d.e+-]+)\s+\/ ([\d.e+-]+)/m =~ x
+    factor = $1
+    s2 = (s=='') ? "" : ",#{s.inspect}"
+    puts <<EOL
+  describe Q[1,#{n.inspect}] do
+    it {should be_a_quantity_close_to Q[#{factor}#{s2}] }
+  end
+EOL
+    factor = factor.to_f
+    puts "factor = #{factor} <=> f=#{f} => #{factor.to_f<=>f}" if $debug
+    if !close_values(factor, f)
+      puts "#{k}, #{u.name}, #{u.string_form}, #{u.factor} base: #{f}, #{s}"
+      puts c
+      puts x
+      puts "factor = #{factor} <=> f=#{f} => #{factor<=>f}"
+      puts "diff = #{(factor-f).abs/(factor.abs+f.abs)}"
+      puts "--"
+    end
+  end
+end
+
+puts <<EOL
+end
+EOL

data/misc/readme.jp.md

@@ -0,0 +1,6 @@
+    require 'phys/units/jp'
+    q = Phys::Quantity
+    q[1,"寸"].want("cm")    #=> Phys::Quantity[(1/0.33),"cm"]
+    q[1,"坪"].want("m^2")   #=> Phys::Quantity[(1/0.3025),"m^2"]
+    q[1,"升"].want("l")     #=> Phys::Quantity[(2401/1331),"l"]
+    q[1,"貫"].want("kg")    #=> Phys::Quantity[3.75,"kg"]

data/spec/jp_units_spec.rb

@@ -0,0 +1,256 @@
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require "phys/units/jp"
+require "helper"
+
+describe "Japanese Units" do
+  describe Q[1,"一"] do
+    it {should be_a_quantity_close_to Q[1] }
+  end
+  describe Q[1,"二"] do
+    it {should be_a_quantity_close_to Q[2] }
+  end
+  describe Q[1,"三"] do
+    it {should be_a_quantity_close_to Q[3] }
+  end
+  describe Q[1,"四"] do
+    it {should be_a_quantity_close_to Q[4] }
+  end
+  describe Q[1,"五"] do
+    it {should be_a_quantity_close_to Q[5] }
+  end
+  describe Q[1,"六"] do
+    it {should be_a_quantity_close_to Q[6] }
+  end
+  describe Q[1,"七"] do
+    it {should be_a_quantity_close_to Q[7] }
+  end
+  describe Q[1,"八"] do
+    it {should be_a_quantity_close_to Q[8] }
+  end
+  describe Q[1,"九"] do
+    it {should be_a_quantity_close_to Q[9] }
+  end
+  describe Q[1,"十"] do
+    it {should be_a_quantity_close_to Q[10] }
+  end
+  describe Q[1,"百"] do
+    it {should be_a_quantity_close_to Q[100] }
+  end
+  describe Q[1,"千"] do
+    it {should be_a_quantity_close_to Q[1000] }
+  end
+  describe Q[1,"万"] do
+    it {should be_a_quantity_close_to Q[10000] }
+  end
+  describe Q[1,"億"] do
+    it {should be_a_quantity_close_to Q[100000000] }
+  end
+  describe Q[1,"兆"] do
+    it {should be_a_quantity_close_to Q[1e+12] }
+  end
+  describe Q[1,"京"] do
+    it {should be_a_quantity_close_to Q[1e+16] }
+  end
+  describe Q[1,"垓"] do
+    it {should be_a_quantity_close_to Q[1e+20] }
+  end
+  describe Q[1,"秭"] do
+    it {should be_a_quantity_close_to Q[1e+24] }
+  end
+  describe Q[1,"秭"] do
+    it {should be_a_quantity_close_to Q[1e+24] }
+  end
+  describe Q[1,"穰"] do
+    it {should be_a_quantity_close_to Q[1e+28] }
+  end
+  describe Q[1,"溝"] do
+    it {should be_a_quantity_close_to Q[1e+32] }
+  end
+  describe Q[1,"澗"] do
+    it {should be_a_quantity_close_to Q[1e+36] }
+  end
+  describe Q[1,"正"] do
+    it {should be_a_quantity_close_to Q[1e+40] }
+  end
+  describe Q[1,"載"] do
+    it {should be_a_quantity_close_to Q[1e+44] }
+  end
+  describe Q[1,"極"] do
+    it {should be_a_quantity_close_to Q[1e+48] }
+  end
+  describe Q[1,"恒河沙"] do
+    it {should be_a_quantity_close_to Q[1e+52] }
+  end
+  describe Q[1,"阿僧祇"] do
+    it {should be_a_quantity_close_to Q[1e+56] }
+  end
+  describe Q[1,"那由他"] do
+    it {should be_a_quantity_close_to Q[1e+60] }
+  end
+  describe Q[1,"不可思議"] do
+    it {should be_a_quantity_close_to Q[1e+64] }
+  end
+  describe Q[1,"無量大数"] do
+    it {should be_a_quantity_close_to Q[1e+68] }
+  end
+  describe Q[1,"割"] do
+    it {should be_a_quantity_close_to Q[0.1] }
+  end
+  describe Q[1,"分"] do
+    it {should be_a_quantity_close_to Q[0.01] }
+  end
+  describe Q[1,"厘"] do
+    it {should be_a_quantity_close_to Q[0.001] }
+  end
+  describe Q[1,"釐"] do
+    it {should be_a_quantity_close_to Q[0.001] }
+  end
+  describe Q[1,"毛"] do
+    it {should be_a_quantity_close_to Q[0.0001] }
+  end
+  describe Q[1,"毫"] do
+    it {should be_a_quantity_close_to Q[0.0001] }
+  end
+  describe Q[1,"糸"] do
+    it {should be_a_quantity_close_to Q[0.0001] }
+  end
+  describe Q[1,"絲"] do
+    it {should be_a_quantity_close_to Q[0.0001] }
+  end
+  describe Q[1,"忽"] do
+    it {should be_a_quantity_close_to Q[1e-05] }
+  end
+  describe Q[1,"微"] do
+    it {should be_a_quantity_close_to Q[1e-06] }
+  end
+  describe Q[1,"繊"] do
+    it {should be_a_quantity_close_to Q[1e-07] }
+  end
+  describe Q[1,"沙"] do
+    it {should be_a_quantity_close_to Q[1e-08] }
+  end
+  describe Q[1,"塵"] do
+    it {should be_a_quantity_close_to Q[1e-09] }
+  end
+  describe Q[1,"埃"] do
+    it {should be_a_quantity_close_to Q[1e-10] }
+  end
+  describe Q[1,"渺"] do
+    it {should be_a_quantity_close_to Q[1e-11] }
+  end
+  describe Q[1,"漠"] do
+    it {should be_a_quantity_close_to Q[1e-12] }
+  end
+  describe Q[1,"模糊"] do
+    it {should be_a_quantity_close_to Q[1e-13] }
+  end
+  describe Q[1,"逡巡"] do
+    it {should be_a_quantity_close_to Q[1e-14] }
+  end
+  describe Q[1,"須臾"] do
+    it {should be_a_quantity_close_to Q[1e-15] }
+  end
+  describe Q[1,"瞬息"] do
+    it {should be_a_quantity_close_to Q[1e-16] }
+  end
+  describe Q[1,"弾指"] do
+    it {should be_a_quantity_close_to Q[1e-17] }
+  end
+  describe Q[1,"刹那"] do
+    it {should be_a_quantity_close_to Q[1e-18] }
+  end
+  describe Q[1,"六徳"] do
+    it {should be_a_quantity_close_to Q[1e-19] }
+  end
+  describe Q[1,"虚空"] do
+    it {should be_a_quantity_close_to Q[1e-20] }
+  end
+  describe Q[1,"清浄"] do
+    it {should be_a_quantity_close_to Q[1e-21] }
+  end
+  describe Q[1,"阿頼耶"] do
+    it {should be_a_quantity_close_to Q[1e-22] }
+  end
+  describe Q[1,"阿摩羅"] do
+    it {should be_a_quantity_close_to Q[1e-23] }
+  end
+  describe Q[1,"涅槃寂静"] do
+    it {should be_a_quantity_close_to Q[1e-24] }
+  end
+  describe Q[1,"尺"] do
+    it {should be_a_quantity_close_to Q[0.303030303,"m"] }
+  end
+  describe Q[1,"寸"] do
+    it {should be_a_quantity_close_to Q[0.0303030303,"m"] }
+  end
+  describe Q[1,"里"] do
+    it {should be_a_quantity_close_to Q[3927.27273,"m"] }
+  end
+  describe Q[1,"町"] do
+    it {should be_a_quantity_close_to Q[109.090909,"m"] }
+  end
+  describe Q[1,"間"] do
+    it {should be_a_quantity_close_to Q[1.81818182,"m"] }
+  end
+  describe Q[1,"丈"] do
+    it {should be_a_quantity_close_to Q[3.03030303,"m"] }
+  end
+  describe Q[1,"曲尺"] do
+    it {should be_a_quantity_close_to Q[0.303030303,"m"] }
+  end
+  describe Q[1,"鯨尺"] do
+    it {should be_a_quantity_close_to Q[0.378787879,"m"] }
+  end
+  describe Q[1,"坪"] do
+    it {should be_a_quantity_close_to Q[3.30578512,"m^2"] }
+  end
+  describe Q[1,"畝"] do
+    it {should be_a_quantity_close_to Q[99.1735537,"m^2"] }
+  end
+  describe Q[1,"反"] do
+    it {should be_a_quantity_close_to Q[991.735537,"m^2"] }
+  end
+  describe Q[1,"段"] do
+    it {should be_a_quantity_close_to Q[991.735537,"m^2"] }
+  end
+  describe Q[1,"江戸間"] do
+    it {should be_a_quantity_close_to Q[1.54453627,"m^2"] }
+  end
+  describe Q[1,"京間"] do
+    it {should be_a_quantity_close_to Q[1.82231405,"m^2"] }
+  end
+  describe Q[1,"中京間"] do
+    it {should be_a_quantity_close_to Q[1.65289256,"m^2"] }
+  end
+  describe Q[1,"畳"] do
+    it {should be_a_quantity_close_to Q[1.54453627,"m^2"] }
+  end
+  describe Q[1,"升"] do
+    it {should be_a_quantity_close_to Q[0.00180390684,"m^3"] }
+  end
+  describe Q[1,"斗"] do
+    it {should be_a_quantity_close_to Q[0.0180390684,"m^3"] }
+  end
+  describe Q[1,"石"] do
+    it {should be_a_quantity_close_to Q[0.180390684,"m^3"] }
+  end
+  describe Q[1,"合"] do
+    it {should be_a_quantity_close_to Q[0.000180390684,"m^3"] }
+  end
+  describe Q[1,"勺"] do
+    it {should be_a_quantity_close_to Q[1.80390684e-05,"m^3"] }
+  end
+  describe Q[1,"貫"] do
+    it {should be_a_quantity_close_to Q[3.75,"kg"] }
+  end
+  describe Q[1,"斤"] do
+    it {should be_a_quantity_close_to Q[0.6,"kg"] }
+  end
+  describe Q[1,"両"] do
+    it {should be_a_quantity_close_to Q[0.0375,"kg"] }
+  end
+  describe Q[1,"匁"] do
+    it {should be_a_quantity_close_to Q[0.00375,"kg"] }
+  end
+end