morphological_metrics 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01c06a160fbad7c9a4206dbf86dd132a66e0356d
-  data.tar.gz: a41d5379301a50282377609edd3af083d2ef6b5b
+  metadata.gz: 6ba2d3ed751029eb26b50499cf4e2d7cc6d70cd0
+  data.tar.gz: 7a3aef67fdfb0a14115b28609d2e51e0463f1e84
 SHA512:
-  metadata.gz: 90fabec7539f09663fd794971afea8a5146d340dabc7635a0968119418091f680db47dd087851bc16d02fd9574da503d2b28cc6c9eafc01bfb002ad646830079
-  data.tar.gz: 5f3f3b1179201cb52b6df9d5fcc173b02e1c9708d5caf494e5ae0d868d07fce31e37d44213de7124ef54995c885094061e0ef1c76b6af522df358865fd4dd0fa
+  metadata.gz: c9584b0a4c8afeda2a9eb619b4c96303711dfbf8bdbd0aa42701b373c017e9c61e8e19260135527c67e6a03f80531120057e490689708274b342d83aa4f4811c
+  data.tar.gz: d6004665555d21c3089efbe2e8897180bac779e7995dff046ec587af532671d49f1f2c886e09010724b67375da5dcad9900ba0bbeeef5e3814ddc38fb46054b7

data/.autotest

@@ -1,30 +1,30 @@
-# -*- ruby -*-
-
-require "autotest/restart"
-
-Autotest.add_hook :initialize do |at|
-  at.testlib = ".minitest"
-#
-#   at.extra_files << "../some/external/dependency.rb"
-#
-#   at.libs << ":../some/external"
-#
-#   at.add_exception "vendor"
-#
-#   at.add_mapping(/dependency.rb/) do |f, _|
-#     at.files_matching(/test_.*rb$/)
-#   end
-#
-#   %w(TestA TestB).each do |klass|
-#     at.extra_class_map[klass] = "test/test_misc.rb"
-#   end
-end
-
-# Autotest.add_hook :run_command do |at|
-#   system "rake build"
-# end
-
-Autotest.add_hook :all_good do |at|
-  system "rake rcov_info"
-end if ENV['RCOV']
-
+# -*- ruby -*-
+
+require "autotest/restart"
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = ".minitest"
+#
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception "vendor"
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end
+
+Autotest.add_hook :all_good do |at|
+  system "rake rcov_info"
+end if ENV['RCOV']
+

data/.minitest.rb

@@ -1,3 +1,3 @@
-gem "minitest"
-require "minitest/autorun"
-
+gem "minitest"
+require "minitest/autorun"
+

data/.travis.yml

@@ -1,10 +1,10 @@
-language: ruby
-env: 
-  - CODECLIMATE_REPO_TOKEN=d05b64cdc405df4f1632a3656a1062ea4873a20ff4463732c47c4d811884fde6 
-rvm:
-  - "2.0.0"
-  - "2.1.2"
-addons:
-  code_climate:
-    repo_token: d05b64cdc405df4f1632a3656a1062ea4873a20ff4463732c47c4d811884fde6  
-
+language: ruby
+env: 
+  - CODECLIMATE_REPO_TOKEN=d05b64cdc405df4f1632a3656a1062ea4873a20ff4463732c47c4d811884fde6 
+rvm:
+  - "2.0.0"
+  - "2.1.2"
+addons:
+  code_climate:
+    repo_token: d05b64cdc405df4f1632a3656a1062ea4873a20ff4463732c47c4d811884fde6  
+

data/History.txt

@@ -1,6 +1,6 @@
-=== 1.0.0 / 2014-04-09
-
-* 1 major enhancement
-
-  * Birthday!
-
+=== 1.0.0 / 2014-04-09
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -1,27 +1,27 @@
-.autotest
-.minitest.rb
-.travis.yml
-Gemfile
-Gemfile.lock
-History.txt
-Manifest.txt
-README.rdoc
-ROADMAP.txt
-Rakefile
-bin/mm
-lib/mm.rb
-lib/mm/deltas.rb
-lib/mm/metric.rb
-lib/mm/pairs.rb
-lib/mm/ratio.rb
-lib/mm/scaling.rb
-lib/mm/search.rb
-lib/shortcuts.yml
-test/helpers.rb
-test/mm/test_deltas.rb
-test/mm/test_metric.rb
-test/mm/test_mm.rb
-test/mm/test_pairs.rb
-test/mm/test_ratio.rb
-test/mm/test_scaling.rb
-test/mm/test_search.rb
+.autotest
+.minitest.rb
+.travis.yml
+Gemfile
+Gemfile.lock
+History.txt
+Manifest.txt
+README.rdoc
+ROADMAP.txt
+Rakefile
+bin/mm
+lib/mm.rb
+lib/mm/deltas.rb
+lib/mm/metric.rb
+lib/mm/pairs.rb
+lib/mm/ratio.rb
+lib/mm/scaling.rb
+lib/mm/search.rb
+lib/shortcuts.yml
+test/helpers.rb
+test/mm/test_deltas.rb
+test/mm/test_metric.rb
+test/mm/test_mm.rb
+test/mm/test_pairs.rb
+test/mm/test_ratio.rb
+test/mm/test_scaling.rb
+test/mm/test_search.rb

data/README.rdoc

@@ -1,66 +1,65 @@
-{<img src="https://codeclimate.com/github/andrewcsmith/mm.png"
-/>}[https://codeclimate.com/github/andrewcsmith/mm]
-
-{<img src="https://travis-ci.org/andrewcsmith/mm.svg?branch=master"
-/>}[https://travis-ci.org/andrewcsmith/mm]
-
-= mm
-
-https://www.github.com/andrewcsmith/mm
-
-== DESCRIPTION:
-
-Implements some Morphological Metrics, described by Larry Polansky.
-
-== FEATURES/PROBLEMS:
-
-* Works on anything Enumerable
-* Can get a number of different MMs
-* Works extra fast on large NMatrix objects
-
-== SYNOPSIS:
-
-Code sample, LOL
-
-== REQUIREMENTS:
-
-* nmatrix
-* ruby
-
-== INSTALL:
-
-* FIX (sudo gem install, anything else)
-
-== DEVELOPERS:
-
-After checking out the source, run:
-
-  $ rake newb
-
-This task will install any missing dependencies, run the tests/specs,
-and generate the RDoc.
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2014 FIX
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+{<img src="https://codeclimate.com/github/andrewcsmith/mm.png"
+/>}[https://codeclimate.com/github/andrewcsmith/mm]
+
+{<img src="https://travis-ci.org/andrewcsmith/mm.svg?branch=master"
+/>}[https://travis-ci.org/andrewcsmith/mm]
+
+= mm
+
+https://www.github.com/andrewcsmith/mm
+
+== DESCRIPTION:
+
+Implements some Morphological Metrics, described by Larry Polansky.
+
+== FEATURES/PROBLEMS:
+
+* Works on anything Enumerable
+* Can get a number of different MMs
+* Works extra fast on large NMatrix objects
+
+== SYNOPSIS:
+
+Code sample, LOL
+
+== REQUIREMENTS:
+
+* nmatrix
+* ruby
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2014 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECT

data/ROADMAP.txt

@@ -1,63 +1,63 @@
-- Complete functions for getting combinatorial and adjacent pairs
-	- fix any problems with shapes, test more thoroughly
-	- add the ability to recurse throughout an Array tree 
-- Create a selection of distance functions that work with NMatrix etc
-- These should be implementation-agnostic
-- Ideally they should be of the symbol/method format, where the user passes a
-  symbol of the method to the metric
-- Create a Metric class, perhaps as a subclass of Proc
-- What does it mean to subclass Proc?
-- Do some research.
-	- What about subclassing Method? What would that give us?
-- Instead of a "factory" class, the creation of the metric should take place in
-  its initialization. 
-	- Metric.new should take arguments similar to DistConfig, but with a
-	  specific implementation of OLM, OCM, etc. 
-	- This is out of a desire to tie the selection of the logic into the
-	  distance function.
-	- However, there could be MM.ocm, MM.olm, etc., functions that are
-	  "factories" that call the normal instantiation method. But it should
-not be possible to create a metric without the DistConfig in instantiation.
-
-Implementation and interface requirements:
-- Objects should implement [] and #each
-- Objects should implement whatever distance method is called by the Metric
-
-Additional distance functions should (ideally) be in their own gems.
-
-== Metric Class Methods 
-
-=== ::new(ordering, pairing, scaling, delta) 
-
-Generates a new morphological metric based on various parameters
-
-**ordered**: can be true or false. Corresponds to ordered/unordered.
-
-**pairing**: Similar to the delta. If it is a Proc, then the pairing function is
-called on each vector (or however it is handled by the ordering). If it is a
-Symbol, then we look it up in MM::PAIRING_FUNCTIONS.
-
-**scaling**: *always* a Proc. There are prebaked scaling functions for absolute,
-relative, and unscaled that are available for use. If a Symbol is passed instead
-of a Proc, it looks for the Proc in the Hash MM::SCALING_FUNCTIONS
-
-**delta functions**: If it is a Proc, then the delta function is used as d(x, y)
-on each element. If it is a symbol, then the symbol is first looked up in the
-MM::DELTA_FUNCTIONS hash. If it is not found, then x.symbol(y) is attempted.
-Delta functions should aspire to being as general as possible; let the source
-implement the method.
-
-**order**: this is confusing terminology - first-order and second-order
-difference functions.
-
-**interval functions**: We should instead brew the int_func into the method of
-finding pairs. This is where the Pairs class might come in handy; it could
-generate functions (Procs, whatever) as a factory from various values, taking
-into account what each value should be compared to. It's not [element, element],
-but [element, comparison-element] that matters.
-
-=== ::olm(scaling, delta) 
-
-Generates a new morphological metric calling ::new with the given ordering and
-pairing
-
+- Complete functions for getting combinatorial and adjacent pairs
+	- fix any problems with shapes, test more thoroughly
+	- add the ability to recurse throughout an Array tree 
+- Create a selection of distance functions that work with NMatrix etc
+- These should be implementation-agnostic
+- Ideally they should be of the symbol/method format, where the user passes a
+  symbol of the method to the metric
+- Create a Metric class, perhaps as a subclass of Proc
+- What does it mean to subclass Proc?
+- Do some research.
+	- What about subclassing Method? What would that give us?
+- Instead of a "factory" class, the creation of the metric should take place in
+  its initialization. 
+	- Metric.new should take arguments similar to DistConfig, but with a
+	  specific implementation of OLM, OCM, etc. 
+	- This is out of a desire to tie the selection of the logic into the
+	  distance function.
+	- However, there could be MM.ocm, MM.olm, etc., functions that are
+	  "factories" that call the normal instantiation method. But it should
+not be possible to create a metric without the DistConfig in instantiation.
+
+Implementation and interface requirements:
+- Objects should implement [] and #each
+- Objects should implement whatever distance method is called by the Metric
+
+Additional distance functions should (ideally) be in their own gems.
+
+== Metric Class Methods 
+
+=== ::new(ordering, pairing, scaling, delta) 
+
+Generates a new morphological metric based on various parameters
+
+**ordered**: can be true or false. Corresponds to ordered/unordered.
+
+**pairing**: Similar to the delta. If it is a Proc, then the pairing function is
+called on each vector (or however it is handled by the ordering). If it is a
+Symbol, then we look it up in MM::PAIRING_FUNCTIONS.
+
+**scaling**: *always* a Proc. There are prebaked scaling functions for absolute,
+relative, and unscaled that are available for use. If a Symbol is passed instead
+of a Proc, it looks for the Proc in the Hash MM::SCALING_FUNCTIONS
+
+**delta functions**: If it is a Proc, then the delta function is used as d(x, y)
+on each element. If it is a symbol, then the symbol is first looked up in the
+MM::DELTA_FUNCTIONS hash. If it is not found, then x.symbol(y) is attempted.
+Delta functions should aspire to being as general as possible; let the source
+implement the method.
+
+**order**: this is confusing terminology - first-order and second-order
+difference functions.
+
+**interval functions**: We should instead brew the int_func into the method of
+finding pairs. This is where the Pairs class might come in handy; it could
+generate functions (Procs, whatever) as a factory from various values, taking
+into account what each value should be compared to. It's not [element, element],
+but [element, comparison-element] that matters.
+
+=== ::olm(scaling, delta) 
+
+Generates a new morphological metric calling ::new with the given ordering and
+pairing
+

data/Rakefile

@@ -1,32 +1,32 @@
-# -*- ruby -*-
-
-require "rubygems"
-require "hoe"
-
-# Hoe.plugin :compiler
-# Hoe.plugin :gem_prelude_sucks
-# Hoe.plugin :racc
-# Hoe.plugin :rcov
-Hoe.plugin :flay
-Hoe.plugin :flog
-
-Hoe.plugin :travis
-Hoe.plugin :inline
-Hoe.plugin :minitest
-Hoe.plugin :package
-
-hoe = Hoe.spec "morphological_metrics" do |h|
-  developer("Andrew C. Smith", "andrewchristophersmith@gmail.com")
-  license "MIT" # this should match the license in the README
-  self.readme_file = "README.rdoc"
-  require_rubygems_version '>= 1.4'
-end
-
-if ENV['CODECLIMATE_REPO_TOKEN']
-  hoe.test_prelude = <<CC
-  require "codeclimate-test-reporter"
-  CodeClimate::TestReporter.start
-CC
-end
-
-# vim: syntax=ruby
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+
+# Hoe.plugin :compiler
+# Hoe.plugin :gem_prelude_sucks
+# Hoe.plugin :racc
+# Hoe.plugin :rcov
+Hoe.plugin :flay
+Hoe.plugin :flog
+
+Hoe.plugin :travis
+Hoe.plugin :inline
+Hoe.plugin :minitest
+Hoe.plugin :package
+
+hoe = Hoe.spec "morphological_metrics" do |h|
+  developer("Andrew C. Smith", "andrewchristophersmith@gmail.com")
+  license "MIT" # this should match the license in the README
+  self.readme_file = "README.rdoc"
+  require_rubygems_version '>= 1.4'
+end
+
+if ENV['CODECLIMATE_REPO_TOKEN']
+  hoe.test_prelude = <<CC
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+CC
+end
+
+# vim: syntax=ruby

data/bin/mm

@@ -1,3 +1,3 @@
-#!/usr/bin/env ruby
-
-abort "you need to write me"
+#!/usr/bin/env ruby
+
+abort "you need to write me"

data/lib/mm/deltas.rb

@@ -1,35 +1,35 @@
-module MM
-  module Deltas
-    def self.abs n
-      (n[0] - n[1]).abs
-    end
-
-    def self.diff n
-      n[0] - n[1]
-    end
-
-    def self.mean n
-      n.inject(0.0, :+) / n.size
-    end
-
-    # Have to scale by 0.5 in order to normalize to a max distance of 1.0
-    def self.direction n
-      (n[0] <=> n[1]) * 0.5
-    end
-
-    # Accepts a tuple where the quotient responds to #numerator and #denominator
-    def self.tenney n
-      ->(r) { Math.log2(r.numerator * r.denominator) }.call(n[0] / n[1])
-    end
-
-    # Accepts a tuple of anything that Math.log2 can handle
-    def self.log_ratio n
-      Math.log2((n[0] / n[1]).to_f).abs
-    end
-
-    def self.ratio n
-      n[0] / n[1]
-    end
-  end
-end
-
+module MM
+  module Deltas
+    def self.abs n
+      (n[0] - n[1]).abs
+    end
+
+    def self.diff n
+      n[0] - n[1]
+    end
+
+    def self.mean n
+      n.inject(0.0, :+) / n.size
+    end
+
+    # Have to scale by 0.5 in order to normalize to a max distance of 1.0
+    def self.direction n
+      (n[0] <=> n[1]) * 0.5
+    end
+
+    # Accepts a tuple where the quotient responds to #numerator and #denominator
+    def self.tenney n
+      ->(r) { Math.log2(r.numerator * r.denominator) }.call(n[0] / n[1])
+    end
+
+    # Accepts a tuple of anything that Math.log2 can handle
+    def self.log_ratio n
+      Math.log2((n[0] / n[1]).to_f).abs
+    end
+
+    def self.ratio n
+      n[0] / n[1]
+    end
+  end
+end
+