fftw3 0.2 → 0.3

data/README

@@ -1,4 +1,4 @@
-=module NumRu::FFTW3
+=module FFTW3
 
 Fast Fourier Transforms by using ((<FFTW|URL:http://www.fftw.org>)) Ver.3.
 
@@ -25,60 +25,35 @@ NO WARRANTY
 
 ==Installation
 
-* Install ((<FFTW|URL:http://www.fftw.org>)) Ver.3.
-
-  * NOTE: 
-    To activate the single-float transform, you have to install FFTW3 with
-    the single-float compilation, in addition to the default double-float
-    version. This can be done by configuring FFTW3 with
-    the --enable-float option, and install it again. The single-float
-    version will coexist with the double-float version.
-    If you do not install the single-float version, FFT is always done
-    with the double precision, which is not bad if you are not time- and 
-    memory-conscious.
-
-* Install ((<NArray|URL:http://www.ruby-lang.org/en/raa-list.rhtml?name=NArray>)).
-
-* Then, install this library as follows (replace "version" with
-  the actual version number):
-
-    % tar xvzf fftw3-version.tar.gz
-    % cd fftw3-version
-    % ruby extconf.rb
-    % make
-    % make site-install
-  Or
-    % make install
-  (If you are using Ruby 1.8, make install is the same make site-install.)
+    Install fftw3 (in OSX with MacPorts: sudo port install fftw3)
+    sudo gem install fftw3
 
 ==How to use
 
 See the following peice of code. (Install this library and copy and
 paste the following to the interactive shell irb).
 
-  require "narray"
-  require "numru/fftw3"
-  include NumRu
+  require "fftw3"
 
   na = NArray.float(8,6)   # float -> will be corced to complex
   na[1,1]=1
 
   # <example 1>
-  fc = FFTW3.fft(na, -1)/na.length  # forward 2D FFT and normalization
-  nc = FFTW3.fft(fc, 1)       # backward 2D FFT (complex) --> 
+  fc = FFTW3.fft(na)/na.length  # forward 2D FFT and normalization
+  nc = FFTW3.ifft(fc)       # backward 2D FFT (complex) --> 
   nb = nc.real                # should be equal to na except round errors  
 
   # <example 2>
-  fc = FFTW3.fft(na, -1, 0) / na.shape[0]  # forward FFT with the first dim
+  fc = FFTW3.fft(na, 0) / na.shape[0]  # forward FFT with the first dim
 
   # <example 3>
-  fc = FFTW3.fft(na, -1, 1) / na.shape[1]  # forward FFT with the second dim
+  fc = FFTW3.fft(na, 1) / na.shape[1]  # forward FFT with the second dim
 
 ==API Reference
 
 ===Module methods
 
----fft(narray, dir [,dim,dim,...])
+---fft(narray, [dim,dim,...])
 
     Complex FFT.
 
@@ -91,7 +66,6 @@ paste the following to the interactive shell irb).
       version of FFTW3 is installed (before installing this module),
       this method does a single-precision transform. 
       Otherwise, a double-precision transform is used.
-    * dir (-1 or 1) : forward transform if -1; backward transform if 1.
     * optional 3rd, 4th,... arguments (Integer) : Specifies dimensions 
       to apply FFT. For example, if 0, the first dimension is
       transformed (1D FFT); If -1, the last dimension is used (1D FFT);
@@ -112,5 +86,7 @@ paste the following to the interactive shell irb).
       the result of FFTW.fft(narray, -1) (FFT for all dimensions)
       can be normalized by narray.length.
 
-
+---ifft(narray, [dim,dim,...])
+     
+     Complex inverse FFT
 

data/Rakefile

@@ -1,6 +1,6 @@
 require 'echoe'
 
-Echoe.new("fftw3", "0.2") do |p|
+Echoe.new("fftw3", "0.3") do |p|
   p.author = "T. Horinouchi, Evan Weaver"
   p.project = "fauna"
   p.dependencies = ["narray"]

data/ext/na_fftw3.c

@@ -278,5 +278,5 @@ void
  Init_fftw3()
 {
   mFFTW3 = rb_define_module("FFTW3");
-  rb_define_module_function(mFFTW3, "fft", na_fftw3, -1);
+  rb_define_module_function(mFFTW3, "fft_raw", na_fftw3, -1);
 }

data/fftw3.gemspec

@@ -2,12 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fftw3}
-  s.version = "0.2"
+  s.version = "0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["T. Horinouchi, Evan Weaver"]
-  s.cert_chain = ["/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-public_cert.pem"]
-  s.date = %q{2009-10-15}
+  s.date = %q{2009-10-21}
   s.description = %q{Gem version of T. Horinouchi's ruby-fftw3.}
   s.email = %q{}
   s.extensions = ["ext/extconf.rb"]
@@ -17,8 +16,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Fftw3", "--main", "README"]
   s.require_paths = ["lib", "ext"]
   s.rubyforge_project = %q{fauna}
-  s.rubygems_version = %q{1.3.4}
-  s.signing_key = %q{/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-private_key.pem}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Gem version of T. Horinouchi's ruby-fftw3.}
   s.test_files = ["test/test_fftw3.rb"]
 

data/lib/fftw3.rb

@@ -4,4 +4,13 @@ require 'narray'
 require 'fftw3/fftw3'
 
 module FFTW3
+  def self.fft(*args)
+    args.insert(1, -1)
+    fft_raw(*args)
+  end
+
+  def self.ifft(*args)
+    args.insert(1, 1)
+    fft_raw(*args)
+  end
 end

data/test/test_fftw3.rb

@@ -5,33 +5,33 @@ 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 
+fc = FFTW3.fft(na)/na.length
 p fc
 p fc.real
 
-p FFTW3.fft(fc, 1).real
+p FFTW3.ifft(fc).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 
+fc = FFTW3.fft(na)/na.length
 p fc
-p FFTW3.fft(fc, 1).real
+p FFTW3.ifft(fc).real
 
 print "\n**TEST** dimension selection\n\n"
 
-fc = FFTW3.fft(na, -1, 0)/na.shape[0]
+fc = FFTW3.fft(na, 0)/na.shape[0]
 p fc
-p FFTW3.fft(fc, 1, 0).real
-fc = FFTW3.fft(na, -1, 1)/na.shape[1]
+p FFTW3.ifft(fc, 0).real
+fc = FFTW3.fft(na, 1)/na.shape[1]
 p fc
-p FFTW3.fft(fc, 1, 1).real
+p FFTW3.ifft(fc, 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
+p( fc=FFTW3.fft(na, 0, 2) / (na.shape[0]*na.shape[2]) )
+p( fc=FFTW3.fft(na, 1) / na.shape[1] )
+p( fc=FFTW3.fft(na, 0,1,2)  / (na.shape[0]*na.shape[1]*na.shape[2]) )
+p FFTW3.ifft(fc, 0,1,2).real
 
 

metadata

@@ -1,36 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: fftw3
 version: !ruby/object:Gem::Version 
-  version: "0.2"
+  version: "0.3"
 platform: ruby
 authors: 
 - T. Horinouchi, Evan Weaver
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDLjCCAhagAwIBAgIBADANBgkqhkiG9w0BAQUFADA9MQ0wCwYDVQQDDARldmFu
-  MRgwFgYKCZImiZPyLGQBGRYIY2xvdWRidXIxEjAQBgoJkiaJk/IsZAEZFgJzdDAe
-  Fw0wNzA5MTYxMDMzMDBaFw0wODA5MTUxMDMzMDBaMD0xDTALBgNVBAMMBGV2YW4x
-  GDAWBgoJkiaJk/IsZAEZFghjbG91ZGJ1cjESMBAGCgmSJomT8ixkARkWAnN0MIIB
-  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5C0Io89nyApnr+PvbNFge9Vs
-  yRWAlGBUEMahpXp28VrrfXZT0rAW7JBo4PlCE3jl4nE4dzE6gAdItSycjTosrw7A
-  Ir5+xoyl4Vb35adv56TIQQXvNz+BzlqnkAY5JN0CSBRTQb6mxS3hFyD/h4qgDosj
-  R2RFVzHqSxCS8xq4Ny8uzOwOi+Xyu4w67fI5JvnPvMxqrlR1eaIQHmxnf76RzC46
-  QO5QhufjAYGGXd960XzbQsQyTDUYJzrvT7AdOfiyZzKQykKt8dEpDn+QPjFTnGnT
-  QmgJBX5WJN0lHF2l1sbv3gh4Kn1tZu+kTUqeXY6ShAoDTyvZRiFqQdwh8w2lTQID
-  AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU+WqJz3xQ
-  XSea1hRvvHWcIMgeeC4wDQYJKoZIhvcNAQEFBQADggEBAGLZ75jfOEW8Nsl26CTt
-  JFrWxQTcQT/UljeefVE3xYr7lc9oQjbqO3FOyued3qW7TaNEtZfSHoYeUSMYbpw1
-  XAwocIPuSRFDGM4B+hgQGVDx8PMGiJKom4qLXjO40UZsR7QyN/u869Vj45LURm6h
-  MBcPeqCASI+WNprj9+uZa2kmHiitrFqqfMBNlm5IFbn9XeYSta9AHVvs5QQqV2m5
-  hIPfLqCyxsn/YgOGvo6iwyQTWyTswamaAC3HRWZxIS1sfn/Ssqa7E7oQMkv5FAXr
-  x5rKePfXINf8XTJczkl9OBEYdE9aNdJsJpXD0asLgGVwBICS5Bjohp6mizJcDC1+
-  yZ0=
-  -----END CERTIFICATE-----
+cert_chain: []
 
-date: 2009-10-15 00:00:00 -07:00
+date: 2009-10-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -95,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: fauna
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Gem version of T. Horinouchi's ruby-fftw3.

metadata.gz.sig

@@ -1 +0,0 @@
-�����k�IM e~���]1�HAcM@�.���74��F��<�֝�O�X��]��a+)EM�/V����C-�m�9�\6��n��=3�'j�����[׬����F��o�P�_�ߊ�2�‰{ ���Ps�赊��=%:$�p������r�S��ze�.(�k�	�Jt~�Ѝ�����U&&��C�c�lw²X%Jd�>+&����AB9(�/�CAEcO�Rg��{4?SR�
����U�x�A