facets 2.9.3 → 3.0.0

data/lib/standard/facets/gem/specification/current_specs.rb

@@ -0,0 +1,21 @@
+module Gem
+  class Specification
+
+    # Return a list of active specs or latest version of spec if not active.
+    def self.current_specs
+      named = Hash.new{|h,k| h[k] = [] }
+      each{ |spec| named[spec.name] << spec }
+      list = []
+      named.each do |name, vers|
+        if spec = vers.find{ |s| s.activated? }
+          list << spec
+        else
+          spec = vers.max{ |a,b| a.version <=> b.version }
+          list << spec
+        end
+      end
+      return list
+    end
+
+  end
+end

data/lib/standard/facets/gem/specification/find_requireable_file.rb

@@ -0,0 +1,21 @@
+module Gem
+  class Specification
+
+    # Return full path of requireable file given relative path.
+    def find_requireable_file(file)
+      root = full_gem_path
+
+      require_paths.each do |lib|
+        base = File.join(root, lib, file)
+        Gem.suffixes.each do |suf|
+          path = "#{base}#{suf}"
+          return path if File.file? path
+        end
+      end
+
+      return nil
+    end
+
+  end
+end
+

data/lib/standard/facets/hash_builder.rb

@@ -0,0 +1,46 @@
+# HashBuilder takes a procedure and builds a Hash out of it.
+#
+# The procedure must conform to a set of rules to be useful in this respect.
+# They must either take an argument and use that argument to set values, or
+# if no argument is taken then `#instance_eval` is used to evaluate the
+# procedure such that each method represents a key.
+#
+class HashBuilder < BasicObject
+
+  #
+  def initialize(hash={}, &block)
+    @hash = hash
+
+    case block.arity
+    when 0
+      instance_eval(&block)
+    else
+      block.call(self)
+    end
+  end
+
+  #
+  def to_h
+    @hash
+  end
+
+  #
+  def method_missing(s, *a, &b)
+    m = s.to_s
+    if a.empty? && !b
+      @hash[m.to_sym]
+    else
+      if b
+        @hash[m.chomp('=').to_sym] = HashBuilder.new(&b).to_h
+      else
+        if a.size > 1
+          @hash[m.chomp('=').to_sym] = a
+        else
+          @hash[m.chomp('=').to_sym] = a.first
+        end
+      end
+    end
+  end
+
+end
+

data/lib/standard/facets/load_monitor.rb

@@ -0,0 +1,26 @@
+module ::Kernel
+  class << self
+    alias_method :require_without_monitor, :require
+    alias_method :load_without_monitor, :load
+  end
+
+  alias_method :require_without_monitor, :require
+  alias_method :load_without_monitor, :load
+
+  # Require script and print what is being require.
+  def require(file)
+    $stderr.puts "monitor require: #{file}\n#{caller.inspect}\n\n"
+    require_without_monitor(file)
+  end
+
+  module_function :require
+
+  # Load script and print what is being loaded.
+  def load(file, wrap=false)
+    $stderr.puts "monitor load: #{file}\n#{caller.inspect}\n\n"
+    load_without_monitor(file, wrap)
+  end
+
+  module_function :load
+end
+

data/lib/standard/facets/math.rb

@@ -1,58 +1,58 @@
-reqiure 'facets/kernel/require_relative'
-
-require_relative 'abs.rb'
-require_relative 'acot.rb'
-require_relative 'acoth.rb'
-require_relative 'acsc.rb'
-require_relative 'acsch.rb'
-require_relative 'amd.rb'
-require_relative 'approx_equal.rb'
-require_relative 'asec.rb'
-require_relative 'asech.rb'
-require_relative 'atkinson_index.rb'
-require_relative 'beta.rb'
-require_relative 'cdf.rb'
-require_relative 'ceil.rb'
-require_relative 'cot.rb'
-require_relative 'coth.rb'
-require_relative 'csc.rb'
-require_relative 'csch.rb'
-require_relative 'delta.rb'
-require_relative 'epsilon.rb'
-require_relative 'exp2.rb'
-require_relative 'exp10.rb'
-require_relative 'factorial.rb'
-require_relative 'floor.rb'
-require_relative 'gamma.rb'
-require_relative 'gcd.rb'
-require_relative 'gini_coefficient.rb'
-require_relative 'kldivergence.rb'
-require_relative 'lcm.rb'
-require_relative 'lgamma.rb'
-require_relative 'linsolve.rb'
-require_relative 'log2.rb'
-require_relative 'max.rb'
-require_relative 'mean.rb'
-require_relative 'median.rb'
-require_relative 'min.rb'
-require_relative 'percentile.rb'
-require_relative 'pow.rb'
-require_relative 'pstd.rb'
-require_relative 'pvariance.rb'
-require_relative 'rmd.rb'
-require_relative 'root.rb'
-require_relative 'round.rb'
-require_relative 'sec.rb'
-require_relative 'sech.rb'
-require_relative 'sign.rb'
-require_relative 'sinc.rb'
-require_relative 'sqr.rb'
-require_relative 'sqsolve.rb'
-require_relative 'std.rb'
-require_relative 'stderr.rb'
-require_relative 'sum.rb'
-require_relative 'summed_sqdevs.rb'
-require_relative 'tgamma.rb'
-require_relative 'theil_index.rb'
-require_relative 'variance.rb'
+require_relative 'math/abs.rb'
+require_relative 'math/acot.rb'
+require_relative 'math/acoth.rb'
+require_relative 'math/acsc.rb'
+require_relative 'math/acsch.rb'
+require_relative 'math/amd.rb'
+require_relative 'math/approx_equal.rb'
+require_relative 'math/asec.rb'
+require_relative 'math/asech.rb'
+require_relative 'math/atkinson_index.rb'
+require_relative 'math/beta.rb'
+require_relative 'math/cdf.rb'
+require_relative 'math/ceil.rb'
+require_relative 'math/cot.rb'
+require_relative 'math/coth.rb'
+require_relative 'math/csc.rb'
+require_relative 'math/csch.rb'
+require_relative 'math/delta.rb'
+require_relative 'math/ec.rb'
+require_relative 'math/epsilon.rb'
+require_relative 'math/exp2.rb'
+require_relative 'math/exp10.rb'
+require_relative 'math/factorial.rb'
+require_relative 'math/floor.rb'
+require_relative 'math/gcd.rb'
+require_relative 'math/gini_coefficient.rb'
+require_relative 'math/kldivergence.rb'
+require_relative 'math/lcm.rb'
+require_relative 'math/lgamma.rb'
+require_relative 'math/lngamma.rb'
+require_relative 'math/linsolve.rb'
+require_relative 'math/log2.rb'
+require_relative 'math/max.rb'
+require_relative 'math/mean.rb'
+require_relative 'math/median.rb'
+require_relative 'math/min.rb'
+require_relative 'math/percentile.rb'
+require_relative 'math/pow.rb'
+require_relative 'math/pstd.rb'
+require_relative 'math/pvariance.rb'
+require_relative 'math/rmd.rb'
+require_relative 'math/root.rb'
+require_relative 'math/round.rb'
+require_relative 'math/sec.rb'
+require_relative 'math/sech.rb'
+require_relative 'math/sign.rb'
+require_relative 'math/sinc.rb'
+require_relative 'math/sqr.rb'
+require_relative 'math/sqsolve.rb'
+require_relative 'math/std.rb'
+require_relative 'math/stderr.rb'
+require_relative 'math/sum.rb'
+require_relative 'math/summed_sqdevs.rb'
+require_relative 'math/tau.rb'
+require_relative 'math/tgamma.rb'
+require_relative 'math/theil_index.rb'
+require_relative 'math/variance.rb'
 

data/lib/standard/facets/math/acosec.rb

@@ -0,0 +1 @@
+require 'facets/math/acsc'

data/lib/standard/facets/math/acsc.rb

@@ -1,8 +1,13 @@
 module Math
 
-  # Arcus cosecans of +x+
+  # Arcus cosecans of `x`.
   def self.acsc(x)
     asin(1.0 / x)
   end
 
+  # Arcus cosecans of `x`.
+  def self.acosec(x)
+    asin(1.0 / x)
+  end
+
 end

data/lib/standard/facets/math/beta.rb

@@ -1,9 +1,14 @@
+require 'facets/math/tgamma'
+
 module Math
 
-  # Beta function of +x+ and +y+ - <code>beta(+x+, +y+) =
-  # tgamma(+x+) * tgamma(+y+) / tgamma(+x+ + +y+)</code>
+  # Beta function of `x` and `y`.
+  #
+  #     beta(x, y) = tgamma(x) * tgamma(y) / tgamma(x + y)
+  #
   def self.beta(x, y)
-    exp(lgamma(x) + lgamma(y) - lgamma(x+y))
+    #exp(lgamma(x).first + lgamma(y).first - lgamma(x+y).first)
+    tgamma(x) * tgamma(y) / tgamma(x + y)
   end
 
 end

data/lib/standard/facets/math/cosec.rb

@@ -0,0 +1 @@
+require 'facets/math/csc'

data/lib/standard/facets/math/cosech.rb

@@ -0,0 +1 @@
+require 'facets/math/csch'

data/lib/standard/facets/math/csc.rb

@@ -1,8 +1,13 @@
 module Math
 
-  # Cosecans of +x+
+  # Cosecans of `x`.
   def self.csc(x)
     1.0 / sin(x)
   end
 
+  # Cosecans of `x`.
+  def self.cosec(x)
+    1.0 / sin(x)
+  end
+
 end

data/lib/standard/facets/math/csch.rb

@@ -1,8 +1,13 @@
 module Math
 
-  # Cosecans hyperbolicus of +x+
+  # Cosecans hyperbolicus of `x`.
   def self.csch(x)
     1.0 / sinh(x)
   end
 
+  # Cosecans hyperbolicus of `x`.
+  def self.cosech(x)
+    1.0 / sinh(x)
+  end
+
 end

data/lib/standard/facets/math/distance.rb

@@ -0,0 +1,19 @@
+module Math
+
+  # Calculates the Euclidean Distance between points +p+ and +q+.
+  # 
+  # `p`, `q` is assumed to described coordinates in N-dimensions, e. g.:
+  #
+  #    Math.distance([1, 1], [2, 2])          # 2D coordinates
+  #    Math.distance([1, 1, 1], [2, 2, 2])    # 3D coordinates
+  #
+  # If N is 1, then `::distance` may also be invoked like so:
+  #
+  #    Math.distance(1, 1)  
+  #
+  def self.distance(p, q)
+    p, q = [p].flatten, [q].flatten
+    sqrt(p.zip(q).inject(0){ |sum, coord| sum + (coord.first - coord.last)**2 })
+  end
+
+end

data/lib/standard/facets/math/ec.rb

@@ -0,0 +1,5 @@
+module Math
+  # Euler's constant.
+  EC = 0.577_215_664_901_532_861
+end
+

data/lib/standard/facets/math/lgamma.rb

@@ -1,23 +1,23 @@
-module Math
+require 'facets/math/lngamma'
 
-  unless defined?(lgamma)
+## This is the old definition by Josef Schugt.
+##
+## Around v2.0, Ruby finally added it's own `lgamma`
+## function. That's good, but unforutnately it returns
+## an array that includes the `sign(gamma(x))` too.
+#
+# def Math.lgamma(x)
+#  h  = x + 5.5
+#  h -= (x + 0.5) * log(h)
+#
+#  sum  =  1.000_000_000_190_015
+#  sum += 76.180_091_729_471_46	     / (x + 1.0)
+#  sum -= 86.505_320_329_416_77	     / (x + 2.0)
+#  sum += 24.014_098_240_830_91	     / (x + 3.0)
+#  sum -=  1.231_739_572_450_155	     / (x + 4.0)
+#  sum +=  0.120_865_097_386_617_9e-2 / (x + 5.0)
+#  sum -=  0.539_523_938_495_3e-5     / (x + 6.0)
+#
+#  -h + log(2.506_628_274_631_000_5 * sum / x)
+# end
 
-    # Logarithmus naturalis of gamma function of +x+.
-    #
-    # @author Josef Schugt
-    def self.lgamma(x)
-      h  = x + 5.5
-      h -= (x + 0.5) * log(h)
-      sum  =  1.000_000_000_190_015
-      sum += 76.180_091_729_471_46	     / (x + 1.0)
-      sum -= 86.505_320_329_416_77	     / (x + 2.0)
-      sum += 24.014_098_240_830_91	     / (x + 3.0)
-      sum -=  1.231_739_572_450_155	     / (x + 4.0)
-      sum +=  0.120_865_097_386_617_9e-2 / (x + 5.0)
-      sum -=  0.539_523_938_495_3e-5     / (x + 6.0)
-      -h + log(2.506_628_274_631_000_5 * sum / x)
-    end
-
-  end
-
-end

data/lib/standard/facets/math/lngamma.rb

@@ -0,0 +1,18 @@
+module Math
+
+  # Logarithmus naturalis of gamma function of `x`.
+  # 
+  # Notice the use of `ln` prefix to differentiate from
+  # Ruby's built-in `#lgamma` function which returns an Array.
+  #
+  def self.lngamma(x)
+    lgamma(x).first
+  end
+
+  # Old name used by Extmath library.
+  def self.ln_gamma(x)
+    lgamma(x).first
+  end
+
+end
+

data/lib/standard/facets/math/pow.rb

@@ -1,8 +1,13 @@
 module Math
 
-  # +x+ to the power +y+
+  # `x` to the power `y`.
   def self.pow(x, y)
     x ** y
   end
 
+  # `x` to the power `y`.
+  def self.pwr(x, y)
+    x ** y
+  end
+
 end

data/lib/standard/facets/math/root.rb

@@ -1,6 +1,6 @@
 module Math
 
-  # The +y+ root of +x+.
+  # The `y` root of `x`.
   def self.root(x, y)
     x ** (1.0 / y)
   end

data/lib/standard/facets/math/sign.rb

@@ -1,9 +1,20 @@
 module Math
 
-  # Sign of +x+.
-  # Returns -1 for negative x, +1 for positive x and zero for x = 0 
-  def self.sign(x)
-    (x > 0.0) ? 1.0 : ((x < 0.0) ? -1.0 : 0.0)
+  # Sign of `x`. This function returns `-1.0` if `x` is negative,
+  # `+1.0` if `x` is positive `x`, and `0.0` if `x = 0`.
+  def self.sign(x, zero=0.0)
+    (x > 0.0) ? 1.0 : ((x < 0.0) ? -1.0 : zero)
+  end
+
+  # Same as `Math.sign`.
+  def self.sgn(x, zero=0.0)
+    (x > 0.0) ? 1.0 : ((x < 0.0) ? -1.0 : zero)
+  end
+
+  # The *Heaviside step function*, also called the the *unit step function*.
+  # This functions works like `Math.sign` but by default returns `1.0` for zero.
+  def self.unit_step(x, zero=1.0)
+    (x > 0.0) ? 1.0 : ((x < 0.0) ? -1.0 : zero)
   end
 
 end