ruby-fftw3 0.4.2 → 1.0.0

data/lib/numru/fftw3.rb

@@ -0,0 +1,102 @@
+begin
+  require "rubygems"
+rescue LoadError
+end
+
+require "numru/fftw3/version"
+require "numru/fftw3/fftw3"
+
+module NumRu
+
+  # Ruby wrapper of FFTW3, a fast discrete Fourier transform library. http://www.fftw.org
+  # 
+  # ==Features
+  # 
+  # * Uses NArray (https://github.com/masa16/narray). (Also it supports
+  #   NumRu::NArray as well, if this library is compiled to use it).
+  # * Multi-dimensional complex and real FFT.
+  # * Supports both double and single float transforms.
+  # 
+  # ==How to use
+  # 
+  # Copy and paste the following code line-by-line using irb.
+  # Or you can run it by saving it in a file fftw3test.rb (say) 
+  # and executing "ruby fftw3test.rb".
+  # 
+  #   require "numru/fftw3"
+  #   include NumRu
+  # 
+  #   na = NArray.float(8,6)   # float -> will be coerced to complex
+  #   na[1,1]=1
+  # 
+  #   # <example 1: complex FFT on all dimensions >
+  # 
+  #   fc = FFTW3.fft(na, FFTW3::FORWARD)/na.length  # forward 2D FFT and normalization
+  #   nc = FFTW3.fft(fc, FFTW3::BACKWARD)       # backward 2D FFT (complex) --> 
+  #   nb = nc.real              # should be equal to na except round errors  
+  #   p (nb - na).abs.max       # => 8.970743058303247e-17 (sufficiently small)
+  # 
+  #   # <example 2: complex FFT on all dimensions >
+  #   # Same as example 1 but using more user-friendly wrapper of FFTW3.fft
+  #   
+  #   fc = FFTW3.fft_fw(na)     # forward 2D FFT and normalization
+  #   nc = FFTW3.fft_bk(fc)     # backward 2D FFT (complex) --> 
+  #   nb = nc.real              # should be equal to na except round errors  
+  #   p (nb - na).abs.max       # => 8.970743058303247e-17 (sufficiently small)
+  # 
+  #   # <example 3: complex FFT along a dimension >
+  #   fc = FFTW3.fft_fw(na, 0)  # forward 1D FFT along the first dim
+  #   nc = FFTW3.fft_bk(fc, 0)  # backward 1D FFT along the first dim
+  #   p (nc.real - na).abs.max  # => 1.1102230246251565e-16 (sufficiently small)
+  # 
+  #   # <example 4: complex FFT along a dimension >
+  #   fc = FFTW3.fft_fw(na, 1)  # forward 1D FFT along the second dim
+  # 
+  #   # <example 5: real FFT along a dimension >
+  # 
+  #   fc = FFTW3.fft_r2r(na, FFTW3::RODFT00, 0)  # not normalized sine transform along the 1st dim
+  #   len = 2*(na.shape[0]+1)    # this is the supposed length of this transformation
+  #   nc = FFTW3.fft_r2r(fc/len, FFTW3::RODFT00, 0)  # forward==backward transformation
+  #   p (nc-na).abs.max          # => 2.220446049250313e-16 (sufficiently small)
+  # 
+  #   # <example 5b: real FFT on all dimensions >
+  # 
+  #   fc = FFTW3.fft_r2r(na, FFTW3::REDFT11)   # unnormalized cosine transform
+  #   len = 4*na.length          # from (2*na.shape[0]) * (2*na.shape[1])
+  #   nc = FFTW3.fft_r2r(fc/len, FFTW3::REDFT11)   # forward==backward transformation
+  #   p (nc-na).abs.max          # => 6.228190483314256e-17 (sufficiently small)
+  #   
+  # See the FFTW3 manual for the kinds of supported real FFTs. See Ch.2 of
+  # http://www.fftw.org/fftw3_doc/ (http://www.fftw.org/fftw3.pdf).
+  # Virtually all kinds are supported!
+  # 
+  module FFTW3
+
+    module_function
+
+    # Forward complex FFT with normalization
+    # 
+    # This calls FFW3.fft(na, FFW3::FORWARD, *dims) and normalizes the result
+    # by dividing by the length
+    # 
+    def fft_fw(na, *dims)
+      fc = fft(na, FORWARD, *dims)
+      if dims.length == 0
+        len = na.total
+      else
+        len = 1
+        shape = na.shape
+        dims.each{|d| len *= shape[d]}
+      end
+      fc / len
+    end
+
+    # Backward complex FFT
+    # 
+    # This method simply calls FFW3.fft(na, FFW3::BACKWARD, *dims)
+    # 
+    def fft_bk(na, *dims)
+      fft(na, BACKWARD, *dims)
+    end
+  end
+end

data/lib/numru/fftw3/version.rb

@@ -1,5 +1,5 @@
-module Ruby
+module NumRu
   module FFTW3
-    VERSION = "0.4.2"
+    VERSION = "1.0.0"
   end
 end

data/ruby-fftw3-bigmem.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'numru/fftw3/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-fftw3-bigmem"
+  spec.version       = NumRu::FFTW3::VERSION
+  spec.authors       = ["Takeshi Horinouchi"]
+  spec.email         = ['eriko@gfd-dennou.org']
+
+  spec.summary          = %q{The Ruby interface of the FFTW (ver 3) library}
+  spec.description      = %q{Fast Fourier Transforms by using FFTW Ver.3. This new version works with Ruby2.0.}
+  spec.homepage         = 'http://www.gfd-dennou.org/arch/ruby/products/ruby-fftw3/'
+  spec.licenses         = ["BSD-2-Clause"]
+
+  spec.files            = `git ls-files -z`.split("\x0")
+  spec.test_files       = spec.files.grep(%r{^test/})
+  spec.require_paths = ["ext","lib"]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 1.8")
+  spec.add_runtime_dependency(%q<narray-bigmem>, [">= 0"])
+
+  spec.extensions << "ext/numru/fftw3/extconf.rb"
+end

data/ruby-fftw3.gemspec

@@ -5,28 +5,21 @@ require 'numru/fftw3/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "ruby-fftw3"
-  spec.version       = Ruby::FFTW3::VERSION
+  spec.version       = NumRu::FFTW3::VERSION
   spec.authors       = ["Takeshi Horinouchi"]
   spec.email         = ['eriko@gfd-dennou.org']
 
-  #if spec.respond_to?(:metadata)
-  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
-  #end
-
   spec.summary          = %q{The Ruby interface of the FFTW (ver 3) library}
   spec.description      = %q{Fast Fourier Transforms by using FFTW Ver.3. This new version works with Ruby2.0.}
   spec.homepage         = 'http://www.gfd-dennou.org/arch/ruby/products/ruby-fftw3/'
-  spec.licenses         = ["Takeshi Horinouchi", "GFD Dennou Club"]
+  spec.licenses         = ["BSD-2-Clause"]
 
-  #spec.files            = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.files            = `git ls-files -z`.split("\x0")
   spec.test_files       = spec.files.grep(%r{^test/})
-  #spec.bindir        = "exe"
-  #spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ["ext","lib"]
 
-  spec.required_ruby_version = Gem::Requirement.new(">= 1.6")
+  spec.required_ruby_version = Gem::Requirement.new(">= 1.8")
   spec.add_runtime_dependency(%q<narray>, [">= 0"])
 
-  spec.extensions << "extconf.rb"
+  spec.extensions << "ext/numru/fftw3/extconf.rb"
 end

data/test/complexFFT.rb

@@ -1,39 +1,62 @@
-require "narray"
+begin
+require "rubygems"
+rescue LoadError
+end
+require "narray"  # This line is needed for rake test when making a gem package.
 require "numru/fftw3"
+require "test/unit"
 include NumRu
 
-print "\n**TEST** all dimensions\n\n"
-
-na = NArray.float(8,4).fill(1)  # will be corced to complex
-na[1,1]=5
-p na
-fc = FFTW3.fft(na, -1)/na.length 
-p fc
-p fc.real
-
-p FFTW3.fft(fc, 1).real
-
-print "\n**TEST** single float (treated as single if lib fftw3f exits)\n"
-print " --- see http://www.fftw.org/fftw3_doc/Precision.html for more info\n\n"
-na = NArray.sfloat(8,4).indgen!
-fc = FFTW3.fft(na, -1)/na.length 
-p fc
-p FFTW3.fft(fc, 1).real
-
-print "\n**TEST** dimension selection\n\n"
-
-fc = FFTW3.fft(na, -1, 0)/na.shape[0]
-p fc
-p FFTW3.fft(fc, 1, 0).real
-fc = FFTW3.fft(na, -1, 1)/na.shape[1]
-p fc
-p FFTW3.fft(fc, 1, 1).real
-
-na = NArray.float(4,3,8,3)
-na[1,1,1,0]= 1
-p( fc=FFTW3.fft(na, -1, 0,2) / (na.shape[0]*na.shape[2]) )
-p( fc=FFTW3.fft(na, -1, 1) / na.shape[1] )
-p( fc=FFTW3.fft(na, -1, 0,1,2)  / (na.shape[0]*na.shape[1]*na.shape[2]) )
-p FFTW3.fft(fc, 1, 0,1,2).real
+class FFTW3Test < Test::Unit::TestCase
+  def setup
+    @eps = 1e-10
+    @seps = 1e-6
+  end
+
+  def test_fft_fw_bk
+    na = NArray.float(8,4).fill(1)  # will be corced to complex
+    na[1,1]=5
+    fc = FFTW3.fft_fw(na)
+    nb = FFTW3.fft_bk(fc).real
+    assert( (na-nb).abs.max < @eps )
+
+    fc = FFTW3.fft_fw(na,1)
+    nb = FFTW3.fft_bk(fc,1).real
+    assert( (na-nb).abs.max < @eps )
+  end
+
+  def test_real_all_dims
+    na = NArray.float(8,4).fill(1)  # will be corced to complex
+    na[1,1]=5
+    fc = FFTW3.fft(na, FFTW3::FORWARD)/na.length 
+    nb = FFTW3.fft(fc, FFTW3::BACKWARD).real
+    assert( (na-nb).abs.max < @eps )
+  end
+
+  def test_complex_all_dims
+    na = NArray.complex(8,4).fill(1) * Complex::I
+    na[1,1]=5
+    fc = FFTW3.fft(na, -1)/na.length 
+    nb = FFTW3.fft(fc, 1)
+    assert( (na-nb).abs.max < @eps )
+  end
+
+  def test_dim_selection
+    na = NArray.float(8,4).indgen!
+    fc = FFTW3.fft(na, FFTW3::FORWARD, 0)
+    fc = FFTW3.fft(fc, FFTW3::FORWARD, 1)
+    fc2 = FFTW3.fft(na, FFTW3::FORWARD)
+    assert( (fc-fc2).abs.max < @eps )
+  end
+
+  # TEST: single float (treated as single if lib fftw3f exits).
+  # see http://www.fftw.org/fftw3_doc/Precision.html for more info
+  def test_single_float
+    na = NArray.sfloat(8,4).indgen!
+    fc = FFTW3.fft(na, -1)/na.length 
+    nb = FFTW3.fft(fc, 1).real
+    assert( (na-nb).abs.max < @seps )
+  end
+end
 
 

data/test/r2rFFT.rb

@@ -0,0 +1,77 @@
+require "narray"  # This line is needed for rake test when making a gem package.
+require "numru/fftw3"
+require "test/unit"
+include NumRu
+
+class FFTW3_R2R_Test < Test::Unit::TestCase
+  def setup
+    @eps = 1e-10
+    @seps = 1e-5
+  end
+
+  def test_r2r_all_dims
+    nx = 8
+    ny = 4
+    na = NArray.float(nx,ny).indgen!
+
+    fc = FFTW3.fft_r2r(na, FFTW3::REDFT00)  # cosine trans at 0, 1, 2,...
+    c = 1.0 / (2*(nx-1)) / (2*(ny-1))
+    nb = FFTW3.fft_r2r(fc*c, FFTW3::REDFT00)
+    assert( (na-nb).abs.max < @eps )
+
+    fc = FFTW3.fft_r2r(na, FFTW3::REDFT11)  # cosine trans at 1/2, 1+1/2,...
+    c = 1.0 / (2*nx) / (2*ny)
+    nb = FFTW3.fft_r2r(fc*c, FFTW3::REDFT11)
+    assert( (na-nb).abs.max < @eps )
+
+    fc = FFTW3.fft_r2r(na, FFTW3::REDFT01)
+    c = 1.0 / (2*nx) / (2*ny)
+    nb = FFTW3.fft_r2r(fc*c, FFTW3::REDFT10)
+    assert( (na-nb).abs.max < @eps )
+
+    fc = FFTW3.fft_r2r(na, FFTW3::RODFT00)  # sine trans at 1, 2,...
+    c = 1.0 / (2*(nx+1)) / (2*(ny+1))
+    nb = FFTW3.fft_r2r(fc*c, FFTW3::RODFT00)
+    assert( (na-nb).abs.max < @eps )
+
+    fc = FFTW3.fft_r2r(na, FFTW3::RODFT11)  # sine trans at 1/2, 1+1/2,...
+    c = 1.0 / (2*nx) / (2*ny)
+    nb = FFTW3.fft_r2r(fc*c, FFTW3::RODFT11)
+    assert( (na-nb).abs.max < @eps )
+
+    fc = FFTW3.fft_r2r(na, FFTW3::RODFT01)  # sine trans
+    c = 1.0 / (2*nx) / (2*ny)
+    nb = FFTW3.fft_r2r(fc*c, FFTW3::RODFT10)
+    assert( (na-nb).abs.max < @eps )
+
+  end
+
+  def test_r2r_sigle
+    nx = 8
+    ny = 4
+    na = NArray.sfloat(nx,ny).indgen!
+
+    fc = FFTW3.fft_r2r(na, FFTW3::REDFT00)  # cosine trans at 0, 1, 2,...
+    c = 1.0 / (2*(nx-1)) / (2*(ny-1))
+    nb = FFTW3.fft_r2r(fc*c, FFTW3::REDFT00)
+    assert( (na-nb).abs.max < @seps )
+  end
+
+
+  def test_r2r_some_dims
+    nx = 8
+    ny = 4
+    na = NArray.float(nx,ny).indgen!
+
+    fc = FFTW3.fft_r2r(na, FFTW3::REDFT00, 0)
+    nb = FFTW3.fft_r2r(fc, FFTW3::REDFT00, 0) / (2*(nx-1))
+    assert( (na-nb).abs.max < @eps )
+
+    fc = FFTW3.fft_r2r(fc, FFTW3::RODFT11, 1)
+    fc2 = FFTW3.fft_r2r(na, [FFTW3::REDFT00, FFTW3::RODFT11])
+    fc3 = FFTW3.fft_r2r(na, [FFTW3::REDFT00, FFTW3::RODFT11], 0, 1)
+    assert( (fc-fc2).abs.max < @eps )
+    assert( (fc-fc3).abs.max < @eps )
+  end
+
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: ruby-fftw3
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Takeshi Horinouchi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2016-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: narray
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Fast Fourier Transforms by using FFTW Ver.3. This new version works with
@@ -30,51 +30,48 @@ email:
 - eriko@gfd-dennou.org
 executables: []
 extensions:
-- extconf.rb
+- ext/numru/fftw3/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
-- ChangeLog
+- ".ChangeLog.until20110419"
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
-- README.rd
 - Rakefile
 - ToDo
-- doc/ruby-fftw3.html
-- doc/ruby-fftw3.rd
-- extconf.rb
+- ext/numru/fftw3/extconf.rb
+- ext/numru/fftw3/na_fftw3.c
+- lib/numru/fftw3.rb
 - lib/numru/fftw3/version.rb
-- na_fftw3.c
+- ruby-fftw3-bigmem.gemspec
 - ruby-fftw3.gemspec
-- spec/ruby/fftw3_spec.rb
-- spec/spec_helper.rb
 - test/complexFFT.rb
+- test/r2rFFT.rb
 homepage: http://www.gfd-dennou.org/arch/ruby/products/ruby-fftw3/
 licenses:
-- Takeshi Horinouchi
-- GFD Dennou Club
+- BSD-2-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
+- ext
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '1.6'
+      version: '1.8'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: The Ruby interface of the FFTW (ver 3) library
 test_files:
 - test/complexFFT.rb
+- test/r2rFFT.rb

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color