convolver 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa84808d5f3c0be7b1128732c98ffecbd71d1673
-  data.tar.gz: 91a4d77ad8feb496408251f688f2eeab0124c8a0
+  metadata.gz: 4c3bcf13a230b62ed29260b84490f720af3408cc
+  data.tar.gz: 3d00b5f4ece4078525b5d57fbe536d3dfcc6020e
 SHA512:
-  metadata.gz: 45559b58c01d30623707001ba3af4e442695d5108e6757f93a716d6683055ed7f07b95559bb010c42c9f7bb621c64895b01f82431301b8645a030303c40c33a5
-  data.tar.gz: 51db7895f0e8c07b4a4e47d20c6b242c6e4691ad838109afeb450aef8fad496c70bb1ff15759afe38276f329a7efec0b8123ea4e8e7334ad554ed07b786c0b3c
+  metadata.gz: 113c51e9233dabd6d94490b1906e31787f0fc9e7826bacf8b999c2c63e2722381baf417c616519735456f286c781e2597547b9851e77addd8267ec87c38947c2
+  data.tar.gz: 2495231401448636a915562cf6ad09ba4351094a4af290b0d0a84ee5a7a313e57e1e2d8e07b70746b7ee60b1780ba6ed9e4e8c8c19518fa785d4c01e589b8258

data/.travis.yml

@@ -1,11 +1,19 @@
-before_install:
- - sudo apt-get update -qq
- - sudo apt-get install -qq libfftw3-dev
 language: ruby
+cache: bundler
+
+os:
+  - linux
+  - osx
+
+addons:
+  apt:
+    update: true
+    packages: libfftw3-dev
+  homebrew:
+    packages: fftw
+
 rvm:
-  - "1.8.7"
-  - "1.9.3"
-  - "2.0.0"
-  - rbx-18mode
-  - rbx-19mode
-  - ree
+  - "2.2.10"  
+  - "2.3.8"
+  - "2.4.5"
+  - "2.5.3"

data/README.md

@@ -2,7 +2,9 @@
 
 [![Gem Version](https://badge.fury.io/rb/convolver.png)](http://badge.fury.io/rb/convolver)
 [![Build Status](https://travis-ci.org/neilslater/convolver.png?branch=master)](http://travis-ci.org/neilslater/convolver)
-[![Dependency Status](https://gemnasium.com/neilslater/convolver.png)](https://gemnasium.com/neilslater/convolver)
+[![Coverage Status](https://coveralls.io/repos/neilslater/convolver/badge.png?branch=master)](https://coveralls.io/r/neilslater/convolver?branch=master)
+[![Inline docs](http://inch-ci.org/github/neilslater/convolver.png?branch=master)](http://inch-ci.org/github/neilslater/convolver)
+[![Code Climate](https://codeclimate.com/github/neilslater/convolver.png)](https://codeclimate.com/github/neilslater/convolver)
 
 Calculates discrete convolution between two multi-dimensional arrays of floats.
 See http://en.wikipedia.org/wiki/Convolution
@@ -51,11 +53,6 @@ small convolutions are processed directly by multiplying out all combinations an
 and large convolutions are processed using FFTW3 to convert to frequency space where convolution
 is simpler and faster to calculate, then convert back.
 
-## Convolutional Neural Nets
-
-Code for CNNs in Ruby, based on the convolve_basic method from this gem, is planned for a
-new gem ```co_ne_ne```.
-
 ## Contributing
 
 1. Fork it
@@ -63,3 +60,7 @@ new gem ```co_ne_ne```.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Contributors
+
+ * [Dima Ermilov](https://github.com/adworse) contributed fix to support compiling under Windows.

data/convolver.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard", ">= 0.8.7.2"
   spec.add_development_dependency "bundler", ">= 1.3"
   spec.add_development_dependency "rspec", ">= 2.13.0"
-  spec.add_development_dependency "mocha", ">= 0.14.0"
   spec.add_development_dependency "rake", ">= 1.9.1"
   spec.add_development_dependency "rake-compiler", ">= 0.8.3"
+  spec.add_development_dependency "coveralls", ">= 0.6.7"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/ext/convolver/extconf.rb

@@ -4,7 +4,11 @@ require "rubygems"
 
 # Following code stolen shamelessly from fftw3 gem:
 narray_dir = File.dirname(Gem.find_files("narray.h").first) rescue $sitearchdir
-dir_config('narray', narray_dir, narray_dir)
+if /cygwin|mingw/ =~ RUBY_PLATFORM
+  dir_config('narray', narray_dir, "#{narray_dir}/src")
+else
+  dir_config('narray', narray_dir, narray_dir)
+end
 
 if ( ! ( have_header("narray.h") && have_header("narray_config.h") ) ) then
    print <<-EOS

data/lib/convolver.rb

@@ -26,7 +26,8 @@ module Convolver
     end
 
     # Factor of two to allow for large uncertainty in predictions for FFTW3
-    if predict_convolve_fft_time( signal, kernel ) < 2 * basic_time_predicted
+    fft_time_predicted = predict_convolve_fft_time( signal, kernel )
+    if fft_time_predicted < 2 * basic_time_predicted
       return convolve_fftw3( signal, kernel )
     end
 
@@ -64,7 +65,7 @@ module Convolver
   # @param [NArray] kernel must be same size or smaller than signal in each dimension
   # @return [Float] rough estimate of time for convolution compared to baseline
   def self.predict_convolve_fft_time signal, kernel
-    16 * 4.55e-08 * combined_shape(signal.shape,kernel.shape).inject(1) { |t,x| t * x * Math.log(x) }
+    16 * 4.55e-08 * result_shape(signal.shape,kernel.shape).inject(1) { |t,x| t * x * Math.log(x) }
   end
 
   # A rough estimate of time that #convolve will take, based on complexity
@@ -84,15 +85,6 @@ module Convolver
     shape.inject(1) { |t,x| t * x }
   end
 
-  def self.combined_shape signal_shape, kernel_shape
-    combined_shape = [  ]
-    signal_shape.each_with_index do |signal_size, i|
-      kernel_size = kernel_shape[i]
-      combined_shape[i] = signal_size + kernel_size - 1
-    end
-    combined_shape
-  end
-
   def self.result_shape signal_shape, kernel_shape
     result_shape = [  ]
     signal_shape.each_with_index do |signal_size, i|

data/lib/convolver/version.rb

@@ -1,3 +1,3 @@
 module Convolver
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/spec/convolve_basic_spec.rb

@@ -7,14 +7,14 @@ describe Convolver do
       a = NArray[ 0.3, 0.4, 0.5 ]
       b = NArray[ 1.3, -0.5 ]
       c = Convolver.convolve_basic( a, b )
-      c.should be_narray_like NArray[ 0.19, 0.27 ]
+      expect( c ).to be_narray_like NArray[ 0.19, 0.27 ]
     end
 
     it "should calculate a 2D convolution" do
       a = NArray[ [ 0.3, 0.4, 0.5 ], [ 0.6, 0.8, 0.2 ], [ 0.9, 1.0, 0.1 ] ]
       b = NArray[ [ 1.2, -0.5 ], [ 0.5, -1.3 ] ]
       c = Convolver.convolve_basic( a, b )
-      c.should be_narray_like NArray[ [ -0.58, 0.37 ], [ -0.53, 1.23 ] ]
+      expect( c ).to be_narray_like NArray[ [ -0.58, 0.37 ], [ -0.53, 1.23 ] ]
     end
 
     it "should calculate a 2D convolution with rectangular arrays" do
@@ -23,7 +23,7 @@ describe Convolver do
         [ 0.4, 0.5, 0.6, 0.7, 0.8 ], [ 0.5, 0.4, 0.3, 0.2, 0.1 ] ]
       b = NArray[ [ 1.2, -0.5, 0.2 ], [ 1.8, 0.5, -1.3 ] ]
       c = Convolver.convolve_basic( a, b )
-      c.should be_narray_like NArray[ [ 1.48, 0.79, 1.03 ], [ 2.35, 1.7, -0.79 ], [ 1.56, 2.84, -0.53 ],
+      expect( c ).to be_narray_like NArray[ [ 1.48, 0.79, 1.03 ], [ 2.35, 1.7, -0.79 ], [ 1.56, 2.84, -0.53 ],
         [ 1.13, 1.3, 0.83 ], [ 1.04, 0.26, 0.77 ], [ 1.06, 1.05, 1.04 ] ]
     end
 
@@ -44,7 +44,7 @@ describe Convolver do
 
       # Should be 3x2x1
       c = Convolver.convolve_basic( a, b )
-      c.should be_narray_like NArray[ [ [ 5.51, 3.04, 4.3 ], [ 3.04, 6.31, 3.87 ] ] ]
+      expect( c ).to be_narray_like NArray[ [ [ 5.51, 3.04, 4.3 ], [ 3.04, 6.31, 3.87 ] ] ]
     end
 
     it "should calculate a 4D convolution" do
@@ -75,7 +75,7 @@ describe Convolver do
 
       # Should be 2x2x3x2
       c = Convolver.convolve_basic( a, b )
-      c.should be_narray_like NArray[
+      expect( c ).to be_narray_like NArray[
         [ [ [ 8.5, 8.2 ], [ 11.34, 9.68 ] ], [ [ 7.68, 6.56 ], [ 11.24, 7.16 ] ], [ [ 9.14, 6.54 ], [ 12.44, 9.2 ] ] ],
         [ [ [ 8.5, 8.2 ], [ 11.34, 9.68 ] ], [ [ 7.68, 6.56 ], [ 11.24, 7.16 ] ], [ [ 9.14, 6.54 ], [ 12.44, 9.2 ] ] ]
       ]

data/spec/convolve_fftw3_spec.rb

@@ -7,51 +7,51 @@ describe Convolver do
       a = NArray[ 0.3, 0.4, 0.5 ]
       b = NArray[ 1.3, -0.5 ]
       c = Convolver.convolve_fftw3( a, b )
-      c.should be_narray_like NArray[ 0.19, 0.27 ]
+      expect( c ).to be_narray_like NArray[ 0.19, 0.27 ]
     end
 
     it "should convolve 1D arrays with a variety of signal and kernel lengths" do
       a = NArray[ 0.3 ]
       b = NArray[ -0.7 ]
       c = Convolver.convolve_fftw3( a, b )
-      c.should be_narray_like NArray[ -0.21 ]
+      expect( c ).to be_narray_like NArray[ -0.21 ]
 
       a = NArray[ 0.3, 0.4, 0.5, 0.2 ]
       b = NArray[ -0.7 ]
       c = Convolver.convolve_fftw3( a, b )
-      c.should be_narray_like NArray[ -0.21, -0.28, -0.35, -0.14 ]
+      expect( c ).to be_narray_like NArray[ -0.21, -0.28, -0.35, -0.14 ]
 
       a = NArray[ 0.3, 0.4, 0.5, 0.2 ]
       b = NArray[ 1.1, -0.7 ]
       c = Convolver.convolve_fftw3( a, b )
-      c.should be_narray_like NArray[ 0.05, 0.09, 0.41 ]
+      expect( c ).to be_narray_like NArray[ 0.05, 0.09, 0.41 ]
 
       a = NArray[ 0.3, 0.4, 0.5, 0.2 ]
       b = NArray[ 1.1, -0.7, -0.2 ]
       c = Convolver.convolve_fftw3( a, b )
-      c.should be_narray_like NArray[ -0.05, 0.05 ]
+      expect( c ).to be_narray_like NArray[ -0.05, 0.05 ]
 
       a = NArray[ 0.3, 0.4, 0.5, 0.2, 0.6 ]
       b = NArray[ 1.1, -0.7 ]
       c = Convolver.convolve_fftw3( a, b )
-      c.should be_narray_like NArray[ 0.05, 0.09, 0.41, -0.2 ]
+      expect( c ).to be_narray_like NArray[ 0.05, 0.09, 0.41, -0.2 ]
 
       a = NArray[ 0.3, 0.4, 0.5, 0.2, 0.6 ]
       b = NArray[ 1.1, -0.7, 2.1 ]
       c = Convolver.convolve_fftw3( a, b )
-      c.should be_narray_like NArray[ 1.1, 0.51, 1.67 ]
+      expect( c ).to be_narray_like NArray[ 1.1, 0.51, 1.67 ]
 
       a = NArray[ 0.3, 0.4, 0.5, 0.2, 0.6 ]
       b = NArray[ 0.6, -0.5, -0.4, 0.7 ]
       c = Convolver.convolve_fftw3( a, b )
-      c.should be_narray_like NArray[ -0.08, 0.33 ]
+      expect( c ).to be_narray_like NArray[ -0.08, 0.33 ]
     end
 
     it "should calculate a 2D convolution" do
       a = NArray[ [ 0.3, 0.4, 0.5 ], [ 0.6, 0.8, 0.2 ], [ 0.9, 1.0, 0.1 ] ]
       b = NArray[ [ 1.2, -0.5 ], [ 0.5, -1.3 ] ]
       c = Convolver.convolve_fftw3( a, b )
-      c.should be_narray_like NArray[ [ -0.58, 0.37 ], [ -0.53, 1.23 ] ]
+      expect( c ).to be_narray_like NArray[ [ -0.58, 0.37 ], [ -0.53, 1.23 ] ]
     end
 
     it "should calculate a 3D convolution" do
@@ -71,7 +71,7 @@ describe Convolver do
 
       # Should be 3x2x1
       c = Convolver.convolve_fftw3( a, b )
-      c.should be_narray_like NArray[ [ [ 5.51, 3.04, 4.3 ], [ 3.04, 6.31, 3.87 ] ] ]
+      expect( c ).to be_narray_like NArray[ [ [ 5.51, 3.04, 4.3 ], [ 3.04, 6.31, 3.87 ] ] ]
     end
 
     it "should calculate a 4D convolution" do
@@ -102,7 +102,7 @@ describe Convolver do
 
       # Should be 2x2x3x2
       c = Convolver.convolve_fftw3( a, b )
-      c.should be_narray_like NArray[
+      expect( c ).to be_narray_like NArray[
         [ [ [ 8.5, 8.2 ], [ 11.34, 9.68 ] ], [ [ 7.68, 6.56 ], [ 11.24, 7.16 ] ], [ [ 9.14, 6.54 ], [ 12.44, 9.2 ] ] ],
         [ [ [ 8.5, 8.2 ], [ 11.34, 9.68 ] ], [ [ 7.68, 6.56 ], [ 11.24, 7.16 ] ], [ [ 9.14, 6.54 ], [ 12.44, 9.2 ] ] ]
       ]
@@ -116,7 +116,7 @@ describe Convolver do
             kernel = NArray.sfloat(kernel_length).random()
             expect_result = Convolver.convolve_basic( signal, kernel )
             got_result = Convolver.convolve_fftw3( signal, kernel )
-            got_result.should be_narray_like expect_result
+            expect( got_result ).to be_narray_like expect_result
           end
         end
       end
@@ -130,7 +130,7 @@ describe Convolver do
                 kernel = NArray.sfloat(kernel_x,kernel_y).random()
                 expect_result = Convolver.convolve_basic( signal, kernel )
                 got_result = Convolver.convolve_fftw3( signal, kernel )
-                got_result.should be_narray_like expect_result
+                expect( got_result ).to be_narray_like expect_result
               end
             end
           end
@@ -148,7 +148,7 @@ describe Convolver do
                     kernel = NArray.sfloat(kernel_x,kernel_y,kernel_z).random()
                     expect_result = Convolver.convolve_basic( signal, kernel )
                     got_result = Convolver.convolve_fftw3( signal, kernel )
-                    got_result.should be_narray_like expect_result
+                    expect( got_result ).to be_narray_like expect_result
                   end
                 end
               end

data/spec/convolve_spec.rb

@@ -7,22 +7,40 @@ describe Convolver do
       a = NArray[ 0.3, 0.4, 0.5 ]
       b = NArray[ 1.3, -0.5 ]
       c = Convolver.convolve( a, b )
-      c.should be_narray_like NArray[ 0.19, 0.27 ]
+      expect( c ).to be_narray_like NArray[ 0.19, 0.27 ]
+    end
+
+    it "should process convolutions of different sizes" do
+      # The variety here is to ensure all branches of optimisation algorithm
+      # are covered
+      [10,30,60,90,100,120,130,150,175,200].each do |asize|
+        [5,10,12,15,20,30,40,50].each do |bsize|
+          next unless bsize < asize
+          a = NArray.sfloat(asize,asize).random()
+          b = NArray.sfloat(bsize,bsize).random()
+          c = Convolver.convolve( a, b )
+
+          # We should always match output of convolve_basic irrespective
+          # of what the optimal choice of algorithm is (larger error allowed here due to rounding)
+          expect_result = Convolver.convolve_basic( a, b )
+          expect( c ).to be_narray_like( expect_result, 1e-6 )
+        end
+      end
     end
 
     it "should choose #convolve_basic for small inputs" do
       a = NArray.sfloat(50,50).random()
       b = NArray.sfloat(10,10).random()
-      Convolver.expects( :convolve_basic ).once
-      Convolver.expects( :convolve_fftw3 ).never
+      expect(Convolver).to receive(:convolve_basic).once
+      expect(Convolver).to_not receive(:convolve_fftw3)
       c = Convolver.convolve( a, b )
     end
 
     it "should choose #convolve_fftw3 for large inputs" do
       a = NArray.sfloat(500,500).random()
       b = NArray.sfloat(100,100).random()
-      Convolver.expects( :convolve_basic ).never
-      Convolver.expects( :convolve_fftw3 ).once
+      expect(Convolver).to receive(:convolve_fftw3).once
+      expect(Convolver).to_not receive(:convolve_basic)
       c = Convolver.convolve( a, b )
     end
 

data/spec/helpers.rb

@@ -1,9 +1,12 @@
 # convolver/spec/helpers.rb
+require 'coveralls'
+
+Coveralls.wear!
+
 require 'convolver'
-require 'mocha/api'
 
 # Matcher compares NArrays numerically
-RSpec::Matchers.define :be_narray_like do |expected_narray|
+RSpec::Matchers.define :be_narray_like do |expected_narray, mse = 1e-9|
   match do |given|
     @error = nil
     if ! given.is_a?(NArray)
@@ -13,7 +16,7 @@ RSpec::Matchers.define :be_narray_like do |expected_narray|
     else
       d = given - expected_narray
       difference =  ( d * d ).sum / d.size
-      if difference > 1e-9
+      if difference > mse
         @error = "Numerical difference with mean square error #{difference}"
       end
     end
@@ -26,13 +29,13 @@ RSpec::Matchers.define :be_narray_like do |expected_narray|
     ! @error
   end
 
-  failure_message_for_should do
+  failure_message do
     "NArray does not match supplied example. #{@error}
     Expected: #{@expected.inspect}
     Got: #{@given.inspect}"
   end
 
-  failure_message_for_should_not do
+  failure_message_when_negated do
     "NArray is too close to unwanted example.
     Unwanted: #{@given.inspect}"
   end

metadata

@@ -1,127 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: convolver
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Neil Slater
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2018-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: narray
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0.8
 - !ruby/object:Gem::Dependency
   name: fftw3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.7.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.13.0
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.9.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.6.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.6.7
 description: Convolution for NArray
 email:
 - slobo777@gmail.com
@@ -130,8 +130,8 @@ extensions:
 - ext/convolver/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -159,17 +159,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Convolution for NArray
@@ -178,4 +178,3 @@ test_files:
 - spec/convolve_fftw3_spec.rb
 - spec/convolve_spec.rb
 - spec/helpers.rb
-has_rdoc: