numo-pocketfft 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bd70edeb6b4247e01c8cc7cf439830a158518550f3c95c4ca5b502ae6ef7c2d
-  data.tar.gz: 2ff73865a15805b7e8e69d55ac87f892d3d0e4aea9b0e2af7cd129b3fa489d63
+  metadata.gz: f3fe78551040f4879625ac62a60b76e257893e014f30f1d740d8fccfac4f4f2b
+  data.tar.gz: 6fdc89c8a1143109859fd2ac77b1a27bc03ca3979ddf3421b13efcd3588905d6
 SHA512:
-  metadata.gz: ef1cfc56b929763495695a28855217292a65126cdbf7134aaa208334722b75456724e0196719932c7fedbcad2dc010e8d34d937c65554429992b623ed6bfdf9f
-  data.tar.gz: '08917a93b37b1c81519a5ad11fde74585077eee3d80761b17a2cbac24b8a67b01ae48f1afdedf8aee8a872af28eaf3df48a6c06006a6b53f2ab0381941bd5573'
+  metadata.gz: 6bed07e163241fc82e64236739eeaadebe8030307b08e07e53a9637abf4283cbb1250fb0c68213c03a127c953bc7c4c3317f52743423fa6f4a5234bec5f06707
+  data.tar.gz: c71560d98756712516bfcdd494e236f3ff945cf1f989211c068d81bb27305875ca2ebbc361026f49d9e04a937b59881510109b72860e42d732ca3efc2caa5354

data/.clang-format

@@ -0,0 +1,149 @@
+---
+Language:        Cpp
+# BasedOnStyle:  LLVM
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignConsecutiveMacros: false
+AlignConsecutiveAssignments: false
+AlignConsecutiveBitFields: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Right
+AlignOperands:   Align
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllConstructorInitializersOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortEnumsOnASingleLine: true
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: MultiLine
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterCaseLabel:  false
+  AfterClass:      false
+  AfterControlStatement: Never
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     false
+  BeforeElse:      false
+  BeforeLambdaBody: false
+  BeforeWhile:     false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     128
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+    SortPriority:    0
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+    SortPriority:    0
+  - Regex:           '.*'
+    Priority:        1
+    SortPriority:    0
+IncludeIsMainRegex: '(Test)?$'
+IncludeIsMainSourceRegex: ''
+IndentCaseLabels: false
+IndentCaseBlocks: false
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentExternBlock: AfterExternBlock
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+InsertTrailingCommas: None
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 2
+ObjCBreakBeforeNestedBlockParam: true
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Left
+ReflowComments:  true
+SortIncludes:    true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+Standard:        Latest
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth:        8
+UseCRLF:         false
+UseTab:          Never
+WhitespaceSensitiveMacros:
+  - STRINGIZE
+  - PP_STRINGIZE
+  - BOOST_PP_STRINGIZE
+...
+

data/.github/workflows/build.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        ruby: [ '2.5', '2.6', '2.7' ]
+        ruby: [ '2.6', '2.7', '3.0' ]
     steps:
       - uses: actions/checkout@v2
       - name: Checkout submodule

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.3.0
+- Add type declaration file: sig/numo/pocketfft.rbs
+- Refactor to avoid generating unnecessary arrays.
+
 # 0.2.2
 - Fix bug that caused segmentation fault due to garbage collection ([#4](https://github.com/yoshoku/numo-pocketfft/pull/4)).
 - Fix some configuration files.

data/Gemfile

@@ -3,8 +3,10 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in numo-pocketfft.gemspec
 gemspec
 
-gem 'rake', '~> 12.0'
+gem 'rake', '~> 13.0'
 gem 'rake-compiler', '~> 1.0'
 gem 'rspec', '~> 3.0'
 gem 'simplecov', '~> 0.19'
 gem 'simplecov-lcov', '~> 0.8'
+gem 'rbs', '~> 1.2'
+gem 'steep', '~> 0.44'

data/README.md

@@ -1,7 +1,7 @@
 # Numo::Pocketfft
 
 [![Build Status](https://github.com/yoshoku/numo-pocketfft/workflows/build/badge.svg)](https://github.com/yoshoku/numo-pocketfft/actions?query=workflow%3Abuild)
-[![Coverage Status](https://coveralls.io/repos/github/yoshoku/numo-pocketfft/badge.svg?branch=master)](https://coveralls.io/github/yoshoku/numo-pocketfft?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/yoshoku/numo-pocketfft/badge.svg?branch=main)](https://coveralls.io/github/yoshoku/numo-pocketfft?branch=main)
 [![Gem Version](https://badge.fury.io/rb/numo-pocketfft.svg)](https://badge.fury.io/rb/numo-pocketfft)
 [![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/yoshoku/numo-pocketfft/blob/main/LICENSE.txt)
 [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://yoshoku.github.io/numo-pocketfft/doc/)

data/Steepfile

@@ -0,0 +1,20 @@
+target :lib do
+  signature "sig"
+#
+  check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   library "numo-narray"           # Gems
+end
+
+# target :spec do
+#   signature "sig", "sig-private"
+#
+#   check "spec"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "rspec"
+# end

data/ext/numo/pocketfft/pocketfftext.c

@@ -3,8 +3,7 @@
 VALUE mNumo;
 VALUE mPocketfft;
 
-VALUE numo_pocketfft_fft(VALUE x_val, int is_forward)
-{
+VALUE numo_pocketfft_fft(VALUE x_val, int is_forward) {
   narray_t* x_nary;
   double* x_pt;
   size_t length;
@@ -40,7 +39,7 @@ VALUE numo_pocketfft_fft(VALUE x_val, int is_forward)
   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);
+  memset(z_pt, 0, (NA_SIZE(z_nary) * 2) * sizeof(double));
 
   fail = 0;
   fct = is_forward == 1 ? 1.0 : 1.0 / length;
@@ -74,24 +73,17 @@ VALUE numo_pocketfft_fft(VALUE x_val, int is_forward)
 /**
  * @!visibility private
  */
-static VALUE numo_pocketfft_cfft(VALUE self, VALUE x_val)
-{
-  return numo_pocketfft_fft(x_val, 1);
-}
+static VALUE numo_pocketfft_cfft(VALUE self, VALUE x_val) { return numo_pocketfft_fft(x_val, 1); }
 
 /**
  * @!visibility private
  */
-static VALUE numo_pocketfft_icfft(VALUE self, VALUE x_val)
-{
-  return numo_pocketfft_fft(x_val, 0);
-}
+static VALUE numo_pocketfft_icfft(VALUE self, VALUE x_val) { return numo_pocketfft_fft(x_val, 0); }
 
 /**
  * @!visibility private
  */
-static VALUE numo_pocketfft_rfft(VALUE self, VALUE x_val)
-{
+static VALUE numo_pocketfft_rfft(VALUE self, VALUE x_val) {
   narray_t* x_nary;
   double* x_pt;
   int n_dims;
@@ -132,7 +124,7 @@ static VALUE numo_pocketfft_rfft(VALUE self, VALUE x_val)
   z_val = rb_narray_new(numo_cDComplex, n_dims, z_shape);
   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);
+  memset(z_pt, 0, (NA_SIZE(z_nary) * 2) * sizeof(double));
 
   fail = 0;
   z_step = (int)(NA_SHAPE(z_nary)[n_dims - 1]) * 2;
@@ -168,8 +160,7 @@ static VALUE numo_pocketfft_rfft(VALUE self, VALUE x_val)
 /**
  * @!visibility private
  */
-static VALUE numo_pocketfft_irfft(VALUE self, VALUE x_val)
-{
+static VALUE numo_pocketfft_irfft(VALUE self, VALUE x_val) {
   narray_t* x_nary;
   double* x_pt;
   size_t length;
@@ -210,7 +201,7 @@ static VALUE numo_pocketfft_irfft(VALUE self, VALUE x_val)
   z_val = rb_narray_new(numo_cDFloat, n_dims, z_shape);
   z_pt = (double*)na_get_pointer_for_write(z_val);
   GetNArray(z_val, z_nary);
-  for (i = 0; i < (int)NA_SIZE(z_nary); z_pt[i++] = 0.0);
+  memset(z_pt, 0, NA_SIZE(z_nary) * sizeof(double));
 
   fail = 0;
   fct = 1.0 / length;
@@ -241,8 +232,7 @@ static VALUE numo_pocketfft_irfft(VALUE self, VALUE x_val)
   return z_val;
 }
 
-void Init_pocketfftext()
-{
+void Init_pocketfftext() {
   rb_require("numo/narray");
 
   mNumo = rb_define_module("Numo");

data/ext/numo/pocketfft/pocketfftext.h

@@ -5,6 +5,7 @@
 #include <string.h>
 
 #include <ruby.h>
+
 #include <numo/narray.h>
 #include <numo/template.h>
 

data/lib/numo/pocketfft.rb

@@ -64,8 +64,11 @@ module Numo
       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) }
+      return raw_fft(a, 0, inverse: false, real: false) if a.ndim == 1
+
+      last_axis_id = a.ndim - 1
+      b = raw_fft(a, last_axis_id, inverse: false, real: false)
+      (last_axis_id - 1).downto(0) { |ax_id| b = raw_fft(b, ax_id, inverse: false, real: false) }
       b
     end
 
@@ -77,8 +80,11 @@ module Numo
       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) }
+      return raw_fft(a, 0, inverse: true, real: false) if a.ndim == 1
+
+      last_axis_id = a.ndim - 1
+      b = raw_fft(a, 0, inverse: true, real: false)
+      1.upto(last_axis_id) { |ax_id| b = raw_fft(b, ax_id, inverse: true, real: false) }
       b
     end
 
@@ -138,9 +144,11 @@ module Numo
       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?
 
+      return raw_fft(a, 0, inverse: false, real: true) if a.ndim == 1
+
       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) }
+      (last_axis_id - 1).downto(0) { |ax_id| b = raw_fft(b, ax_id, inverse: false, real: false) }
       b
     end
 
@@ -152,9 +160,11 @@ module Numo
       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?
 
+      return raw_fft(a, 0, inverse: true, real: true) if a.ndim == 1
+
       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) }
+      b = raw_fft(a, 0, inverse: true, real: false)
+      1.upto(last_axis_id - 1) { |ax_id| b = raw_fft(b, ax_id, inverse: true, real: false) }
       raw_fft(b, last_axis_id, inverse: true, real: true)
     end
 
@@ -209,8 +219,7 @@ module Numo
             b_shape = a.shape
             b_shape[-1] = n
             b = Numo::DComplex.zeros(*b_shape)
-            b_range = [true] * b.ndim
-            b_range[-1] = 0...a.shape[-1]
+            b_range = Array.new(b.ndim) { |idx| idx < b.ndim - 1 ? true : 0...a.shape[-1] }
             b[*b_range] = a
             # inverse of dft for real data
             ext_irfft(b)

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.2.2'
+    VERSION = '0.3.0'
   end
 end

data/sig/numo/pocketfft.rbs

@@ -0,0 +1,28 @@
+module Numo
+  module Pocketfft
+    VERSION: String
+
+    def self?.fft: (Numo::DFloat | Numo::DComplex a) -> Numo::DComplex
+    def self?.fft2: (Numo::DFloat | Numo::DComplex a) -> Numo::DComplex
+    def self?.fftn: (Numo::DFloat | Numo::DComplex a) -> Numo::DComplex
+    def self?.ifft: (Numo::DComplex a) -> Numo::DComplex
+    def self?.ifft2: (Numo::DComplex a) -> Numo::DComplex
+    def self?.ifftn: (Numo::DComplex a) -> Numo::DComplex
+    def self?.rfft: (Numo::DFloat a) -> Numo::DComplex
+    def self?.rfft2: (Numo::DFloat a) -> Numo::DComplex
+    def self?.rfftn: (Numo::DFloat a) -> Numo::DComplex
+    def self?.irfft: (Numo::DComplex a) -> Numo::DFloat
+    def self?.irfft2: (Numo::DComplex a) -> Numo::DFloat
+    def self?.irfftn: (Numo::DComplex a) -> Numo::DFloat
+    def self?.fftconvolve: (Numo::DFloat | Numo::DComplex a, Numo::DFloat | Numo::DComplex b) -> Numo::DComplex
+                         | (Numo::DFloat a, Numo::DFloat b) -> Numo::DFloat
+
+    private
+
+    def self?.ext_cfft: (untyped a) -> untyped
+    def self?.ext_icfft: (untyped a) -> untyped
+    def self?.ext_rfft: (untyped a) -> untyped
+    def self?.ext_irfft: (untyped a) -> untyped
+    def self?.raw_fft: (untyped a, Integer axis_id, inverse: bool inverse, real: bool real) -> untyped
+  end
+end

data/sig/patch.rbs

@@ -0,0 +1,22 @@
+module Numo
+  class NArray
+    def empty?: () -> bool
+    def ndim: () -> Integer
+    def shape: () -> Array[Integer]
+    def swapaxes: (Integer, Integer) -> untyped
+  end
+
+  class DFloat < NArray
+    def *: (untyped) -> untyped
+    def []: (*untyped) -> untyped
+    def []=: (*untyped) -> untyped
+  end
+
+  class DComplex < NArray
+    def self.zeros: (*untyped) -> Numo::DComplex
+    def *: (untyped) -> untyped
+    def []: (*untyped) -> untyped
+    def []=: (*untyped) -> untyped
+    def real: () -> Numo::DFloat
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numo-pocketfft
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - yoshoku
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-16 00:00:00.000000000 Z
+date: 2021-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray
@@ -27,7 +27,7 @@ dependencies:
 description: 'Numo::Pocketfft provides functions for descrete Fourier Transform based
   on pocketfft.
 
-  '
+'
 email:
 - yoshoku@outlook.com
 executables: []
@@ -35,6 +35,7 @@ extensions:
 - ext/numo/pocketfft/extconf.rb
 extra_rdoc_files: []
 files:
+- ".clang-format"
 - ".coveralls.yml"
 - ".github/workflows/build.yml"
 - ".github/workflows/coverage.yml"
@@ -47,6 +48,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - ext/numo/pocketfft/extconf.rb
 - ext/numo/pocketfft/pocketfft/.gitlab-ci.yml
 - ext/numo/pocketfft/pocketfft/LICENSE.md
@@ -60,6 +62,8 @@ files:
 - lib/numo/pocketfft.rb
 - lib/numo/pocketfft/version.rb
 - numo-pocketfft.gemspec
+- sig/numo/pocketfft.rbs
+- sig/patch.rbs
 homepage: https://github.com/yoshoku/numo-pocketfft
 licenses:
 - BSD-3-Clause
@@ -69,7 +73,7 @@ metadata:
   source_code_uri: https://github.com/yoshoku/numo-pocketfft
   documentation_uri: https://yoshoku.github.io/numo-pocketfft/doc/
   bug_tracker_uri: https://github.com/yoshoku/numo-pocketfft/issues
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -84,8 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Numo::Pocketfft provides functions for descrete Fourier Transform based on
   pocketfft.