numo-pocketfft 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b5b5dc31d542918a00c130c3397e70f99636dc5
-  data.tar.gz: f1e59827f23e783c2d3d3c49e9339ab9bfebddd7
+  metadata.gz: 7986980a5b77d766c150702aec5f6913e1538bc6
+  data.tar.gz: 3e5385df4c518b9c477fbc909dcb3ea6810347a3
 SHA512:
-  metadata.gz: 2d7ac577d847186df9d7ec726e4403d2218690180df2c244b202fc928cd6919f02381e6a86863034817b027497abfb3ce107df0439ff8f8888b17e28057868ee
-  data.tar.gz: 4987a31efec2b173930f94f1e0cc2e84d47d088d36d3953688a07639114e428cfb40259c0b14e653e7e0c6e1af76d10c469ed167a02f2864217610d8f3551fd6
+  metadata.gz: 1d18ee2d9d4eaf35bceb671d7364f4d9b3017fa1b1006387b1cc6d98fba421676eebf5a7ff7904a236f2f3ec2f11c042b66d70554d8f5bfba11f505783fe03a6
+  data.tar.gz: 63c3541af48456568502e6c3f94419d45289979476e6b7747620f651293555d7bc0e02149dc6bf957fbf5a5ee3f1e32cc77127b97e1bed63982c149b123469db

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.2.1
+- Fix the link to the document.
+- Several documentation improvements.
+
 # 0.2.0
 - Add fftconvolve method that convolves two arrays with FFT.
 

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.2.0)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://yoshoku.github.io/numo-pocketfft/doc/)
 
 Numo::Pocketfft provides functions for performing descrete Fourier Transform with
 [Numo::NArray](https://github.com/ruby-numo/numo-narray) by using

data/lib/numo/pocketfft.rb

@@ -10,6 +10,7 @@ module Numo
 
     # Compute the 1-dimensional discrete Fourier Transform.
     # @param a [Numo::DFloat/Numo::DComplex] Real or complex 1-dimensional input array.
+    # @raise [ArgumentError] This error is raised if input array is not Numo::NArray, is not one-dimensional array, or is empty.
     # @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)
@@ -21,6 +22,7 @@ module Numo
 
     # Compute the 1-dimensional inverse discrete Fourier Transform.
     # @param a [Numo::DComplex] Complex 1-dimensional input array.
+    # @raise [ArgumentError] This error is raised if input array is not Numo::NArray, is not one-dimensional array, or is empty.
     # @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)
@@ -32,6 +34,7 @@ module Numo
 
     # Compute the 2-dimensional discrete Fourier Transform.
     # @param a [Numo::DFloat/Numo::DComplex] Real or complex 2-dimensional input array.
+    # @raise [ArgumentError] This error is raised if input array is not Numo::NArray, is not two-dimensional array, or is empty.
     # @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)
@@ -43,6 +46,7 @@ module Numo
 
     # Compute the 2-dimensional inverse discrete Fourier Transform.
     # @param a [Numo::DComplex] Complex 2-dimensional input array.
+    # @raise [ArgumentError] This error is raised if input array is not Numo::NArray, is not two-dimensional array, or is empty.
     # @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)
@@ -54,6 +58,7 @@ module Numo
 
     # Compute the N-dimensional discrete Fourier Transform.
     # @param a [Numo::DFloat/Numo::DComplex] Real or complex input array with any-dimension.
+    # @raise [ArgumentError] This error is raised if input array is not Numo::NArray or is empty.
     # @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)
@@ -66,6 +71,7 @@ module Numo
 
     # Compute the N-dimensional inverse discrete Fourier Transform.
     # @param a [Numo::DComplex] Complex input array with any-dimension.
+    # @raise [ArgumentError] This error is raised if input array is not Numo::NArray or is empty.
     # @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)
@@ -78,6 +84,7 @@ module Numo
 
     # Compute the 1-dimensional discrete Fourier Transform for real input.
     # @param a [Numo::DFloat] Real 1-dimensional input array.
+    # @raise [ArgumentError] This error is raised if input array is not Numo::NArray, is not one-dimensional array, or is empty.
     # @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)
@@ -89,6 +96,7 @@ module Numo
 
     # Compute the inverse of the 1-dimensional discrete Fourier Transform of real input.
     # @param a [Numo::DComplex] Complex 1-dimensional input array.
+    # @raise [ArgumentError] This error is raised if input array is not Numo::NArray, is not one-dimensional array, or is empty.
     # @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)
@@ -100,6 +108,7 @@ module Numo
 
     # Compute the 2-dimensional discrete Fourier Transform for real input.
     # @param a [Numo::DFloat] Real 2-dimensional input array.
+    # @raise [ArgumentError] This error is raised if input array is not Numo::NArray, is not two-dimensional array, or is empty.
     # @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)
@@ -111,6 +120,7 @@ module Numo
 
     # Compute the inverse of the 2-dimensional discrete Fourier Transform of real input.
     # @param a [Numo::DComplex] Complex 2-dimensional input array.
+    # @raise [ArgumentError] This error is raised if input array is not Numo::NArray, is not two-dimensional array, or is empty.
     # @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)
@@ -122,6 +132,7 @@ module Numo
 
     # Compute the N-dimensional discrete Fourier Transform for real input.
     # @param a [Numo::DFloat] Real input array with any-dimension.
+    # @raise [ArgumentError] This error is raised if input array is not Numo::NArray or is empty.
     # @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)
@@ -135,6 +146,7 @@ module Numo
 
     # Compute the inverse of the N-dimensional discrete Fourier Transform of real input.
     # @param a [Numo::DComplex] Complex input array with any-dimension.
+    # @raise [ArgumentError] This error is raised if input array is not Numo::NArray or is empty.
     # @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)
@@ -165,6 +177,7 @@ module Numo
     #   #  [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.
+    # @raise [ArgumentError] This error is raised if input arrays are not Numo::NArray, are not the same dimensionality, or are empty.
     # @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)

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

data/numo-pocketfft.gemspec

@@ -37,6 +37,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.extensions    = ['ext/numo/pocketfft/extconf.rb']
 
+  spec.metadata      = {
+    'homepage_uri' => 'https://github.com/yoshoku/numo-pocketfft',
+    'changelog_uri' => 'https://github.com/yoshoku/numo-pocketfft/blob/master/CHANGELOG.md',
+    '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'
+  }
+
   spec.add_runtime_dependency 'numo-narray', '~> 0.9.1'
 
   spec.add_development_dependency 'bundler', '~> 2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numo-pocketfft
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - yoshoku
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-18 00:00:00.000000000 Z
+date: 2019-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-narray
@@ -134,7 +134,12 @@ files:
 homepage: https://github.com/yoshoku/numo-pocketfft
 licenses:
 - BSD-3-Clause
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/yoshoku/numo-pocketfft
+  changelog_uri: https://github.com/yoshoku/numo-pocketfft/blob/master/CHANGELOG.md
+  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: 
 rdoc_options: []
 require_paths: