numo-fftw 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec645a03722200a65ce8f059b2fea6eeda1f27ab
+  data.tar.gz: b564acfb52fa35cbd907063be6d149c8279fdc4c
+SHA512:
+  metadata.gz: b9221bfe095e69c2299d322e2933a2fe2b0803f09863e97a5f942b62343d6c4dcaf3c4b4b58c66b30e4e44f0819e626181e17b1a56ee5d7db401d673f6998e28
+  data.tar.gz: '069577773e93ccb3a299258c29e7159639ef7f113181517aa993bdbc53028f2df8aabeaa31424625cccf9393c002924482f22eea50d172ecfffce20a90d603c4'

data/README.md

@@ -0,0 +1,18 @@
+# FFTW3 interface for Ruby with Numo::NArray
+
+## FFTW
+* FFTW is a C subroutine library for computing the discrete Fourier transform (DFT) in one or more dimensions, of arbitrary input size, and of both real and complex data.
+* [FFTW site](http://www.fftw.org/)
+
+## Numo::FFTW
+* [GitHub site](https://github.com/ruby-numo/fftw)
+* [Tentative API Document]()
+
+## Installation
+* Install [FFTW3](http://www.fftw.org/)
+* Install [Numo::NArray](https://github.com/ruby-numo/narray)
+* Install Numo::FFTW :
+
+```shell
+$ gem install numo-fftw
+```

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+task :doc do
+  dir = "ext/numo/fftw"
+  src = %w[fftw.c]
+  path = src.map{|s| File.join(dir,s)}
+  sh "cd #{dir}; ruby extconf.rb; make #{src.join(' ')}"
+  sh "rm -rf yard .yardoc; yard doc -o yard -m markdown -r README.md #{path.join(' ')}"
+end
+
+task :cleandoc do
+  rm_rf %w[yard .yardoc]
+end

data/ext/numo/fftw/depend

@@ -0,0 +1,14 @@
+CLEANOBJS = *.o */*.o *.bak *~
+ERB = erb -T-
+
+fftw.c: fftw.erb.c
+	$(ERB) fftw.erb.c > fftw.c
+
+doc : fftw.c
+	yard doc -o yard -m markdown $<
+
+clean: cleansrc cleandoc
+cleansrc:
+	-$(Q)$(RM) fftw.c
+cleandoc:
+	-$(Q)$(RM_RF) yard .yardoc

data/ext/numo/fftw/extconf.rb

@@ -0,0 +1,43 @@
+require 'rbconfig.rb'
+require 'numo/narray'
+require 'mkmf'
+
+dir_config("fftw")
+
+#$CFLAGS="-g -O0"
+#$INCFLAGS = "-I../ext -I../ext/types #$INCFLAGS"
+
+$LOAD_PATH.each do |x|
+  if File.exist? File.join(x,'numo/numo/narray.h')
+    $INCFLAGS = "-I#{x}/numo " + $INCFLAGS
+    break
+  end
+end
+
+if !have_header('numo/narray.h')
+  print <<EOL
+  Header numo/narray.h was not found. Give pathname as follows:
+  % ruby extconf.rb --with-narray-include=narray_h_dir
+EOL
+  exit(1)
+end
+
+if !have_header('fftw3.h')
+  print <<EOL
+  Header fftw3.h was not found. Give pathname as follows:
+  % ruby extconf.rb --with-fftw-include=header_dir
+EOL
+  exit(1)
+end
+
+if !have_library('fftw3')
+  print <<EOL
+  Library libfftw3.so was not found. Give pathname as follows:
+  % ruby extconf.rb --with-fftw-lib=library_dir
+EOL
+  exit(1)
+end
+
+$objs = %w[fftw.o]
+
+create_makefile('numo/fftw')

data/ext/numo/fftw/fftw.erb.c

@@ -0,0 +1,164 @@
+/*
+  FFTW interface for Numo::NArray
+  Copyright(C) 2017 Masahiro TANAKA
+
+  FFTW: C subroutine library for computing the discrete Fourier transform (DFT)
+  http://www.fftw.org/
+*/
+
+#include <fftw3.h>
+
+#include <ruby.h>
+#include "numo/narray.h"
+#include "numo/template.h"
+#define cDC numo_cDComplex
+#define cDF numo_cDFloat
+
+static ID id_cast;
+
+<%
+def argmap(arg)
+  case arg
+  when Numeric
+    arg = 1..arg
+  end
+  arg.map do |x|
+    yield(x)
+  end.join(",")
+end
+$funcs = []
+%>
+
+<% (1..3).each do |d| %>
+<% $funcs.push func="dft_#{d}d" %>
+static void
+iter_fftw_<%=func%>(na_loop_t *const lp)
+{
+    char  *p1, *p2;
+    int   sign;
+    int   <%=argmap(d){|i|"n#{i}"}%>;
+    fftw_plan plan;
+
+<% (1..d).each do |i| %>
+    n<%=i%> = lp->args[0].shape[<%=i-1%>];
+<% end %>
+    p1 = ((lp)->args[0]).ptr + ((lp)->args[0].iter[0]).pos;
+    p2 = ((lp)->args[1]).ptr + ((lp)->args[1].iter[0]).pos;
+
+    sign = *(int*)(lp->opt_ptr);
+    plan = fftw_plan_dft_<%=d%>d(<%=argmap(d){|i|"n#{i}"}%>,
+                                 (fftw_complex*)p1, (fftw_complex*)p2,
+                                 sign, FFTW_ESTIMATE);
+    fftw_execute(plan);
+    fftw_destroy_plan(plan);
+}
+
+/*
+  <%=d%>-dimentional Complex Discrete Fourier Transform
+  @overload dft_<%=d%>d(narray,sign)
+  @param [Numo::DComplex] narray Input NArray with at least <%=d%> dimension<%="s" if d>1%>.
+  @param [Numeric] sign  the sign of the exponent in the formula
+    that defines the Fourier transform.
+    It can be -1 (= FFTW_FORWARD) or +1 (= FFTW_BACKWARD).
+  @return [Numo::DComplex] Result DComplex NArray with
+    `shape = [.., <%if d>2%>nz, <%end;if d>1%>ny, <%end%>nx]`.
+*/
+static VALUE
+numo_fftw_<%=func%>(VALUE mod, VALUE vna, VALUE vsign)
+{
+    narray_t *na;
+    VALUE vans;
+    int ndim;
+    int sign=-1;
+    size_t shape[<%=d%>];
+    ndfunc_arg_in_t ain[1] = {{cDC,<%=d%>}};
+    ndfunc_arg_out_t aout[1] = {{cDC,<%=d%>,shape}};
+    ndfunc_t ndf = { iter_fftw_<%=func%>, NO_LOOP|NDF_INPLACE, 1, 1, ain, aout };
+
+    sign = NUM2INT(vsign);
+    if (sign != 1 && sign != -1) {
+        rb_raise(rb_eArgError,"second argument (sign) must be 1 or -1");
+    }
+    GetNArray(vna,na);
+    ndim = NA_NDIM(na);
+    if (ndim<<%=d%>) {
+        rb_raise(nary_eDimensionError,"ndim(=%d) should >= <%=d%>",ndim);
+    }
+<% (1..d).each do |i| %>
+    shape[<%=d-i%>] = NA_SHAPE(na)[ndim-<%=i%>];
+<% end %>
+    vans = na_ndloop3(&ndf, &sign, 1, vna);
+    RB_GC_GUARD(vna);
+    return vans;
+}
+<% end %>
+
+<% $funcs.push func="dft" %>
+/*
+  Multi-dimentional Complex Discrete Fourier Transform
+  @overload dft(narray,sign)
+  @param [Numo::DComplex] narray Input NArray with any dimension.
+  @param [Numeric] sign  the sign of the exponent in the formula
+    that defines the Fourier transform.
+    It can be -1 (= FFTW_FORWARD) or +1 (= FFTW_BACKWARD).
+  @return [Numo::DComplex] Result DComplex NArray with the same shape
+    as input NArray.
+*/
+static VALUE
+numo_fftw_<%=func%>(VALUE mod, VALUE vna, VALUE vsign)
+{
+    VALUE vans;
+    int sign;
+    narray_t *na;
+    int ndim, i;
+    int *shape;
+    fftw_complex *in, *out;
+    fftw_plan plan;
+
+    sign = NUM2INT(vsign);
+    if (sign != 1 && sign != -1) {
+        rb_raise(rb_eArgError,"second argument (sign) must be 1 or -1");
+    }
+    if (CLASS_OF(vna) != numo_cDComplex) {
+        vna = rb_funcall(numo_cDComplex, id_cast, 1, vna);
+    }
+    if (!RTEST(nary_check_contiguous(vna))) {
+        vna = nary_dup(vna);
+    }
+    GetNArray(vna,na);
+    ndim = NA_NDIM(na);
+    shape = ALLOCA_N(int,ndim);
+    for (i=0; i<ndim; i++) {
+        shape[i] = NA_SHAPE(na)[i];
+    }
+    if (TEST_INPLACE(vna)) {
+        vans = vna;
+        in = out = (fftw_complex*)na_get_pointer_for_read_write(vna);
+    } else {
+        vans = nary_s_new_like(numo_cDComplex, vna);
+        in = (fftw_complex*)na_get_pointer_for_read(vna);
+        out = (fftw_complex*)na_get_pointer_for_write(vans);
+    }
+    plan = fftw_plan_dft(ndim, shape, in, out, sign, FFTW_ESTIMATE);
+    fftw_execute(plan);
+    fftw_destroy_plan(plan);
+
+    RB_GC_GUARD(vna);
+    return vans;
+}
+
+void
+Init_fftw()
+{
+    VALUE mNumo,mFFTW;
+
+    rb_require("numo/narray");
+    mNumo = rb_define_module("Numo");
+    mFFTW = rb_define_module_under(mNumo,"FFTW");
+
+<% $funcs.each do |f| %>
+    rb_define_module_function(mFFTW,"<%=f%>",numo_fftw_<%=f%>,2);
+<% end %>
+
+    id_cast    = rb_intern("cast");
+}

data/ext/numo/fftw/version.h

@@ -0,0 +1 @@
+#define NUMO_FFTW_VERSION "0.1.0"

data/numo-fftw.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+open("ext/numo/fftw/version.h") do |f|
+  f.each_line do |l|
+    if /NUMO_FFTW_VERSION "([\d.]+)"/ =~ l
+      VERSION = $1
+      break
+    end
+  end
+end
+
+Gem::Specification.new do |spec|
+  spec.name          = "numo-fftw"
+  spec.version       = VERSION
+  spec.authors       = ["Masahiro TANAKA"]
+  spec.email         = ["masa16.tanaka@gmail.com"]
+  spec.description   = %q{Numo::FFTW development version.}
+  spec.summary       = %q{Numo::FFTW development version}
+  spec.homepage      = "https://github.com/ruby-numo/fftw"
+  spec.licenses      = ["GPL2"]
+
+  spec.files         = `git ls-files Gemfile README.md Rakefile ext numo-fftw.gemspec spec`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/numo/fftw/extconf.rb"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_runtime_dependency "numo-narray", "~> 0.9.0.8"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: numo-fftw
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masahiro TANAKA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-13 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: numo-narray
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0.8
+description: Numo::FFTW development version.
+email:
+- masa16.tanaka@gmail.com
+executables: []
+extensions:
+- ext/numo/fftw/extconf.rb
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- ext/numo/fftw/depend
+- ext/numo/fftw/extconf.rb
+- ext/numo/fftw/fftw.erb.c
+- ext/numo/fftw/version.h
+- numo-fftw.gemspec
+homepage: https://github.com/ruby-numo/fftw
+licenses:
+- GPL2
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Numo::FFTW development version
+test_files: []