convolver-light 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e80f99f8aa860c6a95429b390c2d3915319ec1ce740ec29c4bbf3d60253ee2ee
+  data.tar.gz: 47337ccc67b933083cd3cdaf517171c63477773917c2a9fa19b0584d3e35da5c
+SHA512:
+  metadata.gz: bc24eadf42dc390dbd7ef993fab2bbffb1648b9a51619d40dc41232b760beb6f67342e5dd9b5f477ca1c9909c0b9afb588cb753a7d7d0ff350b1b5567485e04c
+  data.tar.gz: 12be9439142f8e25a7f69541faa5ae94f524d53da839892af4fac3af88f42261453410245bc5bfb3684595f5bcdaf8941214948c9cf890fb359be30f3821cfa1

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+lib/convolver/*.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+benchmarks
+.DS_Store
+._.DS_Store
+**/.DS_Store
+**/._.DS_Store

data/.travis.yml

@@ -0,0 +1,10 @@
+before_install:
+ - sudo apt-get update -qq
+ - sudo apt-get install -qq libfftw3-dev
+ - gem install bundler
+language: ruby
+rvm:
+  - "2.1.4"
+  - "2.2.0"  
+  - "2.3.1"
+  - "2.4.1"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in convolver.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Neil Slater
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,34 @@
+# Convolver-Light
+
+This is native-only version of [neilslater's](https://github.com/neilslater) [Convolver Gem](https://github.com/neilslater/convolver)
+
+FFTW3 dependency is removed, so calculations would be slow on big matrices. Use it only if you need to make a convolution with a small kernel.
+
+All the credits to the [author](https://github.com/neilslater)
+
+### Installing the gem
+
+Add this line to your application's Gemfile:
+
+    gem 'convolver-light'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install convolver-light
+
+## Usage
+
+    require 'convolver-light
+
+Usage is exactly the same as of original gem, please refer to the [author's page](https://github.com/neilslater/convolver)
+
+```
+a = NArray[0.3,0.4,0.5]
+b = NArray[1.3, -0.5]
+c = Convolver.convolve( a, b )
+=> NArray.float(2): [ 0.19, 0.27 ]
+```

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rake/extensiontask'
+
+desc "Convolver unit tests"
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = "spec/*_spec.rb"
+  t.verbose = true
+end
+
+gemspec = Gem::Specification.load('convolver-light.gemspec')
+Rake::ExtensionTask.new do |ext|
+  ext.name = 'convolver'
+  ext.source_pattern = "*.{c,h}"
+  ext.ext_dir = 'ext/convolver'
+  ext.lib_dir = 'lib/convolver'
+  ext.gem_spec = gemspec
+end
+
+task :default => [:compile, :test]

data/convolver-light.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'convolver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'convolver-light'
+  spec.version       = Convolver::VERSION
+  spec.authors       = ['Dima Ermilov']
+  spec.email         = ['dima@scriptangle.com']
+  spec.description   = 'Simplification of convolver gem, FFTW removed, suitable only for smaller kernels. Convolver gem author is Neil Slater, slobo777@gmail.com, https://github.com/neilslater'
+  spec.summary       = 'Convolution for NArray simplified.'
+  spec.homepage      = 'http://github.com/adworse/convolver-light'
+  spec.license       = 'MIT'
+
+  spec.add_dependency "narray", ">= 0.6.0.8"
+
+  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 "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) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.extensions    = spec.files.grep(%r{/extconf\.rb$})
+  spec.require_paths = ["lib"]
+end

data/ext/convolver/convolve_raw.c

@@ -0,0 +1,107 @@
+// ext/convolver/convolve_raw.c
+
+#include "convolve_raw.h"
+
+inline int size_from_shape( int rank, int *shape ) {
+  int size = 1;
+  int i;
+  for ( i = 0; i < rank; i++ ) { size *= shape[i]; }
+  return size;
+}
+
+// Sets reverse indices
+inline void corner_reset( int rank, int *shape, int *rev_indices ) {
+  int i;
+  for ( i = 0; i < rank; i++ ) { rev_indices[i] = shape[i] - 1; }
+  return;
+}
+
+// Counts indices down, returns number of ranks that reset
+inline int corner_dec( int rank, int *shape, int *rev_indices ) {
+  int i = 0;
+  while ( ! rev_indices[i]-- ) {
+    rev_indices[i] = shape[i] - 1;
+    i++;
+  }
+  return i;
+}
+
+// Generates co-increment steps by rank boundaries crossed, for the outer position as inner position is incremented by 1
+inline void calc_co_increment( int rank, int *outer_shape, int *inner_shape, int *co_increment ) {
+  int i, factor;
+  co_increment[0] = 1; // co-increment is always 1 in lowest rank
+  factor = 1;
+  for ( i = 0; i < rank; i++ ) {
+    co_increment[i+1] = co_increment[i] + factor * ( outer_shape[i] - inner_shape[i] );
+    factor *= outer_shape[i];
+  }
+}
+
+////////////////////////////////////////////////////////////////////////////////////////////////////
+//
+//  Convolve
+//
+//    Benchmark: 640x480 image, 8x8 kernel, 1000 iterations. 12.3 seconds.
+//
+
+void convolve_raw(
+    int in_rank, int *in_shape, float *in_ptr,
+    int kernel_rank, int *kernel_shape, float *kernel_ptr,
+    int out_rank, int *out_shape, float *out_ptr ) {
+  int i, j, in_size, kernel_size, kernel_aligned, out_size, offset;
+  int out_co_incr[LARGEST_RANK], kernel_co_incr[LARGEST_RANK];
+  int ker_q[LARGEST_RANK], out_q[LARGEST_RANK];
+  int *kernel_co_incr_cache;
+
+  in_size = size_from_shape( in_rank, in_shape );
+  kernel_size = size_from_shape( kernel_rank, kernel_shape );
+  kernel_aligned = 4 * (kernel_size/4);
+  out_size = size_from_shape( out_rank, out_shape );
+
+  calc_co_increment( in_rank, in_shape, out_shape, out_co_incr );
+  calc_co_increment( in_rank, in_shape, kernel_shape, kernel_co_incr );
+
+  kernel_co_incr_cache = ALLOC_N( int, kernel_size );
+  kernel_co_incr_cache[0] = 0;
+
+  corner_reset( kernel_rank, kernel_shape, ker_q );
+  for ( i = 1; i < kernel_size; i++ ) {
+    kernel_co_incr_cache[i] = kernel_co_incr_cache[i-1] + kernel_co_incr[ corner_dec( kernel_rank, kernel_shape, ker_q  ) ];
+  }
+
+  // For convenience of flow, we set offset to -1 and adjust countdown 1 higher to compensate
+  offset = -1;
+  corner_reset( out_rank, out_shape, out_q );
+  out_q[0]++;
+
+  // Main convolve loop
+  for ( i = 0; i < out_size; i++ ) {
+    __m128 simd_x, simd_y, simd_t;
+    float t = 0.0;
+    float v[4];
+    simd_t = _mm_setzero_ps();
+
+    offset += out_co_incr[ corner_dec( out_rank, out_shape, out_q ) ];
+
+    // Use SIMD for all the aligned values in groups of 4
+    for ( j = 0; j < kernel_aligned; j +=4 ) {
+      simd_x = _mm_load_ps( kernel_ptr + j );
+      // Yes the backwards alignment is correct
+      simd_y = _mm_set_ps( in_ptr[ offset + kernel_co_incr_cache[j+3] ], in_ptr[ offset + kernel_co_incr_cache[j+2] ],
+                           in_ptr[ offset + kernel_co_incr_cache[j+1] ], in_ptr[ offset + kernel_co_incr_cache[j] ] );
+      simd_x = _mm_mul_ps( simd_x, simd_y );
+      simd_t = _mm_add_ps( simd_x, simd_t );
+    }
+    _mm_store_ps( v, simd_t );
+
+    // Complete any remaining 1,2 or 3 items one at a time
+    for ( j = kernel_aligned; j < kernel_size; j++ ) {
+      t += in_ptr[ offset + kernel_co_incr_cache[j] ] * kernel_ptr[ j ];
+    }
+
+    out_ptr[i] = v[0] + v[1] + v[2] + v[3] + t;
+  }
+
+  xfree( kernel_co_incr_cache );
+  return;
+}

data/ext/convolver/convolve_raw.h

@@ -0,0 +1,22 @@
+// ext/convolver/convolve_raw.h
+
+////////////////////////////////////////////////////////////////////////////////////////////////
+//
+// Declarations of narray helper functions
+//
+
+#ifndef CONVOLVE_RAW_H
+#define CONVOLVE_RAW_H
+
+#include <ruby.h>
+#include <xmmintrin.h>
+#include "narray_shared.h"
+
+#define LARGEST_RANK 16
+
+void convolve_raw(
+    int in_rank, int *in_shape, float *in_ptr,
+    int kernel_rank, int *kernel_shape, float *kernel_ptr,
+    int out_rank, int *out_shape, float *out_ptr );
+
+#endif

data/ext/convolver/convolver.c

@@ -0,0 +1,119 @@
+// ext/convolver/convolver.c
+
+#include <ruby.h>
+#include "narray.h"
+#include <stdio.h>
+#include <xmmintrin.h>
+
+#include "narray_shared.h"
+#include "convolve_raw.h"
+
+////////////////////////////////////////////////////////////////////////////////////////////////////
+
+// To hold the module object
+VALUE Convolver = Qnil;
+
+/* @overload fit_kernel_backwards( fft_temp_space, kernel )
+ * @!visibility private
+ * Over-writes fft_temp_space at edges with a reversed copy of kernel, in such a way that
+ * an FFTW3-based convolve has a result set in an easy-to-extract position later. This is
+ * implemented as a native extension for convenience and speed - to do this with methods provided
+ * by narray gem would take several complex steps and be inefficient.
+ * @param [NArray<sfloat>] fft_temp_space target array for pre-fft copy of kernel, is over-written
+ * @param [NArray] kernel must be same size or smaller than fft_temp_space in each dimension
+ * @return [nil]
+ */
+static VALUE narray_fit_backwards( VALUE self, VALUE a, VALUE b ) {
+  struct NARRAY *na_a, *na_b;
+  volatile VALUE val_a, val_b;
+  int target_rank, i;
+  int shift_by[LARGEST_RANK];
+
+  val_a = na_cast_object(a, NA_SFLOAT);
+  GetNArray( val_a, na_a );
+
+  val_b = na_cast_object(b, NA_SFLOAT);
+  GetNArray( val_b, na_b );
+
+  if ( na_a->rank != na_b->rank ) {
+    rb_raise( rb_eArgError, "narray a must have equal rank to narray b (a rank %d, b rank %d)", na_a->rank,  na_b->rank );
+  }
+
+  if ( na_a->rank > LARGEST_RANK ) {
+    rb_raise( rb_eArgError, "exceeded maximum narray rank for convolve of %d", LARGEST_RANK );
+  }
+
+  target_rank = na_a->rank;
+
+  for ( i = 0; i < target_rank; i++ ) {
+    if ( ( na_a->shape[i] - na_b->shape[i] ) < 0 ) {
+      rb_raise( rb_eArgError, "no space for backward fit" );
+    }
+    shift_by[i] = na_b->shape[i] >> 1;
+  }
+
+  fit_backwards_raw(
+    target_rank,
+    na_a->shape, (float*) na_a->ptr,
+    na_b->shape, (float*) na_b->ptr,
+    shift_by );
+
+  return Qnil;
+}
+
+
+/* @overload convolve_basic( signal, kernel )
+ * Calculates convolution of an array of floats representing a signal, with a second array representing
+ * a kernel. The two parameters must have the same rank. The output has same rank, its size in each dimension d is given by
+ *  signal.shape[d] - kernel.shape[d] + 1
+ * @param [NArray] signal must be same size or larger than kernel in each dimension
+ * @param [NArray] kernel must be same size or smaller than signal in each dimension
+ * @return [NArray] result of convolving signal with kernel
+ */
+static VALUE narray_convolve( VALUE self, VALUE a, VALUE b ) {
+  struct NARRAY *na_a, *na_b, *na_c;
+  volatile VALUE val_a, val_b, val_c;
+  int target_rank, i;
+  int target_shape[LARGEST_RANK];
+
+  val_a = na_cast_object(a, NA_SFLOAT);
+  GetNArray( val_a, na_a );
+
+  val_b = na_cast_object(b, NA_SFLOAT);
+  GetNArray( val_b, na_b );
+
+  if ( na_a->rank != na_b->rank ) {
+    rb_raise( rb_eArgError, "narray a must have equal rank to narray b (a rack %d, b rank %d)", na_a->rank,  na_b->rank );
+  }
+
+  if ( na_a->rank > LARGEST_RANK ) {
+    rb_raise( rb_eArgError, "exceeded maximum narray rank for convolve of %d", LARGEST_RANK );
+  }
+
+  target_rank = na_a->rank;
+
+  for ( i = 0; i < target_rank; i++ ) {
+    target_shape[i] = na_a->shape[i] - na_b->shape[i] + 1;
+    if ( target_shape[i] < 1 ) {
+      rb_raise( rb_eArgError, "narray b is bigger in one or more dimensions than narray a" );
+    }
+  }
+
+  val_c = na_make_object( NA_SFLOAT, target_rank, target_shape, CLASS_OF( val_a ) );
+  GetNArray( val_c, na_c );
+
+  convolve_raw(
+    target_rank, na_a->shape, (float*) na_a->ptr,
+    target_rank, na_b->shape, (float*) na_b->ptr,
+    target_rank, target_shape, (float*) na_c->ptr );
+
+  return val_c;
+}
+
+void Init_convolver() {
+  Convolver = rb_define_module( "Convolver" );
+  rb_define_singleton_method( Convolver, "convolve_basic", narray_convolve, 2 );
+
+  // private method
+  rb_define_singleton_method( Convolver, "fit_kernel_backwards", narray_fit_backwards, 2 );
+}

data/ext/convolver/extconf.rb

@@ -0,0 +1,27 @@
+# ext/convolver/extconf.rb
+require "mkmf"
+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 ( ! ( have_header("narray.h") && have_header("narray_config.h") ) ) then
+   print <<-EOS
+   ** configure error **
+   Header narray.h or narray_config.h is not found. If you have these files in
+   /narraydir/include, try the following:
+
+   % ruby extconf.rb --with-narray-include=/narraydir/include
+
+EOS
+   exit(-1)
+end
+
+# This also stolen from fftw3 gem (and not confirmed for Windows platforms - please let me know if it works!)
+if /cygwin|mingw/ =~ RUBY_PLATFORM
+   have_library("narray") || raise("ERROR: narray library is not found")
+end
+
+$CFLAGS << ' -O3 -funroll-loops'
+create_makefile( 'convolver/convolver' )

data/ext/convolver/narray_shared.c

@@ -0,0 +1,61 @@
+// ext/convolver/narray_shared.c
+
+#include "narray_shared.h"
+
+// This is copied from na_array.c, with safety checks and temp vars removed
+int na_quick_idxs_to_pos( int rank, int *shape, int *idxs ) {
+  int i, pos = 0;
+  for ( i = rank - 1; i >= 0; i-- ) {
+    pos = pos * shape[i] + idxs[i];
+  }
+  return pos;
+}
+
+// This is inverse of above
+void na_quick_pos_to_idxs( int rank, int *shape, int pos, int *idxs ) {
+  int i;
+  for ( i = 0; i < rank; i++ ) {
+    idxs[ i ] = pos % shape[i];
+    pos /= shape[i];
+  }
+  return;
+}
+
+// This is copied from na_array.c, with safety checks and temp vars removed
+inline int na_inline_idxs_to_pos( int rank, int *shape, int *idxs ) {
+  int i, pos = 0;
+  for ( i = rank - 1; i >= 0; i-- ) {
+    pos = pos * shape[i] + idxs[i];
+  }
+  return pos;
+}
+
+// This is inverse of above
+inline void na_inline_pos_to_idxs( int rank, int *shape, int pos, int *idxs ) {
+  int i;
+  for ( i = 0; i < rank; i++ ) {
+    idxs[ i ] = pos % shape[i];
+    pos /= shape[i];
+  }
+  return;
+}
+
+// used to place kernel data into array for FFTW3 processing
+void fit_backwards_raw( int rank, int *dst_shape, float *dst, int *src_shape, float *src, int *shift_shape ) {
+  int i, j, size, x;
+  int k_idx[16], dst_idx[16];
+
+  size = 1;
+  for ( j = 0; j < rank; j++ ) { size *= src_shape[j]; }
+
+  for ( i = 0; i < size; i++ ) {
+    na_inline_pos_to_idxs( rank, src_shape, i, k_idx );
+    for ( j = 0; j < rank; j++ ) {
+      x =  src_shape[j] - shift_shape[j] - k_idx[j] - 1;
+      if ( x < 0 ) x = x + dst_shape[j];
+      dst_idx[j] = x;
+    }
+    dst[ na_inline_idxs_to_pos( rank, dst_shape, dst_idx ) ] = src[i];
+  }
+  return;
+}

data/ext/convolver/narray_shared.h

@@ -0,0 +1,22 @@
+// ext/convolver/narray_shared.h
+
+////////////////////////////////////////////////////////////////////////////////////////////////
+//
+// Declarations of narray helper functions
+//
+
+#ifndef CONVOLVER_NARRAY_SHARED_H
+#define CONVOLVER_NARRAY_SHARED_H
+
+#include <ruby.h>
+#include "narray.h"
+
+// This is copied from na_array.c, with safety checks and temp vars removed
+int na_quick_idxs_to_pos( int rank, int *shape, int *idxs );
+
+// This is inverse of above
+void na_quick_pos_to_idxs( int rank, int *shape, int pos, int *idxs );
+
+void fit_backwards_raw( int rank, int *dst_shape, float *dst, int *src_shape, float *src, int *shift_shape );
+
+#endif

data/lib/convolver-light.rb

@@ -0,0 +1,15 @@
+require 'narray'
+require "convolver/convolver"
+require "convolver/version"
+
+module Convolver
+  # The two parameters must have the same rank. The output has same rank, its size in each
+  # dimension d is given by
+  #  signal.shape[d] - kernel.shape[d] + 1
+  # @param [NArray] signal must be same size or larger than kernel in each dimension
+  # @param [NArray] kernel must be same size or smaller than signal in each dimension
+  # @return [NArray] result of convolving signal with kernel
+  def self.convolve(signal, kernel)
+    convolve_basic signal, kernel
+  end
+end

data/lib/convolver/version.rb

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

data/spec/convolve_basic_spec.rb

@@ -0,0 +1,84 @@
+require 'helpers'
+
+describe Convolver do
+  describe "#convolve_basic" do
+
+    it "should work like the example in the README" do
+      a = NArray[ 0.3, 0.4, 0.5 ]
+      b = NArray[ 1.3, -0.5 ]
+      c = Convolver.convolve_basic( a, b )
+      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 )
+      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
+      a = NArray[ [ 0.3, 0.4, 0.5, 0.3, 0.4 ], [ 0.6, 0.8, 0.2, 0.8, 0.2 ],
+        [ 0.9, 1.0, 0.1, 0.9, 1.0 ], [ 0.5, 0.9, 0.3, 0.2, 0.8 ], [ 0.7, 0.1, 0.3, 0.0, 0.1 ],
+        [ 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 )
+      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
+
+    it "should calculate a 3D convolution" do
+      # 5x4x3
+      a = NArray[
+        [ [ 1.0, 0.6, 1.1, 0.2, 0.9 ], [ 1.0, 0.7, 0.8, 1.0, 1.0 ], [ 0.2, 0.6, 0.1, 0.2, 0.5 ], [ 0.5, 0.9, 0.2, 0.1, 0.6 ] ],
+        [ [ 0.4, 0.9, 0.4, 0.0, 0.6 ], [ 0.2, 1.1, 0.2, 0.4, 0.1 ], [ 0.4, 0.2, 0.5, 0.8, 0.7 ], [ 0.1, 0.9, 0.7, 0.1, 0.3 ] ],
+        [ [ 0.8, 0.6, 1.0, 0.1, 0.4 ], [ 0.3, 0.8, 0.6, 0.7, 1.1 ], [ 0.9, 1.0, 0.3, 0.4, 0.6 ], [ 0.2, 0.5, 0.4, 0.7, 0.2 ] ]
+      ]
+
+      # 3x3x3
+      b = NArray[
+        [ [ -0.9, 1.2, 0.8  ], [ 0.9, 0.1, -0.5 ], [ 1.1, 0.1, -1.1 ] ],
+        [ [ -0.2, -1.0, 1.4 ], [ -1.4, 0.0, 1.3 ], [ 0.3, 1.0, -0.5 ] ],
+        [ [ 0.6, 0.0, 0.7 ],   [ -0.7, 1.1, 1.2 ], [ 1.3, 0.7, 0.0  ] ]
+      ]
+
+      # Should be 3x2x1
+      c = Convolver.convolve_basic( a, b )
+      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
+      # 3x4x5x3
+      a = NArray[
+        [ [ [ 0.5, 0.4, 0.9 ], [ 0.1, 0.9, 0.8 ], [ 0.4, 0.0, 0.1 ], [ 0.8, 0.3, 0.4 ] ],
+          [ [ 0.0, 0.4, 0.0 ], [ 0.2, 0.3, 0.8 ], [ 0.6, 0.3, 0.2 ], [ 0.7, 0.4, 0.3 ] ],
+          [ [ 0.3, 0.3, 0.1 ], [ 0.6, 0.9, 0.4 ], [ 0.4, 0.0, 0.1 ], [ 0.8, 0.3, 0.4 ] ],
+          [ [ 0.0, 0.4, 0.0 ], [ 0.2, 0.3, 0.8 ], [ 0.6, 0.3, 0.2 ], [ 0.7, 0.4, 0.3 ] ],
+          [ [ 0.3, 0.3, 0.1 ], [ 0.6, 0.9, 0.4 ], [ 0.4, 0.0, 0.1 ], [ 0.8, 0.3, 0.4 ] ] ],
+        [ [ [ 0.5, 0.4, 0.9 ], [ 0.1, 0.9, 0.8 ], [ 0.4, 0.0, 0.1 ], [ 0.8, 0.3, 0.4 ] ],
+          [ [ 0.0, 0.4, 0.0 ], [ 0.2, 0.3, 0.8 ], [ 0.6, 0.3, 0.2 ], [ 0.7, 0.4, 0.3 ] ],
+          [ [ 0.3, 0.3, 0.1 ], [ 0.6, 0.9, 0.4 ], [ 0.4, 0.0, 0.1 ], [ 0.8, 0.3, 0.4 ] ],
+          [ [ 0.0, 0.4, 0.0 ], [ 0.2, 0.3, 0.8 ], [ 0.6, 0.3, 0.2 ], [ 0.7, 0.4, 0.3 ] ],
+          [ [ 0.3, 0.3, 0.1 ], [ 0.6, 0.9, 0.4 ], [ 0.4, 0.0, 0.1 ], [ 0.8, 0.3, 0.4 ] ] ],
+        [ [ [ 0.5, 0.4, 0.9 ], [ 0.1, 0.9, 0.8 ], [ 0.4, 0.0, 0.1 ], [ 0.8, 0.3, 0.4 ] ],
+          [ [ 0.0, 0.4, 0.0 ], [ 0.2, 0.3, 0.8 ], [ 0.6, 0.3, 0.2 ], [ 0.7, 0.4, 0.3 ] ],
+          [ [ 0.3, 0.3, 0.1 ], [ 0.6, 0.9, 0.4 ], [ 0.4, 0.0, 0.1 ], [ 0.8, 0.3, 0.4 ] ],
+          [ [ 0.0, 0.4, 0.0 ], [ 0.2, 0.3, 0.8 ], [ 0.6, 0.3, 0.2 ], [ 0.7, 0.4, 0.3 ] ],
+          [ [ 0.3, 0.3, 0.1 ], [ 0.6, 0.9, 0.4 ], [ 0.4, 0.0, 0.1 ], [ 0.8, 0.3, 0.4 ] ] ] ]
+
+      # 2x3x3x2
+      b = NArray[ [
+        [ [ 1.1, 0.6 ], [ 1.2, 0.6 ], [ 0.8, 0.1 ] ], [ [ -0.4, 0.8 ], [ 0.5, 0.4 ], [ 1.2, 0.2 ] ],
+        [ [ 0.8, 0.2 ], [ 0.5, 0.0 ], [ 1.4, 1.3 ] ] ],
+        [ [ [ 1.1, 0.6 ], [ 1.2, 0.6 ], [ 0.8, 0.1 ] ], [ [ -0.4, 0.8 ], [ 0.5, 0.4 ], [ 1.2, 0.2 ] ],
+        [ [ 0.8, 0.2 ], [ 0.5, 0.0 ], [ 1.4, 1.3 ] ] ] ]
+
+      # Should be 2x2x3x2
+      c = Convolver.convolve_basic( a, b )
+      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 ] ] ]
+      ]
+    end
+  end
+end

data/spec/convolve_spec.rb

@@ -0,0 +1,49 @@
+require 'helpers'
+
+describe Convolver do
+  describe "#convolve" do
+
+    it "should work like the example in the README" do
+      a = NArray[ 0.3, 0.4, 0.5 ]
+      b = NArray[ 1.3, -0.5 ]
+      c = Convolver.convolve( a, b )
+      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()
+      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()
+      expect(Convolver).to receive(:convolve_fftw3).once
+      expect(Convolver).to_not receive(:convolve_basic)
+      c = Convolver.convolve( a, b )
+    end
+
+  end
+
+end

data/spec/helpers.rb

@@ -0,0 +1,46 @@
+# convolver/spec/helpers.rb
+require 'coveralls'
+
+Coveralls.wear!
+
+require 'convolver'
+
+# Matcher compares NArrays numerically
+RSpec::Matchers.define :be_narray_like do |expected_narray, mse = 1e-9|
+  match do |given|
+    @error = nil
+    if ! given.is_a?(NArray)
+      @error = "Wrong class."
+    elsif given.shape != expected_narray.shape
+      @error = "Shapes are different."
+    else
+      d = given - expected_narray
+      difference =  ( d * d ).sum / d.size
+      if difference > mse
+        @error = "Numerical difference with mean square error #{difference}"
+      end
+    end
+    @given = given.clone
+
+    if @error
+      @expected = expected_narray.clone
+    end
+
+    ! @error
+  end
+
+  failure_message do
+    "NArray does not match supplied example. #{@error}
+    Expected: #{@expected.inspect}
+    Got: #{@given.inspect}"
+  end
+
+  failure_message_when_negated do
+    "NArray is too close to unwanted example.
+    Unwanted: #{@given.inspect}"
+  end
+
+  description do |given, expected|
+    "numerically very close to example"
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: convolver-light
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Dima Ermilov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-01 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: 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+description: Simplification of convolver gem, FFTW removed, suitable only for smaller
+  kernels. Convolver gem author is Neil Slater, slobo777@gmail.com, https://github.com/neilslater
+email:
+- dima@scriptangle.com
+executables: []
+extensions:
+- ext/convolver/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- convolver-light.gemspec
+- ext/convolver/convolve_raw.c
+- ext/convolver/convolve_raw.h
+- ext/convolver/convolver.c
+- ext/convolver/extconf.rb
+- ext/convolver/narray_shared.c
+- ext/convolver/narray_shared.h
+- lib/convolver-light.rb
+- lib/convolver/version.rb
+- spec/convolve_basic_spec.rb
+- spec/convolve_spec.rb
+- spec/helpers.rb
+homepage: http://github.com/adworse/convolver-light
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Convolution for NArray simplified.
+test_files:
+- spec/convolve_basic_spec.rb
+- spec/convolve_spec.rb
+- spec/helpers.rb