convolver 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 254fbf54caf7407108357aee612ab3c08af4ea4c
+  data.tar.gz: f4212255722174976e92c734b76ce956365ad936
+SHA512:
+  metadata.gz: 55d4082e492a48d09316cf4f6c0f44ad1dd5bae756fd9ef3d8890c592ed0c863029678eded0a3783559e7acfdb8ca9198ce3d4938c74174220f5452f35524d0d
+  data.tar.gz: 3a9ee78cb91ca935c83f0b56e93d58799871e97d5f8174ff9ba4e86ec798469dad6f3167482458c24f37bdf47aed4b6b5f5aaf6e658f9329e63aab16daa5743d

data/.gitignore

@@ -0,0 +1,18 @@
+*.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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.3"
+  - "2.0.0"
+  - rbx-18mode
+  - rbx-19mode
+  - ree

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,46 @@
+# Convolver
+
+[![Build Status](https://travis-ci.org/neilslater/convolver.png?branch=master)](http://travis-ci.org/neilslater/convolver)
+
+Adds an "inner" convolve operation to NArray floats. It is around 250 times faster than equivalents
+in pure Ruby.
+
+Note that convolves based on FFTW3 could well be faster still for large arrays with large kernels.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'convolver'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install convolver
+
+## Usage
+
+Basic convolution:
+
+    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 ]
+
+ * Convolver only works on single-precision floats internally. It will cast NArray types to this, if
+possible, prior to calculating.
+ * The convolution is an "inner" one. The output is smaller than the input, each dimension is reduced
+by 1 less than the width of the kernel in the same dimension.
+ * Convolver expects input a and kernel b to have the same rank, and for the kernel to be same size
+or smaller in all dimensions as the input.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

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.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/benchmarks/convolve_benchmark.rb

@@ -0,0 +1,17 @@
+require 'convolver'
+require 'narray'
+require 'benchmark'
+
+class Convolver2DBenchmark
+  attr_reader :image, :kernel
+
+  def initialize
+    @image = NArray.float(640, 480).random
+    @kernel = NArray.float(8, 8).random
+  end
+end
+
+Benchmark.bm do |x|
+  source = Convolver2DBenchmark.new
+  x.report('kilo') { 1000.times { Convolver.convolve( source.image, source.kernel ) } }
+end

data/convolver.gemspec

@@ -0,0 +1,29 @@
+# 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"
+  spec.version       = Convolver::VERSION
+  spec.authors       = ["Neil Slater"]
+  spec.email         = ["slobo777@gmail.com"]
+  spec.description   = %q{Convolution for NArray}
+  spec.summary       = %q{Convolution for NArray}
+  spec.homepage      = "http://github.com/neilslater/convolver"
+  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.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/convolver.c

@@ -0,0 +1,184 @@
+// ext/convolver/convolver.c
+
+#include <ruby.h>
+#include "narray.h"
+#include <stdio.h>
+#include <xmmintrin.h>
+
+#define LARGEST_RANK 16
+
+// This is copied from na_array.c, with safety checks and temp vars removed
+inline 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
+inline 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;
+}
+
+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 method 4.
+//
+//    Benchmark: 640x480 image, 8x8 kernel, 1000 iterations. 11.54 seconds. Score: 63
+//
+
+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;
+    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 );
+    }
+
+    // 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] = simd_t[0] + simd_t[1] + simd_t[2] + simd_t[3] + t;
+  }
+
+  xfree( kernel_co_incr_cache );
+  return;
+}
+
+
+////////////////////////////////////////////////////////////////////////////////////////////////////
+
+// To hold the module object
+VALUE Convolver = Qnil;
+
+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 b must have equal or lower rank than narray a" );
+  }
+
+  if ( na_a->rank < na_b->rank ) {
+    rb_raise( rb_eArgError, "narray a must have equal rank to narray b (temporary restriction)" );
+  }
+
+  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", narray_convolve, 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/lib/convolver.rb

@@ -0,0 +1,11 @@
+require 'narray'
+require "convolver/convolver"
+require "convolver/version"
+
+module Convolver
+  # Calculates float convolution of an array with a kernel
+  # @param [NArray] a outer array
+  # @param [NArray] b kernel
+  # @return [NArray] result of convolving a with b
+  # @!parse def self.convolve(a,b); end
+end

data/lib/convolver/version.rb

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

data/spec/convolver_spec.rb

@@ -0,0 +1,84 @@
+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 )
+      c.should 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( a, b )
+      c.should 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( 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 ],
+        [ 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( a, b )
+      c.should 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( a, b )
+      c.should 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/helpers.rb

@@ -0,0 +1,42 @@
+# convolver/spec/helpers.rb
+require 'convolver'
+
+# Matcher compares NArrays numerically
+RSpec::Matchers.define :be_narray_like do |expected_narray|
+  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 > 1e-10
+        @error = "Numerical difference with mean square error #{difference}"
+      end
+    end
+    @given = given.clone
+
+    if @error
+      @expected = expected_narray.clone
+    end
+
+    ! @error
+  end
+
+  failure_message_for_should do
+    "NArray does not match supplied example. #{@error}
+    Expected: #{@expected.inspect}
+    Got: #{@given.inspect}"
+  end
+
+  failure_message_for_should_not 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,146 @@
+--- !ruby/object:Gem::Specification
+name: convolver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Neil Slater
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-20 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
+description: Convolution for NArray
+email:
+- slobo777@gmail.com
+executables: []
+extensions:
+- ext/convolver/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmarks/convolve_benchmark.rb
+- convolver.gemspec
+- ext/convolver/convolver.c
+- ext/convolver/extconf.rb
+- lib/convolver.rb
+- lib/convolver/version.rb
+- spec/convolver_spec.rb
+- spec/helpers.rb
+homepage: http://github.com/neilslater/convolver
+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.1.8
+signing_key: 
+specification_version: 4
+summary: Convolution for NArray
+test_files:
+- spec/convolver_spec.rb
+- spec/helpers.rb
+has_rdoc: