numo-pocketfft 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bddf2fdda35fb2a8308fabe55a365945282cec74
+  data.tar.gz: 34d970a1a6a45a667fbd57f648cd7e0dde85bf6e
+SHA512:
+  metadata.gz: ae9396b7f766a993efbb49ae837b684e8b3ab17b1728ec41798dbadb2954b30faf9bc0232e4b0c07faec2bea938e8f6cf02f5597771e79bbe9318cb2b56ec57c
+  data.tar.gz: 53c4212c75ffc3ce9e6b876eb4ec194fc1a7f2ada7796992675c539b08f703c250a4308cc83fa5f7a33f029965d602cba66a70cd6ce1c0d1c71f778ddaeea9e9

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/bin/
+
+# rspec failure tracking
+.rspec_status
+
+*.swp
+*.bundle
+mkmf.log
+tags
+.DS_Store
+.ruby-version

data/.gitmodules

@@ -0,0 +1,4 @@
+[submodule "ext/numo/pocketfft/pocketfft"]
+	path = ext/numo/pocketfft/pocketfft
+	url = https://gitlab.mpcdf.mpg.de/mtr/pocketfft.git
+  ignore = dirty

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+sudo: true
+os: linux
+dist: bionic
+language: ruby
+cache: bundler
+rvm:
+  - '2.4'
+  - '2.5'
+  - '2.6'
+before_install:
+  - sudo apt-get install -y gcc
+  - gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yoshoku@outlook.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in numo-pocketfft.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2019 Atsushi Tatsuma
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,76 @@
+# 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)
+
+Numo::Pocketfft provides functions for performing descrete Fourier Transform with
+[Numo::NArray](https://github.com/ruby-numo/numo-narray) by using
+[pocketfft](https://gitlab.mpcdf.mpg.de/mtr/pocketfft) as backgroud library.
+
+Note: There are other useful Ruby gems perform descrete Fourier Transform with Numo::NArray:
+[Numo::FFTW](https://github.com/ruby-numo/numo-fftw) and [Numo::FFTE](https://github.com/ruby-numo/numo-ffte) by Masahiro Tanaka.
+
+## Installation
+
+Numo::Pocketfft bundles pocketfft codes, so there is no need to install the library in advance.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'numo-pocketfft'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install numo-pocketfft
+
+## Usage
+
+```ruby
+require 'numo/narray'
+require 'numo/pocketfft'
+
+a = Numo::DFloat[1, 1, 1, 1]
+# => Numo::DFloat#shape=[4]
+# [1, 1, 1, 1]
+
+b = Numo::Pocketfft.rfft(a)
+# => Numo::DComplex#shape=[3]
+# [4+0i, 0+0i, 0+0i]
+
+Numo::Pocketfft.irfft(b)
+# => Numo::DFloat#shape=[4]
+# [1, 1, 1, 1]
+
+c = Numo::DFloat.new(2, 2).rand + Complex::I * Numo::DFloat.new(2, 2).rand
+# => Numo::DComplex#shape=[2,2]
+# [[0.0617545+0.116041i, 0.373067+0.344032i],
+#  [0.794815+0.539948i, 0.201042+0.737815i]]
+
+Numo::Pocketfft.ifft2(Numo::Pocketfft.fft2(c))
+#=> Numo::DComplex#shape=[2,2]
+#[[0.0617545+0.116041i, 0.373067+0.344032i],
+# [0.794815+0.539948i, 0.201042+0.737815i]]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/numo-pocketfft. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause).
+
+## Code of Conduct
+
+Everyone interacting in the Numo::Pocketfft project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/numo-pocketfft/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rake/extensiontask'
+
+task :build => :compile
+
+Rake::ExtensionTask.new('pocketfftext') do |ext|
+  ext.ext_dir = 'ext/numo/pocketfft'
+  ext.lib_dir = 'lib/numo/pocketfft'
+end
+
+task :default => [:clobber, :compile, :spec]
+

data/ext/numo/pocketfft/extconf.rb

@@ -0,0 +1,39 @@
+require 'mkmf'
+require 'numo/narray'
+
+$LOAD_PATH.each do |lp|
+  if File.exist?(File.join(lp, 'numo/numo/narray.h'))
+    $INCFLAGS = "-I#{lp}/numo #{$INCFLAGS}"
+    break
+  end
+end
+
+unless have_header('numo/narray.h')
+  puts 'numo/narray.h not found.'
+  exit(1)
+end
+
+if RUBY_PLATFORM =~ /mswin|cygwin|mingw/
+  $LOAD_PATH.each do |lp|
+    if File.exist?(File.join(lp, 'numo/libnarray.a'))
+      $LDFLAGS = "-L#{lp}/numo #{$LDFLAGS}"
+      break
+    end
+  end
+  unless have_library('narray', 'nary_new')
+    puts 'libnarray.a not found.'
+    exit(1)
+  end
+end
+
+$CFLAGS = "#{$CFLAGS} -std=c99"
+
+$srcs = Dir.glob("#{$srcdir}/*.c").map { |path| File.basename(path) }
+$srcs << 'pocketfft.c'
+Dir.glob("#{$srcdir}/*/") do |path|
+  dir = File.basename(path)
+  $INCFLAGS << " -I$(srcdir)/#{dir}"
+  $VPATH << "$(srcdir)/#{dir}"
+end
+
+create_makefile('numo/pocketfft/pocketfftext')

data/ext/numo/pocketfft/pocketfft/.gitlab-ci.yml

@@ -0,0 +1,12 @@
+image: debian:testing-slim
+
+stages:
+  - testing
+
+test:
+  stage: testing
+  script:
+    - apt-get update
+    - apt-get install -y gcc
+    - gcc -O3 -W -Wall -std=c99 -march=native *.c -lm
+    - ./a.out

data/ext/numo/pocketfft/pocketfft/LICENSE.md

@@ -0,0 +1,25 @@
+Copyright (C) 2010-2019 Max-Planck-Society
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+* Neither the name of the copyright holder nor the names of its contributors may
+  be used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/ext/numo/pocketfft/pocketfft/README.md

@@ -0,0 +1,55 @@
+PocketFFT
+---------
+
+This is a heavily modified implementation of FFTPack [1,2], with the following
+advantages:
+
+- strictly C99 compliant
+- more accurate twiddle factor computation
+- very fast plan generation
+- worst case complexity for transform sizes with large prime factors is
+  `N*log(N)`, because Bluestein's algorithm [3] is used for these cases.
+
+License
+-------
+
+3-clause BSD (see LICENSE.md)
+
+
+Some code details
+-----------------
+
+Twiddle factor computation:
+
+- making use of symmetries to reduce number of sin/cos evaluations
+- all angles are reduced to the range `[0; pi/4]` for higher accuracy
+- an adapted implementation of `sincospi()` is used, which actually computes
+  `sin(x)` and `(cos(x)-1)`.
+- if `n` sin/cos pairs are required, the adjusted `sincospi()` is only called
+  `2*sqrt(n)` times; the remaining values are obtained by evaluating the
+  angle addition theorems in a numerically accurate way.
+
+Parallel invocation:
+
+- Plans only contain read-only data; all temporary arrays are allocated and
+  deallocated during an individual FFT execution. This means that a single plan
+  can be used in several threads at the same time.
+
+Efficient codelets are available for the factors:
+
+- 2, 3, 4, 5, 7, 11 for complex-valued FFTs
+- 2, 3, 4, 5 for real-valued FFTs
+
+Larger prime factors are handled by somewhat less efficient, generic routines.
+
+For lengths with very large prime factors, Bluestein's algorithm is used, and
+instead of an FFT of length `n`, a convolution of length `n2 >= 2*n-1`
+is performed, where `n2` is chosen to be highly composite.
+
+
+[1] Swarztrauber, P. 1982, Vectorizing the Fast Fourier Transforms
+    (New York: Academic Press), 51
+
+[2] https://www.netlib.org/fftpack/
+
+[3] https://en.wikipedia.org/wiki/Chirp_Z-transform

data/ext/numo/pocketfft/pocketfft/TESTING

@@ -0,0 +1,6 @@
+To run a quick test for all FFT sizes up to 8192, do
+
+gcc -std=c99 -O2 -W -Wall *.c -lm
+./a.out
+
+If there is no output, the tests have succeeded.

data/ext/numo/pocketfft/pocketfft/ffttest.c

@@ -0,0 +1,96 @@
+/*
+ * This file is part of pocketfft.
+ * Licensed under a 3-clause BSD style license - see LICENSE.md
+ */
+
+/*
+ *  Test codes for pocketfft.
+ *
+ *  Copyright (C) 2004-2018 Max-Planck-Society
+ *  \author Martin Reinecke
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <math.h>
+#include <string.h>
+#include "pocketfft.h"
+
+#define maxlen 8192
+
+static void fill_random (double *data, size_t length)
+  {
+  for (size_t m=0; m<length; ++m)
+    data[m] = rand()/(RAND_MAX+1.0)-0.5;
+  }
+
+static double errcalc (double *data, double *odata, size_t length)
+  {
+  double sum = 0, errsum = 0;
+  for (size_t m=0; m<length; ++m)
+    {
+    errsum += (data[m]-odata[m])*(data[m]-odata[m]);
+    sum += odata[m]*odata[m];
+    }
+  return sqrt(errsum/sum);
+  }
+
+static int test_real(void)
+  {
+  double data[maxlen], odata[maxlen];
+  const double epsilon=2e-15;
+  int ret = 0;
+  fill_random (odata, maxlen);
+  double errsum=0;
+  for (int length=1; length<=maxlen; ++length)
+    {
+    memcpy (data,odata,length*sizeof(double));
+    rfft_plan plan = make_rfft_plan (length);
+    rfft_forward (plan, data, 1.);
+    rfft_backward (plan, data, 1./length);
+    destroy_rfft_plan (plan);
+    double err = errcalc (data, odata, length);
+    if (err>epsilon)
+      {
+      printf("problem at real length %i: %e\n",length,err);
+      ret = 1;
+      }
+    errsum+=err;
+    }
+  printf("errsum: %e\n",errsum);
+  return ret;
+  }
+
+static int test_complex(void)
+  {
+  double data[2*maxlen], odata[2*maxlen];
+  fill_random (odata, 2*maxlen);
+  const double epsilon=2e-15;
+  int ret = 0;
+  double errsum=0;
+  for (int length=1; length<=maxlen; ++length)
+    {
+    memcpy (data,odata,2*length*sizeof(double));
+    cfft_plan plan = make_cfft_plan (length);
+    cfft_forward(plan, data, 1.);
+    cfft_backward(plan, data, 1./length);
+    destroy_cfft_plan (plan);
+    double err = errcalc (data, odata, 2*length);
+    if (err>epsilon)
+      {
+      printf("problem at complex length %i: %e\n",length,err);
+      ret = 1;
+      }
+    errsum+=err;
+    }
+  printf("errsum: %e\n",errsum);
+  return ret;
+  }
+
+int main(void)
+  {
+  int ret = 0;
+  ret = test_real();
+  ret += test_complex();
+  return ret;
+  }