hornetseye-linalg 0.1.0

data/README.md

@@ -0,0 +1,23 @@
+hornetseye-linalg
+=================
+
+**Author**:       Jan Wedekind
+**Copyright**:    2011
+**License**:      GPL
+
+Synopsis
+--------
+
+This Ruby extension implements conversions between {Linalg::DMatrix} and {Hornetseye::MultiArray}.
+
+Installation
+------------
+To install this Ruby extension, use the following command:
+
+    $ sudo gem install hornetseye-linalg
+
+Alternatively you can build and install the Ruby extension from source as follows:
+
+    $ rake
+    $ sudo rake install
+

data/Rakefile

@@ -0,0 +1,184 @@
+#!/usr/bin/env ruby
+require 'date'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/loaders/makefile'
+require 'rbconfig'
+
+PKG_NAME = 'hornetseye-linalg'
+PKG_VERSION = '0.1.0'
+CFG = RbConfig::CONFIG
+CXX = ENV[ 'CXX' ] || 'g++'
+RB_FILES = FileList[ 'lib/**/*.rb' ]
+CC_FILES = FileList[ 'ext/*.cc' ]
+HH_FILES = FileList[ 'ext/*.hh' ] + FileList[ 'ext/*.tcc' ]
+TC_FILES = FileList[ 'test/tc_*.rb' ]
+TS_FILES = FileList[ 'test/ts_*.rb' ]
+SO_FILE = "ext/#{PKG_NAME.tr '\-', '_'}.#{CFG[ 'DLEXT' ]}"
+PKG_FILES = [ 'Rakefile', 'README.md', 'COPYING', '.document' ] +
+            RB_FILES + CC_FILES + HH_FILES + TS_FILES + TC_FILES
+BIN_FILES = [ 'README.md', 'COPYING', '.document', SO_FILE ] +
+            RB_FILES + TS_FILES + TC_FILES
+SUMMARY = %q{Linalg integration for Hornetseye}
+DESCRIPTION = %q{This Ruby extension provides conversion from Hornetseye::MultiArray to Linalg::DMatrix and vice versa.}
+AUTHOR = %q{Jan Wedekind}
+EMAIL = %q{jan@wedesoft.de}
+HOMEPAGE = %q{http://wedesoft.github.com/hornetseye-linalg/}
+
+OBJ = CC_FILES.ext 'o'
+$CXXFLAGS = "-DNDEBUG #{CFG[ 'CPPFLAGS' ]} #{CFG[ 'CFLAGS' ]}"
+if CFG[ 'rubyhdrdir' ]
+  $CXXFLAGS = "#{$CXXFLAGS} -I#{CFG[ 'rubyhdrdir' ]} " + 
+              "-I#{CFG[ 'rubyhdrdir' ]}/#{CFG[ 'arch' ]}"
+else
+  $CXXFLAGS = "#{$CXXFLAGS} -I#{CFG[ 'archdir' ]}"
+end
+$LIBRUBYARG = "-L#{CFG[ 'libdir' ]} #{CFG[ 'LIBRUBYARG' ]} #{CFG[ 'LDFLAGS' ]} " +
+              "#{CFG[ 'SOLIBS' ]} #{CFG[ 'DLDLIBS' ]}"
+$SITELIBDIR = CFG[ 'sitelibdir' ]
+$SITEARCHDIR = CFG[ 'sitearchdir' ]
+$LDSHARED = CFG[ 'LDSHARED' ][ CFG[ 'LDSHARED' ].index( ' ' ) .. -1 ]
+
+task :default => :all
+
+desc 'Compile Ruby extension (default)'
+task :all => [ SO_FILE ]
+
+file SO_FILE => OBJ do |t|
+   sh "#{CXX} -shared -o #{t.name} #{OBJ} #{$LIBRUBYARG}"
+end
+
+task :test => [ SO_FILE ]
+
+desc 'Install Ruby extension'
+task :install => :all do
+  verbose true do
+    for f in RB_FILES do
+      FileUtils.mkdir_p "#{$SITELIBDIR}/#{File.dirname f.gsub( /^lib\//, '' )}"
+      FileUtils.cp_r f, "#{$SITELIBDIR}/#{f.gsub( /^lib\//, '' )}"
+    end
+    FileUtils.mkdir_p $SITEARCHDIR
+    FileUtils.cp SO_FILE, "#{$SITEARCHDIR}/#{File.basename SO_FILE}"
+  end
+end
+
+desc 'Uninstall Ruby extension'
+task :uninstall do
+  verbose true do
+    for f in RB_FILES do
+      FileUtils.rm_f "#{$SITELIBDIR}/#{f.gsub /^lib\//, ''}"
+    end
+    FileUtils.rm_f "#{$SITEARCHDIR}/#{File.basename SO_FILE}"
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'ext'
+  t.test_files = TC_FILES
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new :yard do |y|
+    y.files << RB_FILES
+  end
+rescue LoadError
+  STDERR.puts 'Please install \'yard\' if you want to generate documentation'
+end
+
+Rake::PackageTask.new PKG_NAME, PKG_VERSION do |p|
+  p.need_tar = true
+  p.package_files = PKG_FILES
+end
+
+begin
+  require 'rubygems'
+  require 'rubygems/builder'
+  $SPEC = Gem::Specification.new do |s|
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.platform = Gem::Platform::RUBY
+    s.date = Date.today.to_s
+    s.summary = SUMMARY
+    s.description = DESCRIPTION
+    s.author = AUTHOR
+    s.email = EMAIL
+    s.homepage = HOMEPAGE
+    s.files = PKG_FILES
+    s.test_files = TC_FILES
+    s.require_paths = [ 'lib', 'ext' ]
+    s.rubyforge_project = %q{hornetseye}
+    s.extensions = %w{Rakefile}
+    s.has_rdoc = 'yard'
+    s.extra_rdoc_files = []
+    s.rdoc_options = %w{--no-private}
+    s.add_dependency %<malloc>, [ '~> 1.1' ]
+    s.add_dependency %<multiarray>, [ '~> 0.23' ]
+    s.add_dependency %<hornetseye-frame>, [ '~> 0.11' ]
+    s.add_development_dependency %q{rake}
+  end
+  GEM_SOURCE = "#{PKG_NAME}-#{PKG_VERSION}.gem"
+  $BINSPEC = Gem::Specification.new do |s|
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.platform = Gem::Platform::CURRENT
+    s.date = Date.today.to_s
+    s.summary = SUMMARY
+    s.description = DESCRIPTION
+    s.author = AUTHOR
+    s.email = EMAIL
+    s.homepage = HOMEPAGE
+    s.files = BIN_FILES
+    s.test_files = TC_FILES
+    s.require_paths = [ 'lib', 'ext' ]
+    s.rubyforge_project = %q{hornetseye}
+    s.has_rdoc = 'yard'
+    s.extra_rdoc_files = []
+    s.rdoc_options = %w{--no-private}
+    s.add_dependency %<malloc>, [ '~> 1.1' ]
+    s.add_dependency %<multiarray>, [ '~> 0.23' ]
+    s.add_dependency %<hornetseye-frame>, [ '~> 0.11' ]
+  end
+  GEM_BINARY = "#{PKG_NAME}-#{PKG_VERSION}-#{$BINSPEC.platform}.gem"
+  desc "Build the gem file #{GEM_SOURCE}"
+  task :gem => [ "pkg/#{GEM_SOURCE}" ]
+  file "pkg/#{GEM_SOURCE}" => [ 'pkg' ] + $SPEC.files do
+    when_writing 'Creating GEM' do
+      Gem::Builder.new( $SPEC ).build
+      verbose true do
+        FileUtils.mv GEM_SOURCE, "pkg/#{GEM_SOURCE}"
+      end
+    end
+  end
+  desc "Build the gem file #{GEM_BINARY}"
+  task :gem_binary => [ "pkg/#{GEM_BINARY}" ]
+  file "pkg/#{GEM_BINARY}" => [ 'pkg' ] + $BINSPEC.files do
+    when_writing 'Creating binary GEM' do
+      Gem::Builder.new( $BINSPEC ).build
+      verbose true do
+        FileUtils.mv GEM_BINARY, "pkg/#{GEM_BINARY}"
+      end
+    end
+  end
+rescue LoadError
+  STDERR.puts 'Please install \'rubygems\' if you want to create Gem packages'
+end
+
+rule '.o' => '.cc' do |t|
+   sh "#{CXX} #{$CXXFLAGS} -c -o #{t.name} #{t.source}"
+end
+
+file ".depends.mf" do |t|
+  sh "g++ -MM #{CC_FILES.join ' '} | " +
+    "sed -e :a -e N -e 's/\\n/\\$/g' -e ta | " +
+    "sed -e 's/ *\\\\\\$ */ /g' -e 's/\\$/\\n/g' | sed -e 's/^/ext\\//' > #{t.name}"
+end
+CC_FILES.each do |t|
+  file t.ext(".o") => t
+end
+import ".depends.mf"
+
+CLEAN.include 'ext/*.o'
+CLOBBER.include SO_FILE, 'doc', '.yardoc', '.depends.mf'
+

data/ext/dmatrix.cc

@@ -0,0 +1,60 @@
+/* HornetsEye - Computer Vision with Ruby
+   Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Jan Wedekind
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
+#include <algorithm>
+#include <boost/shared_array.hpp>
+#include "error.hh"
+#include "rubytools.hh"
+#include "dmatrix.hh"
+
+using namespace std;
+
+VALUE DMatrix::mModule = Qnil;
+
+VALUE DMatrix::cRubyClass = Qnil;
+
+VALUE DMatrix::registerRubyClass(VALUE module)
+{
+  mModule = module;
+  cRubyClass = rb_define_class_under(module, "DMatrix", rb_cObject);
+  rb_define_method(cRubyClass, "to_multiarray", RUBY_METHOD_FUNC(wrapToMultiArray), 0);
+  return cRubyClass;
+}
+
+void DMatrix::deleteRubyObject(void *ptr)
+{
+  free((DMatrix *)ptr);
+}
+
+VALUE DMatrix::wrapToMultiArray(VALUE rbSelf)
+{
+  VALUE rbRetVal = Qnil;
+  try {
+    VALUE mHornetseye = rb_define_module( "Hornetseye" );
+    DMatrix_ *dmatrix;
+    dataGetStruct(rbSelf, cRubyClass, DMatrix_, dmatrix);
+    int width = dmatrix->hsize;
+    int height = dmatrix->vsize;
+    VALUE cMalloc = rb_define_class_under(mHornetseye, "Malloc", rb_cObject);
+    VALUE rbMemory = Data_Wrap_Struct(cMalloc, 0, 0, dmatrix->data);
+    rb_ivar_set(rbMemory, rb_intern("@size"), INT2NUM(width * height * sizeof(double)));
+    VALUE rbTypecode = rb_const_get(mHornetseye, rb_intern("DFLOAT"));
+    rbRetVal = rb_funcall(rb_const_get(mHornetseye, rb_intern("MultiArray")),
+      rb_intern("import"), 4, rbTypecode, rbMemory, INT2NUM(height), INT2NUM(width));
+  } catch( std::exception &e ) {
+    rb_raise( rb_eRuntimeError, "%s", e.what() );
+  };
+  return rbRetVal;
+}

data/ext/dmatrix.hh

@@ -0,0 +1,36 @@
+/* HornetsEye - Computer Vision with Ruby
+   Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Jan Wedekind
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
+#ifndef HORNETSEYE_DMATRIX_HH
+#define HORNETSEYE_DMATRIX_HH
+#include "rubyinc.hh"
+
+typedef struct {
+  int vsize;
+  int hsize;
+  double *data;
+} DMatrix_;
+
+class DMatrix {
+public:
+  static VALUE cRubyClass;
+  static VALUE mModule;
+  static VALUE registerRubyClass(VALUE module);
+  static void deleteRubyObject(void *ptr);
+  static VALUE wrapToMultiArray(VALUE rbSelf);
+};
+
+#endif
+

data/ext/error.hh

@@ -0,0 +1,50 @@
+/* HornetsEye - Computer Vision with Ruby
+   Copyright (C) 2006, 2007, 2008, 2009, 2010   Jan Wedekind
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
+#ifndef ERROR_HH
+#define ERROR_HH
+
+#include <exception>
+#include <sstream>
+
+class Error: public std::exception
+{
+public:
+  Error(void) {}
+  Error( Error &e ): std::exception( e )
+    { m_message << e.m_message.str(); }
+  virtual ~Error(void) throw() {}
+  template< typename T >
+  std::ostream &operator<<( const T &t )
+    { m_message << t; return m_message; }
+  std::ostream &operator<<( std::ostream& (*__pf)(std::ostream&) )
+    { (*__pf)( m_message ); return m_message; }
+  virtual const char* what(void) const throw() {
+    temp = m_message.str();
+    return temp.c_str();
+  }
+protected:
+  std::ostringstream m_message;
+  mutable std::string temp;
+};
+
+#define ERRORMACRO( condition, class, params, message ) \
+  if ( !( condition ) ) {                               \
+    class _e params;                                    \
+    _e << message;                                      \
+    throw _e;                                           \
+  };
+
+#endif

data/ext/init.cc

@@ -0,0 +1,44 @@
+/* HornetsEye - Computer Vision with Ruby
+   Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011   Jan Wedekind
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
+#include "rubyinc.hh"
+#include "node.hh"
+#include "dmatrix.hh"
+#include "smatrix.hh"
+
+#ifdef WIN32
+#define DLLEXPORT __declspec(dllexport)
+#define DLLLOCAL
+#else
+#define DLLEXPORT __attribute__ ((visibility("default")))
+#define DLLLOCAL __attribute__ ((visibility("hidden")))
+#endif
+
+extern "C" DLLEXPORT void Init_hornetseye_linalg(void);
+
+extern "C" {
+
+  void Init_hornetseye_linalg(void)
+  {
+    rb_eval_string("require 'multiarray'");
+    VALUE rbHornetseye = rb_define_module("Hornetseye");
+    Node::registerRubyClass(rbHornetseye);
+    VALUE rbLinalg = rb_define_module("Linalg");
+    DMatrix::registerRubyClass(rbLinalg);
+    SMatrix::registerRubyClass(rbLinalg);
+    rb_require("hornetseye_linalg_ext.rb");
+  }
+
+}

data/ext/node.cc

@@ -0,0 +1,103 @@
+/* HornetsEye - Computer Vision with Ruby
+   Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Jan Wedekind
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
+#include <algorithm>
+#include "error.hh"
+#include "rubytools.hh"
+#include "dmatrix.hh"
+#include "smatrix.hh"
+#include "node.hh"
+
+using namespace std;
+
+VALUE Node::mModule = Qnil;
+
+VALUE Node::cRubyClass = Qnil;
+
+VALUE Node::registerRubyClass(VALUE module)
+{
+  mModule = module;
+  cRubyClass = rb_define_class_under(module, "Node", rb_cObject);
+  rb_define_method(cRubyClass, "to_dmatrix", RUBY_METHOD_FUNC(wrapToDMatrix), 0);
+  rb_define_method(cRubyClass, "to_smatrix", RUBY_METHOD_FUNC(wrapToSMatrix), 0);
+  return cRubyClass;
+}
+
+VALUE Node::wrapToDMatrix(VALUE rbSelf)
+{
+  VALUE rbRetVal = Qnil;
+  try {
+    VALUE rbMalloc = rb_funcall(rbSelf, rb_intern("memory"), 0);
+    VALUE rbTypecode = rb_funcall(rbSelf, rb_intern("typecode"), 0);
+    VALUE rbShape = rb_funcall(rbSelf, rb_intern("shape"), 0);
+    Check_Type(rbShape, T_ARRAY);
+    int rank = RARRAY_LEN(rbShape);
+    ERRORMACRO(rank == 2, Error, ,
+               "Array needs to have two dimensions for conversion to "
+               "DMatrix (but had " << rank << " dimension(s))");
+    int
+      width = NUM2INT(RARRAY_PTR(rbShape)[0]),
+      height = NUM2INT(RARRAY_PTR(rbShape)[1]);
+    ERRORMACRO(rb_funcall(rbTypecode, rb_intern("=="), 1,
+                          rb_const_get(mModule, rb_intern("DFLOAT"))) == Qtrue, Error, ,
+	       "Element-type of array must be DFLOAT");
+    VALUE cMalloc = rb_define_class_under(mModule, "Malloc", rb_cObject);
+    unsigned char *source;
+    dataGetStruct(rbMalloc, cMalloc, unsigned char, source);
+    VALUE rbLinalg = rb_define_module("Linalg");
+    DMatrix_ *dmatrix = (DMatrix_ *)ALLOC(DMatrix_);
+    dmatrix->hsize = height;
+    dmatrix->vsize = width;
+    dmatrix->data = (double *)source;
+    rbRetVal = Data_Wrap_Struct(DMatrix::cRubyClass, 0, DMatrix::deleteRubyObject, dmatrix);
+  } catch ( std::exception &e ) {
+    rb_raise( rb_eRuntimeError, "%s", e.what() );
+  };
+  return rbRetVal;
+}
+
+VALUE Node::wrapToSMatrix(VALUE rbSelf)
+{
+  VALUE rbRetVal = Qnil;
+  try {
+    VALUE rbMalloc = rb_funcall(rbSelf, rb_intern("memory"), 0);
+    VALUE rbTypecode = rb_funcall(rbSelf, rb_intern("typecode"), 0);
+    VALUE rbShape = rb_funcall(rbSelf, rb_intern("shape"), 0);
+    Check_Type(rbShape, T_ARRAY);
+    int rank = RARRAY_LEN(rbShape);
+    ERRORMACRO(rank == 2, Error, ,
+               "Array needs to have two dimensions for conversion to "
+               "SMatrix (but had " << rank << " dimension(s))");
+    int
+      width = NUM2INT(RARRAY_PTR(rbShape)[0]),
+      height = NUM2INT(RARRAY_PTR(rbShape)[1]);
+    ERRORMACRO(rb_funcall(rbTypecode, rb_intern("=="), 1,
+                          rb_const_get(mModule, rb_intern("SFLOAT"))) == Qtrue, Error, ,
+	       "Element-type of array must be SFLOAT");
+    VALUE cMalloc = rb_define_class_under(mModule, "Malloc", rb_cObject);
+    unsigned char *source;
+    dataGetStruct(rbMalloc, cMalloc, unsigned char, source);
+    VALUE rbLinalg = rb_define_module("Linalg");
+    SMatrix_ *smatrix = (SMatrix_ *)ALLOC(SMatrix_);
+    smatrix->hsize = height;
+    smatrix->vsize = width;
+    smatrix->data = (float *)source;
+    rbRetVal = Data_Wrap_Struct(SMatrix::cRubyClass, 0, SMatrix::deleteRubyObject, smatrix);
+  } catch ( std::exception &e ) {
+    rb_raise( rb_eRuntimeError, "%s", e.what() );
+  };
+  return rbRetVal;
+}
+