fftw3-ruby 0.1.0

data/lib/fftw3/ffi/binding_template.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module FFTW3
+  module FFI
+    module BindingTemplate
+      def self.define_bindings(mod, prefix, lib_names) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        mod.instance_variable_set(:@available, false)
+
+        mod.define_singleton_method(:available?) { @available }
+
+        begin
+          mod.module_eval do
+            extend ::FFI::Library
+            ffi_lib lib_names
+
+            callback :"#{prefix}write_char_func", [:char, :pointer], :void
+            callback :"#{prefix}read_char_func", [:pointer], :int
+
+            # --- Plan Execution / Destruction ---
+            attach_function :"#{prefix}execute", [:pointer], :void
+            attach_function :"#{prefix}destroy_plan", [:pointer], :void
+
+            # --- Basic: Complex DFT ---
+            attach_function :"#{prefix}plan_dft",
+                            [:int, :pointer, :pointer, :pointer, :int, :uint], :pointer
+            attach_function :"#{prefix}plan_dft_1d",
+                            [:int, :pointer, :pointer, :int, :uint], :pointer
+            attach_function :"#{prefix}plan_dft_2d",
+                            [:int, :int, :pointer, :pointer, :int, :uint], :pointer
+            attach_function :"#{prefix}plan_dft_3d",
+                            [:int, :int, :int, :pointer, :pointer, :int, :uint], :pointer
+
+            # --- Basic: R2C ---
+            attach_function :"#{prefix}plan_dft_r2c",
+                            [:int, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_dft_r2c_1d",
+                            [:int, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_dft_r2c_2d",
+                            [:int, :int, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_dft_r2c_3d",
+                            [:int, :int, :int, :pointer, :pointer, :uint], :pointer
+
+            # --- Basic: C2R ---
+            attach_function :"#{prefix}plan_dft_c2r",
+                            [:int, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_dft_c2r_1d",
+                            [:int, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_dft_c2r_2d",
+                            [:int, :int, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_dft_c2r_3d",
+                            [:int, :int, :int, :pointer, :pointer, :uint], :pointer
+
+            # --- Basic: R2R ---
+            attach_function :"#{prefix}plan_r2r",
+                            [:int, :pointer, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_r2r_1d",
+                            [:int, :pointer, :pointer, :int, :uint], :pointer
+            attach_function :"#{prefix}plan_r2r_2d",
+                            [:int, :int, :pointer, :pointer, :int, :int, :uint], :pointer
+            attach_function :"#{prefix}plan_r2r_3d",
+                            [:int, :int, :int, :pointer, :pointer, :int, :int, :int, :uint], :pointer
+
+            # --- Advanced (many) ---
+            attach_function :"#{prefix}plan_many_dft",
+                            [:int, :pointer, :int,
+                             :pointer, :pointer, :int, :int,
+                             :pointer, :pointer, :int, :int,
+                             :int, :uint], :pointer
+            attach_function :"#{prefix}plan_many_dft_r2c",
+                            [:int, :pointer, :int,
+                             :pointer, :pointer, :int, :int,
+                             :pointer, :pointer, :int, :int,
+                             :uint], :pointer
+            attach_function :"#{prefix}plan_many_dft_c2r",
+                            [:int, :pointer, :int,
+                             :pointer, :pointer, :int, :int,
+                             :pointer, :pointer, :int, :int,
+                             :uint], :pointer
+            attach_function :"#{prefix}plan_many_r2r",
+                            [:int, :pointer, :int,
+                             :pointer, :pointer, :int, :int,
+                             :pointer, :pointer, :int, :int,
+                             :pointer, :uint], :pointer
+
+            # --- Guru ---
+            attach_function :"#{prefix}plan_guru_dft",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :int, :uint], :pointer
+            attach_function :"#{prefix}plan_guru_split_dft",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_guru_dft_r2c",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_guru_split_dft_r2c",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_guru_dft_c2r",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_guru_split_dft_c2r",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_guru_r2r",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :pointer, :uint], :pointer
+
+            # --- Guru64 ---
+            attach_function :"#{prefix}plan_guru64_dft",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :int, :uint], :pointer
+            attach_function :"#{prefix}plan_guru64_split_dft",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_guru64_dft_r2c",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_guru64_split_dft_r2c",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_guru64_dft_c2r",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_guru64_split_dft_c2r",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :pointer, :uint], :pointer
+            attach_function :"#{prefix}plan_guru64_r2r",
+                            [:int, :pointer, :int, :pointer, :pointer, :pointer, :pointer, :uint], :pointer
+
+            # --- New-array Execute ---
+            attach_function :"#{prefix}execute_dft", [:pointer, :pointer, :pointer], :void
+            attach_function :"#{prefix}execute_split_dft", [:pointer, :pointer, :pointer, :pointer, :pointer], :void
+            attach_function :"#{prefix}execute_dft_r2c", [:pointer, :pointer, :pointer], :void
+            attach_function :"#{prefix}execute_split_dft_r2c", [:pointer, :pointer, :pointer, :pointer], :void
+            attach_function :"#{prefix}execute_dft_c2r", [:pointer, :pointer, :pointer], :void
+            attach_function :"#{prefix}execute_split_dft_c2r", [:pointer, :pointer, :pointer, :pointer], :void
+            attach_function :"#{prefix}execute_r2r", [:pointer, :pointer, :pointer], :void
+
+            # --- Memory ---
+            attach_function :"#{prefix}malloc", [:size_t], :pointer
+            attach_function :"#{prefix}alloc_real", [:size_t], :pointer
+            attach_function :"#{prefix}alloc_complex", [:size_t], :pointer
+            attach_function :"#{prefix}free", [:pointer], :void
+
+            # --- Wisdom ---
+            attach_function :"#{prefix}export_wisdom_to_filename", [:string], :int
+            attach_function :"#{prefix}export_wisdom_to_file", [:pointer], :void
+            attach_function :"#{prefix}export_wisdom_to_string", [], :pointer
+            attach_function :"#{prefix}export_wisdom", [:"#{prefix}write_char_func", :pointer], :void
+            attach_function :"#{prefix}import_system_wisdom", [], :int
+            attach_function :"#{prefix}import_wisdom_from_filename", [:string], :int
+            attach_function :"#{prefix}import_wisdom_from_file", [:pointer], :int
+            attach_function :"#{prefix}import_wisdom_from_string", [:string], :int
+            attach_function :"#{prefix}import_wisdom", [:"#{prefix}read_char_func", :pointer], :int
+            attach_function :"#{prefix}forget_wisdom", [], :void
+
+            # --- Utility ---
+            attach_function :"#{prefix}cleanup", [], :void
+            attach_function :"#{prefix}set_timelimit", [:double], :void
+            attach_function :"#{prefix}flops", [:pointer, :pointer, :pointer, :pointer], :void
+            attach_function :"#{prefix}estimate_cost", [:pointer], :double
+            attach_function :"#{prefix}cost", [:pointer], :double
+            attach_function :"#{prefix}alignment_of", [:pointer], :int
+            attach_function :"#{prefix}fprint_plan", [:pointer, :pointer], :void
+            attach_function :"#{prefix}print_plan", [:pointer], :void
+            attach_function :"#{prefix}sprint_plan", [:pointer], :pointer
+          end
+
+          mod.instance_variable_set(:@available, true)
+        rescue LoadError
+          # Library not available — module remains unavailable
+        end
+      end
+    end
+  end
+end

data/lib/fftw3/ffi/double.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "binding_template"
+
+module FFTW3
+  module FFI
+    module Double; end
+
+    BindingTemplate.define_bindings(
+      Double,
+      "fftw_",
+      LibraryLoader.find(:double)
+    )
+  end
+end

data/lib/fftw3/ffi/float.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "binding_template"
+
+module FFTW3
+  module FFI
+    module Float; end
+
+    BindingTemplate.define_bindings(
+      Float,
+      "fftwf_",
+      LibraryLoader.find(:float)
+    )
+  end
+end

data/lib/fftw3/ffi/library_loader.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module FFTW3
+  module FFI
+    module LibraryLoader
+      LIBRARY_NAMES = {
+        double: %w[libfftw3.so libfftw3.dylib fftw3.dll fftw3],
+        float: %w[libfftw3f.so libfftw3f.dylib fftw3f.dll fftw3f],
+        long_double: %w[libfftw3l.so libfftw3l.dylib fftw3l.dll fftw3l],
+        quad: %w[libfftw3q.so libfftw3q.dylib fftw3q.dll fftw3q],
+        threads_double: %w[libfftw3_threads.so libfftw3_threads.dylib fftw3_threads],
+        threads_float: %w[libfftw3f_threads.so libfftw3f_threads.dylib fftw3f_threads],
+        threads_long_double: %w[libfftw3l_threads.so libfftw3l_threads.dylib fftw3l_threads],
+        threads_quad: %w[libfftw3q_threads.so libfftw3q_threads.dylib fftw3q_threads]
+      }.freeze
+
+      def self.find(precision)
+        names = LIBRARY_NAMES.fetch(precision)
+        lib_dir = ENV["FFTW3_LIB_DIR"]
+
+        if lib_dir
+          names.each do |name|
+            path = File.join(lib_dir, name)
+            return path if File.exist?(path)
+          end
+        end
+
+        names
+      end
+
+      def self.find_threads(precision)
+        key = :"threads_#{precision}"
+        find(key)
+      end
+
+      def self.open(precision)
+        @dynamic_libraries ||= {}
+        return @dynamic_libraries[precision] if @dynamic_libraries.key?(precision)
+
+        loaded_path = begin
+          fftw_module = FFTW3::FFI.module_for(precision)
+          fftw_module.ffi_libraries.first&.name if fftw_module.respond_to?(:ffi_libraries)
+        rescue FFTW3::Error::InvalidArgument
+          nil
+        end
+
+        library_names = [loaded_path, *Array(find(precision))].compact.uniq
+        library = library_names.filter_map do |name|
+          begin
+            ::FFI::DynamicLibrary.open(name, ::FFI::DynamicLibrary::RTLD_LAZY)
+          rescue LoadError, RuntimeError
+            nil
+          end
+        end.first
+
+        return @dynamic_libraries[precision] = library if library
+
+        raise FFTW3::Error::LibraryNotFound, "Unable to load FFTW library for #{precision}"
+      end
+    end
+
+    PRECISION_CONFIG = {
+      double: { prefix: "fftw_", real_type: :double },
+      float: { prefix: "fftwf_", real_type: :float },
+      long_double: { prefix: "fftwl_", real_type: :long_double },
+      quad: { prefix: "fftwq_", real_type: :float128 }
+    }.freeze
+
+    def self.module_for(precision)
+      case precision
+      when :double      then Double
+      when :float       then Float
+      when :long_double then LongDouble
+      when :quad        then Quad
+      else raise FFTW3::Error::InvalidArgument, "Unknown precision: #{precision}"
+      end
+    end
+
+    def self.prefix_for(precision)
+      PRECISION_CONFIG.fetch(precision)[:prefix]
+    end
+
+    def self.string_constant(precision, name)
+      symbol = "#{prefix_for(precision)}#{name}"
+      LibraryLoader.open(precision).find_variable(symbol).read_string
+    rescue FFTW3::Error::LibraryNotFound, LoadError, RuntimeError
+      nil
+    end
+  end
+end

data/lib/fftw3/ffi/long_double.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "binding_template"
+
+module FFTW3
+  module FFI
+    module LongDouble; end
+
+    BindingTemplate.define_bindings(
+      LongDouble,
+      "fftwl_",
+      LibraryLoader.find(:long_double)
+    )
+  end
+end

data/lib/fftw3/ffi/quad.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "binding_template"
+
+module FFTW3
+  module FFI
+    module Quad; end
+
+    BindingTemplate.define_bindings(
+      Quad,
+      "fftwq_",
+      LibraryLoader.find(:quad)
+    )
+  end
+end

data/lib/fftw3/ffi/types.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "ffi"
+
+module FFTW3
+  module FFI
+    module Types
+      class IODimStruct < ::FFI::Struct
+        layout :n, :int,
+               :is, :int,
+               :os, :int
+      end
+
+      class IODim64Struct < ::FFI::Struct
+        layout :n, :int64,
+               :is, :int64,
+               :os, :int64
+      end
+    end
+  end
+end

data/lib/fftw3/iodim.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FFTW3
+  class IODim
+    def self.to_ffi(dims)
+      ptr = ::FFI::MemoryPointer.new(FFTW3::FFI::Types::IODimStruct, dims.length)
+      dims.each_with_index do |d, i|
+        struct = FFTW3::FFI::Types::IODimStruct.new(ptr + i * FFTW3::FFI::Types::IODimStruct.size)
+        struct[:n] = d[:n]
+        struct[:is] = d[:is]
+        struct[:os] = d[:os]
+      end
+      ptr
+    end
+  end
+
+  class IODim64
+    def self.to_ffi(dims)
+      ptr = ::FFI::MemoryPointer.new(FFTW3::FFI::Types::IODim64Struct, dims.length)
+      dims.each_with_index do |d, i|
+        struct = FFTW3::FFI::Types::IODim64Struct.new(ptr + i * FFTW3::FFI::Types::IODim64Struct.size)
+        struct[:n] = d[:n]
+        struct[:is] = d[:is]
+        struct[:os] = d[:os]
+      end
+      ptr
+    end
+  end
+end