numo-pocketfft 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bddf2fdda35fb2a8308fabe55a365945282cec74
-  data.tar.gz: 34d970a1a6a45a667fbd57f648cd7e0dde85bf6e
+  metadata.gz: 170eebc1e93586a62ba569d77a3a48bf8c1deb2a
+  data.tar.gz: a40006057f6538de447002968f1e5d17d7f72ab3
 SHA512:
-  metadata.gz: ae9396b7f766a993efbb49ae837b684e8b3ab17b1728ec41798dbadb2954b30faf9bc0232e4b0c07faec2bea938e8f6cf02f5597771e79bbe9318cb2b56ec57c
-  data.tar.gz: 53c4212c75ffc3ce9e6b876eb4ec194fc1a7f2ada7796992675c539b08f703c250a4308cc83fa5f7a33f029965d602cba66a70cd6ce1c0d1c71f778ddaeea9e9
+  metadata.gz: 2a93c018c1f75ad1c903d5235e874ed6e881cddf33523ac9be7ebff7c047e2767561db48204c2a5ec13f72d243cee1e49394bfa0362b63b20f395245801700d9
+  data.tar.gz: 4c23f877e13768d2641f69ddf000b54603038df559b250179a320f395c0920f31a162cfb76b2bde310add0ea1ce8f8b5540da8429dfaf2b93b9c64dc5ca8539c

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 0.1.1
+- Add input validation for empty array.
+- Add input validation for non-Numo::NArray object.
+- Fix to raise NoMemoryError when happened memory allocation error.
+
+# 0.1.0
+- First release.

data/README.md

@@ -1,8 +1,10 @@
 # Numo::Pocketfft
 
+[![Gem Version](https://badge.fury.io/rb/numo-pocketfft.svg)](https://badge.fury.io/rb/numo-pocketfft)
 [![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)
 
 Numo::Pocketfft provides functions for performing descrete Fourier Transform with
 [Numo::NArray](https://github.com/ruby-numo/numo-narray) by using

data/ext/numo/pocketfft/pocketfftext.c

@@ -12,6 +12,7 @@ VALUE numo_pocketfft_fft(VALUE x_val, int is_forward)
   int n_repeats;
   int i;
   int res;
+  int fail;
   double fct;
   VALUE z_val;
   double* z_pt;
@@ -30,22 +31,27 @@ VALUE numo_pocketfft_fft(VALUE x_val, int is_forward)
   length = NA_SHAPE(x_nary)[n_dims - 1];
   x_pt = (double*)na_get_pointer_for_read(x_val);
 
+  plan = make_cfft_plan(length);
+  if (!plan) {
+    rb_raise(rb_eNoMemError, "Failed to allocate memory for plan of pocketfft.");
+    return Qnil;
+  }
+
   z_val = nary_s_new_like(numo_cDComplex, x_val);
   z_pt = (double*)na_get_pointer_for_write(z_val);
   GetNArray(z_val, z_nary);
   for (i = 0; i < (int)(NA_SIZE(z_nary) * 2); z_pt[i++] = 0.0);
 
+  fail = 0;
   fct = is_forward == 1 ? 1.0 : 1.0 / length;
-  plan = make_cfft_plan(length);
-  if (!plan) {
-    return Qnil;
-  }
-
   n_repeats = (int)(NA_SIZE(x_nary)) / length;
   for (i = 0; i < n_repeats; i++) {
     memcpy(z_pt, x_pt, 2 * length * sizeof(double));
     res = is_forward == 1 ? cfft_forward(plan, z_pt, fct) : cfft_backward(plan, z_pt, fct);
-    if (res != 0) { break; }
+    if (res != 0) {
+      fail = 1;
+      break;
+    }
     z_pt += length * 2;
     x_pt += length * 2;
   }
@@ -54,6 +60,12 @@ VALUE numo_pocketfft_fft(VALUE x_val, int is_forward)
     destroy_cfft_plan(plan);
   }
 
+  if (fail) {
+    rb_raise(rb_eNoMemError, "Failed to allocate memory in function of pocketfft.");
+    rb_funcall(z_val, rb_intern("free"), 0);
+    return Qnil;
+  }
+
   return z_val;
 }
 
@@ -84,6 +96,7 @@ static VALUE numo_pocketfft_rfft(VALUE self, VALUE x_val)
   size_t length;
   int n_repeats;
   int i;
+  int fail;
   size_t* z_shape;
   VALUE z_val;
   narray_t* z_nary;
@@ -105,6 +118,7 @@ static VALUE numo_pocketfft_rfft(VALUE self, VALUE x_val)
 
   plan = make_rfft_plan(length);
   if (!plan) {
+    rb_raise(rb_eNoMemError, "Failed to allocate memory for plan of pocketfft.");
     return Qnil;
   }
 
@@ -118,12 +132,16 @@ static VALUE numo_pocketfft_rfft(VALUE self, VALUE x_val)
   GetNArray(z_val, z_nary);
   for (i = 0; i < (int)(NA_SIZE(z_nary) * 2); z_pt[i++] = 0.0);
 
+  fail = 0;
   z_step = (int)(NA_SHAPE(z_nary)[n_dims - 1]) * 2;
   n_repeats = (int)(NA_SIZE(x_nary)) / length;
   for (i = 0; i < n_repeats; i++) {
     z_pt[z_step - 1] = 0.0;
     memcpy(z_pt + 1, x_pt, length * sizeof(double));
-    if (rfft_forward(plan, z_pt + 1, 1.0) != 0) { break; }
+    if (rfft_forward(plan, z_pt + 1, 1.0) != 0) {
+      fail = 1;
+      break;
+    }
     z_pt[0] = z_pt[1];
     z_pt[1] = 0.0;
     z_pt += z_step;
@@ -134,6 +152,12 @@ static VALUE numo_pocketfft_rfft(VALUE self, VALUE x_val)
     destroy_rfft_plan(plan);
   }
 
+  if (fail) {
+    rb_raise(rb_eNoMemError, "Failed to allocate memory in function of pocketfft.");
+    rb_funcall(z_val, rb_intern("free"), 0);
+    return Qnil;
+  }
+
   return z_val;
 }
 
@@ -148,6 +172,7 @@ static VALUE numo_pocketfft_irfft(VALUE self, VALUE x_val)
   int n_dims;
   int n_repeats;
   int i;
+  int fail;
   double fct;
   size_t* z_shape;
   VALUE z_val;
@@ -166,10 +191,10 @@ static VALUE numo_pocketfft_irfft(VALUE self, VALUE x_val)
   n_dims = NA_NDIM(x_nary);
   length = NA_SHAPE(x_nary)[n_dims - 1];
   x_pt = (double*)na_get_pointer_for_read(x_val);
-  fct = 1.0 / length;
 
   plan = make_rfft_plan(length);
   if (!plan) {
+    rb_raise(rb_eNoMemError, "Failed to allocate memory for plan of pocketfft.");
     return Qnil;
   }
 
@@ -183,11 +208,16 @@ static VALUE numo_pocketfft_irfft(VALUE self, VALUE x_val)
   GetNArray(z_val, z_nary);
   for (i = 0; i < (int)NA_SIZE(z_nary); z_pt[i++] = 0.0);
 
+  fail = 0;
+  fct = 1.0 / length;
   n_repeats = (int)(NA_SIZE(z_nary)) / length;
   for (i = 0; i < n_repeats; i++) {
     memcpy(z_pt + 1, x_pt + 2, (length - 1) * sizeof(double));
     z_pt[0] = x_pt[0];
-    if (rfft_backward(plan, z_pt, fct) != 0) { break; }
+    if (rfft_backward(plan, z_pt, fct) != 0) {
+      fail = 1;
+      break;
+    }
     z_pt += length;
     x_pt += length * 2;
   }
@@ -196,6 +226,12 @@ static VALUE numo_pocketfft_irfft(VALUE self, VALUE x_val)
     destroy_rfft_plan(plan);
   }
 
+  if (fail) {
+    rb_raise(rb_eNoMemError, "Failed to allocate memory in function of pocketfft.");
+    rb_funcall(z_val, rb_intern("free"), 0);
+    return Qnil;
+  }
+
   return z_val;
 }
 

data/lib/numo/pocketfft.rb

@@ -12,7 +12,10 @@ module Numo
     # @param a [Numo::DFloat/Numo::DComplex] Real or complex 1-dimensional input array.
     # @return [Numo::DComplex] Transformed data.
     def fft(a)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty?
       raise ArgumentError, 'Expect input array to be one-dimensional.' unless a.ndim == 1
+
       raw_fft(a, 0, inverse: false, real: false)
     end
 
@@ -20,7 +23,10 @@ module Numo
     # @param a [Numo::DComplex] Complex 1-dimensional input array.
     # @return [Numo::DComplex] Inversed transformed data.
     def ifft(a)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty?
       raise ArgumentError, 'Expect input array to be one-dimensional.' unless a.ndim == 1
+
       raw_fft(a, 0, inverse: true, real: false)
     end
 
@@ -28,7 +34,10 @@ module Numo
     # @param a [Numo::DFloat/Numo::DComplex] Real or complex 2-dimensional input array.
     # @return [Numo::DComplex] Transformed data.
     def fft2(a)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty?
       raise ArgumentError, 'Expect input array to be two-dimensional.' unless a.ndim == 2
+
       fftn(a)
     end
 
@@ -36,7 +45,10 @@ module Numo
     # @param a [Numo::DComplex] Complex 2-dimensional input array.
     # @return [Numo::DComplex] Inversed transformed data.
     def ifft2(a)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty?
       raise ArgumentError, 'Expect input array to be two-dimensional.' unless a.ndim == 2
+
       ifftn(a)
     end
 
@@ -44,6 +56,9 @@ module Numo
     # @param a [Numo::DFloat/Numo::DComplex] Real or complex input array with any-dimension.
     # @return [Numo::DComplex] Transformed data.
     def fftn(a)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty?
+
       b = a.dup
       (0...b.ndim).to_a.reverse.each { |ax_id| b = raw_fft(b, ax_id, inverse: false, real: false) }
       b
@@ -53,6 +68,9 @@ module Numo
     # @param a [Numo::DComplex] Complex input array with any-dimension.
     # @return [Numo::DComplex] Inversed transformed data.
     def ifftn(a)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty?
+
       b = a.dup
       (0...b.ndim).to_a.each { |ax_id| b = raw_fft(b, ax_id, inverse: true, real: false) }
       b
@@ -62,7 +80,10 @@ module Numo
     # @param a [Numo::DFloat] Real 1-dimensional input array.
     # @return [Numo::DComplex] Transformed data.
     def rfft(a)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty?
       raise ArgumentError, 'Expect input array to be one-dimensional.' unless a.ndim == 1
+
       raw_fft(a, 0, inverse: false, real: true)
     end
 
@@ -70,7 +91,10 @@ module Numo
     # @param a [Numo::DComplex] Complex 1-dimensional input array.
     # @return [Numo::DFloat] Inverse transformed data.
     def irfft(a)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty?
       raise ArgumentError, 'Expect input array to be one-dimensional.' unless a.ndim == 1
+
       raw_fft(a, 0, inverse: true, real: true)
     end
 
@@ -78,7 +102,10 @@ module Numo
     # @param a [Numo::DFloat] Real 2-dimensional input array.
     # @return [Numo::DComplex] Transformed data.
     def rfft2(a)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty?
       raise ArgumentError, 'Expect input array to be two-dimensional.' unless a.ndim == 2
+
       rfftn(a)
     end
 
@@ -86,7 +113,10 @@ module Numo
     # @param a [Numo::DComplex] Complex 2-dimensional input array.
     # @return [Numo::DFloat] Inverse transformed data.
     def irfft2(a)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty?
       raise ArgumentError, 'Expect input array to be two-dimensional.' unless a.ndim == 2
+
       irfftn(a)
     end
 
@@ -94,6 +124,9 @@ module Numo
     # @param a [Numo::DFloat] Real input array with any-dimension.
     # @return [Numo::DComplex] Transformed data.
     def rfftn(a)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty?
+
       last_axis_id = a.ndim - 1
       b = raw_fft(a, last_axis_id, inverse: false, real: true)
       (0...last_axis_id).to_a.reverse.each { |ax_id| b = raw_fft(b, ax_id, inverse: false, real: false) }
@@ -104,6 +137,9 @@ module Numo
     # @param a [Numo::DComplex] Complex input array with any-dimension.
     # @return [Numo::DFloat] Inverse transformed data.
     def irfftn(a)
+      raise ArgumentError, 'Expect class of input array to be Numo::NArray.' unless a.is_a?(Numo::NArray)
+      raise ArgumentError, 'Expect input array to be non-empty.' if a.empty?
+
       last_axis_id = a.ndim - 1
       b = a.dup
       (0...last_axis_id).to_a.each { |ax_id| b = raw_fft(b, ax_id, inverse: true, real: false) }

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.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numo-pocketfft
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - yoshoku
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-10 00:00:00.000000000 Z
+date: 2019-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray
@@ -110,6 +110,7 @@ files:
 - ".gitmodules"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt