unitwise 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6ff99c65554976100b5a3cc719eb53aa95fc769
-  data.tar.gz: f3264f24f7f00d2380f2433ac4f5c6d0b7631b04
+  metadata.gz: 856dafc49ff1ab7e67a413b4d624f967d54ab8e0
+  data.tar.gz: a4960934e8a31ca2c7906f20c76af4b544dd6a69
 SHA512:
-  metadata.gz: 83c29762b50698411daacac88989649953282968257a932f86e224b8b9e84e5139cc912b25bf8ff4647df1dda3c6b1e5884e3285284a7b3fc463ff928ad1046c
-  data.tar.gz: a93702efcf3fcb0f849be1a6cd6a2219c5892df763ffa14f1284c2bb45a2d75c451a9c40db141591cde42ddde0dcbeecb6efcc1386ad795bd1f65d75542e2fdd
+  metadata.gz: a72d207aa8b7aff3f700e7645060566c23590857be3072ba63f59bf23b578caf10e8b5e7d1c23d4b9f2350c16a2b49ef8bc524d00ecf0333f3bbef526611d261
+  data.tar.gz: 1c8f05c32997d78a957955f951737d5f65371f614af3b39dedf898faf50a55e281f5139e0f205af844d099c7c9d4e3232508ef7255ec6ea4c9e22252b6abfabc

data/lib/unitwise/atom.rb

@@ -102,8 +102,12 @@ module Unitwise
     # or operate on. Base units have a scalar of 1.
     # @return [Numeric]
     # @api public
-    def scalar
-      base? ? 1 : scale.scalar
+    def scalar(x = 1)
+      base? ? 1 : scale.scalar(x)
+    end
+
+    def inverse_scalar(x = 1)
+      base? ? 1 : scale.inverse_scalar(x)
     end
 
     # Get a functional value that can be used with other atoms to compare with
@@ -111,9 +115,7 @@ module Unitwise
     # @param x [Numeric] The number to convert to or convert from
     # @param forward [true, false] Convert to or convert from
     # @return [Numeric] The converted value
-    def functional(x = scalar, forward = true)
-      scale.functional(x, forward)
-    end
+
 
     # An atom may have a complex scale with several base atoms at various
     # depths. This method returns all of this atoms base level terms.

data/lib/unitwise/base.rb

@@ -1,14 +1,24 @@
 require 'yaml'
 module Unitwise
-  # The base class that Atom and Prefix are extended from. This class includes
-  # shared functionality from those classes only.
+  # The base class that Atom and Prefix are extended from. This class provides
+  # shared functionality for said classes.
   class Base
     liner :names, :primary_code, :secondary_code, :symbol, :scale
 
+    # The list of tracked items.
+    # @return [Array] An array of memoized instances.
+    # @api public
     def self.all
       @all ||= data.map { |d| new d }
     end
 
+    # Find a matching instance by a specified attribute.
+    # @param string [String] The search term
+    # @param method [Symbol] The attribute to search by
+    # @return The first matching instance
+    # @example
+    #   Unitwise::Atom.find('m')
+    # @api public
     def self.find(string, method = :primary_code)
       all.find do |i|
         key = i.send(method)
@@ -20,21 +30,32 @@ module Unitwise
       end
     end
 
+    # Setup a new instance. Takes a hash of attributes, or an array of
+    # attribute values.
+    # @api public
     def initialize(*args)
       super(*args)
       freeze
     end
 
+    # Setter for the names attribute. Will always set as an array.
+    # @api semipublic
     def names=(names)
       @names = Array(names)
     end
 
+    # A set of method friendly names.
+    # @return [Array] An array of strings
+    # @api semipublic
     def slugs
       names.map do |n|
         n.downcase.strip.gsub(/\s/, '_').gsub(/\W/, '')
       end
     end
 
+    # String representation for the instance.
+    # @return [String]
+    # @api public
     def to_s
       primary_code
     end

data/lib/unitwise/compound.rb

@@ -31,7 +31,7 @@ module Unitwise
     # @api public
     def self.search(term)
       all.select do |compound|
-        compound.search_strings.any? { |string| Regexp.new(term).match(string) }
+        compound.search_strings.any? { |str| Regexp.new(term).match(str) }
       end
     end
 
@@ -48,7 +48,7 @@ module Unitwise
         instance_variable_get("@#{attr}") ||
         instance_variable_set("@#{attr}",
           if prefix
-            prefix.send(attr).zip(atom.send(attr)).map{ |set| set.join('') }
+            prefix.send(attr).zip(atom.send(attr)).map { |set| set.join('') }
           else
             atom.send(attr)
           end)
@@ -64,11 +64,13 @@ module Unitwise
     end
 
     def search_strings
-      @search_strings ||= [primary_code, secondary_code, symbol, names, slugs].flatten.uniq
+      @search_strings ||= [primary_code, secondary_code, symbol,
+                           names, slugs].flatten.uniq
     end
 
     def attribute_string
-      [:atom, :prefix, :primary_code, :secondary_code, :symbol, :names, :slugs].map do |attr|
+      [:atom, :prefix, :primary_code, :secondary_code,
+       :symbol, :names, :slugs].map do |attr|
         "#{attr}='#{send attr}'"
       end.join(', ')
     end

data/lib/unitwise/functional.rb

@@ -6,44 +6,84 @@ module Unitwise
   class Functional < Scale
     extend Math
 
-    def self._cel(x, forward = true)
-      forward ? x - 273.15 : x + 273.15
+    def self.to_cel(x)
+      x - 273.15
     end
 
-    def self._degf(x, forward = true)
-      forward ? 9.0 * x / 5.0 - 459.67 : 5.0 / 9 * (x + 459.67)
+    def self.from_cel(x)
+      x + 273.15
     end
 
-    def self._hpX(x, forward = true)
-      forward ? -log10(x) : 10 ** -x
+    def self.to_degf(x)
+      9.0 * x / 5.0 - 459.67
     end
 
-    def self._hpC(x, forward = true)
-      forward ? -log(x) / log(100) : 100 ** -x
+    def self.from_degf(x)
+      5.0 / 9 * (x + 459.67)
     end
 
-    def self._tan100(x, forward = true)
-      forward ? 100 * tan(x) : atan(x / 100)
+    def self.to_hpX(x)
+      -log10(x)
     end
 
-    def self._ph(x, forward = true)
-      _hpX(x,forward)
+    def self.from_hpX(x)
+      10 ** -x
     end
 
-    def self._ld(x, forward = true)
-      forward ? log2(x) : 2 ** x
+    def self.to_hpC(x)
+      -log(x) / log(100)
     end
 
-    def self._ln(x, forward = true)
-      forward ? log(x) : Math::E ** x
+    def self.from_hpC(x)
+      100 ** -x
     end
 
-    def self._lg(x, forward = true)
-      forward ? log10(x) : 10 ** x
+    def self.to_tan100(x)
+      100 * tan(x)
     end
 
-    def self._2lg(x, forward = true)
-      forward ? 2 * log10(x) : 10 ** (x / 2)
+    def self.from_tan100(x)
+      atan(x / 100)
+    end
+
+    def self.to_ph(x)
+      to_hpX(x)
+    end
+    
+    def self.from_ph(x)
+      from_hpX(x)
+    end
+
+    def self.to_ld(x)
+      log2(x)
+    end
+
+    def self.from_ld(x)
+      2 ** x
+    end
+
+    def self.to_ln(x)
+      log(x)
+    end
+
+    def self.from_ln(x)
+      Math::E ** x
+    end
+
+    def self.to_lg(x)
+      log10(x)
+    end
+
+    def self.from_lg(x)
+      10 ** x
+    end
+
+    def self.to_2lg(x)
+      2 * log10(x)
+    end
+
+    def self.from_2lg(x)
+      10 ** (x / 2)
     end
 
     attr_reader :function_name
@@ -58,14 +98,21 @@ module Unitwise
       super(value, unit)
     end
 
-    # Get the equivalent scalar value of a unit based on the atom's function.
-    # @params x [Numeric]
-    # @params forward [true, false] The direction of the conversion. Use true
-    # when converting from the special, use false when converting to the special.
-    # @return [Numeric]
+    # Get the equivalent scalar value of a magnitude on this scale
+    # @param magnitude [Numeric] The magnitude to find the scalar value for
+    # @return [Numeric] Equivalent linear scalar value
     # @api public
-    def functional(x = scalar, forward = true)
-      self.class.send(:"_#{function_name}", x, forward)
+    def scalar(magnitude = value)
+      self.class.send(:"from_#{function_name}", magnitude)
     end
+
+    # Get the equivalent magnitude on this scale for a scalar value
+    # @param scalar [Numeric] A linear scalar value
+    # @return [Numeric] The equivalent magnitude on this scale
+    # @api public
+    def inverse_scalar(scalar = scalar)
+      self.class.send(:"to_#{function_name}", scalar)
+    end
+
   end
 end

data/lib/unitwise/measurement.rb

@@ -152,18 +152,10 @@ module Unitwise
     # Determine value of the unit after conversion to another unit
     # @api private
     def converted_value(other_unit)
-      if unit.special?
-        if other_unit.special?
-          other_unit.functional functional(value, false)
-        else
-          functional(value, false) / other_unit.scalar
-        end
+      if other_unit.special?
+        other_unit.inverse_scalar scalar
       else
-        if other_unit.special?
-          other_unit.functional(scalar)
-        else
-          scalar / other_unit.scalar
-        end
+        scalar / other_unit.scalar
       end
     end
 

data/lib/unitwise/scale.rb

@@ -46,16 +46,26 @@ module Unitwise
     # @param forward [true, false] whether to convert to this unit or from it.
     # @return [Numeric]
     # @api public
-    def functional(x = value, forward = true)
-      unit.functional(x, forward)
+
+    # Get a scalar value for this scale.
+    # @param magnitude [Numeric] An optional magnitude on this scale.
+    # @return [Numeric] A scalar value on a linear scale
+    # @api public
+    def scalar(magnitude = value)
+      if special?
+        unit.scalar(magnitude)
+      else
+        value * unit.scalar
+      end
     end
 
-    # Return a scalar value for non-special units, this will be some ratio of a
-    # child base unit.
-    # @return [Numeric]
+    # Get a magnitude based on a linear scale value. Only used by scales with 
+    # special atoms in it's hierarchy.
+    # @param scalar [Numeric] A linear scalar value
+    # @return [Numeric] The equivalent magnitude on this scale
     # @api public
-    def scalar
-      value * unit.scalar
+    def inverse_scalar(scalar = scalar)
+      unit.inverse_scalar(scalar)
     end
 
     # The base terms this scale's unit is derived from

data/lib/unitwise/term.rb

@@ -31,7 +31,7 @@ module Unitwise
     # Is this term special?
     # @return [true, false]
     def special?
-      atom.special rescue false
+      atom.special? rescue false
     end
 
     # Determine how far away a unit is from a base unit.
@@ -62,26 +62,20 @@ module Unitwise
       super || 1
     end
 
-    # The unitless value for this term. This is the equivalent value of it's
-    # base atom
-    # @return [Numeric]
+    # The unitless scalar value for this term.
+    # @param magnitude [Numeric] The magnitude to calculate the scalar for.
+    # @return [Numeric] The unitless linear scalar value.
     # @api public
-    def scalar
-      (factor * (prefix ? prefix.scalar : 1) *
-        (atom ? atom.scalar : 1)) ** exponent
+    def scalar(magnitude = 1)
+      calculate(atom ? atom.scalar(magnitude) : 1)
     end
 
-    # Get the equivalent scalar value of a unit based on the atom's function.
-    # @params x [Numeric]
-    # @params forward [true, false] The direction of the conversion. Use true
-    # when converting from the special, use false when converting to the
-    # special.
-    # @return [Numeric]
+    # Calculate the magnitude for this term
+    # @param scalar [Numeric] The scalar for which you want the magnitude
+    # @return [Numeric] The magnitude on this scale.
     # @api public
-    # @param x [Numeric] The value
-    def functional(x = scalar, forward = true)
-      (factor * (prefix ? prefix.scalar : 1)) *
-        (atom ? atom.functional(x, forward) : 1) ** exponent
+    def inverse_scalar(scalar = scalar)
+      calculate(atom ? atom.inverse_scalar(scalar) : 1)
     end
 
     # The base units this term is derived from
@@ -140,5 +134,12 @@ module Unitwise
       [(factor if factor != 1), prefix.to_s,
         atom.to_s, (exponent if exponent != 1)].compact.join('')
     end
+
+    private
+
+    # @api private
+    def calculate(value)
+      (factor * (prefix ? prefix.scalar : 1) * value) ** exponent
+    end
   end
 end

data/lib/unitwise/unit.rb

@@ -35,9 +35,6 @@ module Unitwise
       terms.count == 1 && terms.all?(&:special?)
     end
 
-    def functional(x = scalar, forward = true)
-      terms.first.functional(x, forward)
-    end
 
     def depth
       terms.map(&:depth).max + 1
@@ -47,8 +44,16 @@ module Unitwise
       terms.flat_map(&:root_terms)
     end
 
-    def scalar
-      terms.map(&:scalar).reduce(&:*)
+    def scalar(x = 1)
+      terms.reduce(1) do |prod, term|
+        prod * term.scalar(x)
+      end
+    end
+
+    def inverse_scalar(x = 1)
+      terms.reduce(1) do |prod, term|
+        prod * term.inverse_scalar(x)
+      end
     end
 
     def *(other)

data/lib/unitwise/version.rb

@@ -1,3 +1,3 @@
 module Unitwise
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/test/support/scale_tests.rb

@@ -54,15 +54,13 @@ module ScaleTests
         it "must return value relative to terminal atoms" do
           subject.scalar.must_equal 4000
           mph.scalar.must_equal 26.8224
+          cel.scalar.must_equal 295.15
         end
       end
 
-      describe "#functional" do
-        it "must return a converted value" do
-          cel.functional(0,true).must_equal -273.15
-        end
-        it "must return a de-converted value" do
-          cel.functional(0,false).must_equal 273.15
+      describe "#inverse_scalar" do
+        it "must return the magnitude" do
+          cel.inverse_scalar.must_equal(22)
         end
       end
 

data/test/unitwise/functional_test.rb

@@ -3,12 +3,11 @@ require 'test_helper'
 describe Unitwise::Functional do
   subject { Unitwise::Functional }
   %w{cel degf hpX hpC tan100 ph ld ln lg 2lg}.each do |function|
-    function = :"_#{function}"
     describe function do
       it 'should convert back and forth' do
         number = rand.round(5)
-        there = subject.send function, number, true
-        back_again = subject.send function, there, false
+        there = subject.send "to_#{function}", number
+        back_again = subject.send "from_#{function}", there
         back_again.round(5).must_equal number
       end
     end

data/test/unitwise/measurement_test.rb

@@ -51,7 +51,6 @@ describe Unitwise::Measurement do
       mult.value.must_equal 180
       mult.unit.must_equal Unitwise::Unit.new("[mi_i]2/h")
     end
-
     it "must multiply canceling units" do
       mult = mph * hpm
       mult.value.must_equal 360

data/unitwise.gemspec

@@ -4,26 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'unitwise/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "unitwise"
+  gem.name          = 'unitwise'
   gem.version       = Unitwise::VERSION
-  gem.authors       = ["Josh Lewis"]
-  gem.email         = ["josh.w.lewis@gmail.com"]
-  gem.description   = %q{Ruby implementation of the Unified Code for Units of Measure (UCUM)}
-  gem.summary       = %q{Unitwise is a library for performing mathematical operations and conversions on all units defined by the Unified Code for Units of Measure(UCUM).}
-  gem.homepage      = "http://github.com/joshwlewis/unitwise"
-  gem.license       = "MIT"
+  gem.authors       = ['Josh Lewis']
+  gem.email         = ['josh.w.lewis@gmail.com']
+  gem.description   = 'Ruby implementation of the Unified Code for Units of ' \
+                      'Measure (UCUM)'
+  gem.summary       = 'Unitwise is a library for performing mathematical '\
+                      'operations and conversions on all units defined by '\
+                      'the Unified Code for Units of Measure(UCUM).'
+  gem.homepage      = 'http://github.com/joshwlewis/unitwise'
+  gem.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.test_files    = gem.files.grep(%r{^test/})
-  gem.require_paths = ["lib"]
+  gem.files         = `git ls-files`.split($RS)
+  gem.test_files    = gem.files.grep(/^test\//)
+  gem.require_paths = ['lib']
 
-  gem.add_dependency "liner", "~> 0.2"
-  gem.add_dependency "signed_multiset", "~> 0.2"
-  gem.add_dependency "parslet", "~> 1.5"
+  gem.add_dependency 'liner', '~> 0.2'
+  gem.add_dependency 'signed_multiset', '~> 0.2'
+  gem.add_dependency 'parslet', '~> 1.5'
 
-  gem.add_development_dependency "minitest",  ">= 5.0"
-  gem.add_development_dependency "rake",      ">= 10.0"
-  gem.add_development_dependency "nori",      "~> 2.3"
-  gem.add_development_dependency "nokogiri",  "~> 1.6"
-  gem.add_development_dependency "coveralls", "~> 0.6"
+  gem.add_development_dependency 'minitest',  '>= 5.0'
+  gem.add_development_dependency 'rake',      '>= 10.0'
+  gem.add_development_dependency 'nori',      '~> 2.3'
+  gem.add_development_dependency 'nokogiri',  '~> 1.6'
+  gem.add_development_dependency 'coveralls', '~> 0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unitwise
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Josh Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-11 00:00:00.000000000 Z
+date: 2014-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liner