numo-pocketfft 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 170eebc1e93586a62ba569d77a3a48bf8c1deb2a
-  data.tar.gz: a40006057f6538de447002968f1e5d17d7f72ab3
+  metadata.gz: 0b5b5dc31d542918a00c130c3397e70f99636dc5
+  data.tar.gz: f1e59827f23e783c2d3d3c49e9339ab9bfebddd7
 SHA512:
-  metadata.gz: 2a93c018c1f75ad1c903d5235e874ed6e881cddf33523ac9be7ebff7c047e2767561db48204c2a5ec13f72d243cee1e49394bfa0362b63b20f395245801700d9
-  data.tar.gz: 4c23f877e13768d2641f69ddf000b54603038df559b250179a320f395c0920f31a162cfb76b2bde310add0ea1ce8f8b5540da8429dfaf2b93b9c64dc5ca8539c
+  metadata.gz: 2d7ac577d847186df9d7ec726e4403d2218690180df2c244b202fc928cd6919f02381e6a86863034817b027497abfb3ce107df0439ff8f8888b17e28057868ee
+  data.tar.gz: 4987a31efec2b173930f94f1e0cc2e84d47d088d36d3953688a07639114e428cfb40259c0b14e653e7e0c6e1af76d10c469ed167a02f2864217610d8f3551fd6

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.2.0
+- Add fftconvolve method that convolves two arrays with FFT.
+
 # 0.1.1
 - Add input validation for empty array.
 - Add input validation for non-Numo::NArray object.

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://travis-ci.org/yoshoku/numo-pocketfft.svg?branch=master)](https://travis-ci.org/yoshoku/numo-pocketfft)
 [![Coverage Status](https://coveralls.io/repos/github/yoshoku/numo-pocketfft/badge.svg?branch=master)](https://coveralls.io/github/yoshoku/numo-pocketfft?branch=master)
 [![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/yoshoku/numo-liblinear/blob/master/LICENSE.txt)
-[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/numo-pocketfft/0.1.1)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/numo-pocketfft/0.2.0)
 
 Numo::Pocketfft provides functions for performing descrete Fourier Transform with
 [Numo::NArray](https://github.com/ruby-numo/numo-narray) by using
@@ -15,7 +15,7 @@ Note: There are other useful Ruby gems perform descrete Fourier Transform with N
 
 ## Installation
 
-Numo::Pocketfft bundles pocketfft codes, so there is no need to install the library in advance.
+Numo::Pocketfft bundles pocketfft codes, so there is no need to install another external library in advance.
 Add this line to your application's Gemfile:
 
 ```ruby

data/lib/numo/pocketfft.rb

@@ -146,6 +146,46 @@ module Numo
       raw_fft(b, last_axis_id, inverse: true, real: true)
     end
 
+    # Convolve two N-dimensinal arrays using dscrete Fourier Transform.
+    # @example
+    #   require 'numo/pocketfftw'
+    #
+    #   a = Numo::DFloat[1, 2, 3]
+    #   b = Numo::DFloat[4, 5]
+    #   p Numo::Pocketfft.fftconvolve(a, b)
+    #   # Numo::DFloat#shape=[4]
+    #   # [4, 13, 22, 15]
+    #
+    #   a = Numo::DFloat[[1, 2], [3, 4]]
+    #   b = Numo::DFloat[[5, 6], [7, 8]]
+    #   p Numo::Pocketfft.fftconvolve(a, b)
+    #   # Numo::DFloat#shape=[3,3]
+    #   # [[5, 16, 12],
+    #   #  [22, 60, 40],
+    #   #  [21, 52, 32]]
+    # @param a [Numo::DFloat/Numo::DComplex] Fisrt input array with any-dimension.
+    # @param b [Numo::DFloat/Numo::DComplex] Second input array with the same number of dimensions as first input array.
+    # @return [Numo::DFloat/Numo::DComplex] The discrete linear convolution of 'a' with 'b'.
+    def fftconvolve(a, b)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray) && b.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty? || b.empty?
+      raise ArgumentError, 'Input arrays should have the same dimensionarity' if a.ndim != b.ndim
+
+      ashp = a.shape
+      bshp = b.shape
+
+      return a * b if (ashp + bshp).all? { |el| el == 1 }
+
+      retshp = Array.new(a.ndim) { |n| ashp[n] + bshp[n] - 1 }
+      a_zp = Numo::DComplex.zeros(*retshp).tap { |arr| arr[*ashp.map { |n| 0...n }] = a }
+      b_zp = Numo::DComplex.zeros(*retshp).tap { |arr| arr[*bshp.map { |n| 0...n }] = b }
+      ret = ifftn(fftn(a_zp) * fftn(b_zp))
+
+      return ret if a.is_a?(Numo::DComplex) || a.is_a?(Numo::SComplex) || b.is_a?(Numo::DComplex) || b.is_a?(Numo::SComplex)
+
+      ret.real
+    end
+
     # @!visibility private
     def raw_fft(a, axis_id, inverse:, real:)
       if axis_id == a.ndim - 1

data/lib/numo/pocketfft/version.rb

@@ -5,6 +5,6 @@ module Numo
   # Numo::Pocketfft is the module that has functions for Fourier transform.
   module Pocketfft
     # The version of Numo::Pocketfft you are using.
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numo-pocketfft
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - yoshoku
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-11 00:00:00.000000000 Z
+date: 2019-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray