Mercurial > octave
view liboctave/numeric/oct-fftw.cc @ 31605:e88a07dec498 stable
maint: Use macros to begin/end C++ namespaces.
* oct-conf-post-public.in.h: Define two macros (OCTAVE_BEGIN_NAMESPACE,
OCTAVE_END_NAMESPACE) that can be used to start/end a namespace.
* mk-opts.pl, build-env.h, build-env.in.cc, __betainc__.cc, __contourc__.cc,
__dsearchn__.cc, __eigs__.cc, __expint__.cc, __ftp__.cc, __gammainc__.cc,
__ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __lin_interpn__.cc,
__magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, auto-shlib.cc,
auto-shlib.h, balance.cc, base-text-renderer.cc, base-text-renderer.h,
besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.cc, c-file-ptr-stream.h,
call-stack.cc, call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc,
colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, data.h, debug.cc,
defaults.cc, defaults.h, defun-int.h, defun.cc, det.cc, dirfns.cc, display.cc,
display.h, dlmread.cc, dmperm.cc, dot.cc, dynamic-ld.cc, dynamic-ld.h, eig.cc,
ellipj.cc, environment.cc, environment.h, error.cc, error.h, errwarn.h,
event-manager.cc, event-manager.h, event-queue.cc, event-queue.h, fcn-info.cc,
fcn-info.h, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc,
ft-text-renderer.cc, ft-text-renderer.h, gcd.cc, getgrent.cc, getpwent.cc,
getrusage.cc, givens.cc, gl-render.cc, gl-render.h, gl2ps-print.cc,
gl2ps-print.h, graphics-toolkit.cc, graphics-toolkit.h, graphics.cc,
graphics.in.h, gsvd.cc, gtk-manager.cc, gtk-manager.h, hash.cc, help.cc,
help.h, hess.cc, hex2num.cc, hook-fcn.cc, hook-fcn.h, input.cc, input.h,
interpreter-private.cc, interpreter-private.h, interpreter.cc, interpreter.h,
inv.cc, jsondecode.cc, jsonencode.cc, kron.cc, latex-text-renderer.cc,
latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h,
lookup.cc, ls-ascii-helper.cc, ls-ascii-helper.h, ls-oct-text.cc, ls-utils.cc,
ls-utils.h, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex-private.h,
mex.cc, mgorth.cc, nproc.cc, oct-fstrm.cc, oct-fstrm.h, oct-hdf5-types.cc,
oct-hdf5-types.h, oct-hist.cc, oct-hist.h, oct-iostrm.cc, oct-iostrm.h,
oct-opengl.h, oct-prcstrm.cc, oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h,
oct-process.cc, oct-process.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h,
oct-strstrm.cc, oct-strstrm.h, oct-tex-lexer.in.ll, oct-tex-parser.yy,
ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc, pow2.cc, pr-flt-fmt.cc,
pr-output.cc, procstream.cc, procstream.h, psi.cc, qr.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, settings.cc, settings.h,
sighandlers.cc, sighandlers.h, sparse-xdiv.cc, sparse-xdiv.h, sparse-xpow.cc,
sparse-xpow.h, sparse.cc, spparms.cc, sqrtm.cc, stack-frame.cc, stack-frame.h,
stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc,
symbfact.cc, syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h,
symscope.cc, symscope.h, symtab.cc, symtab.h, syscalls.cc, sysdep.cc, sysdep.h,
text-engine.cc, text-engine.h, text-renderer.cc, text-renderer.h, time.cc,
toplev.cc, tril.cc, tsearch.cc, typecast.cc, url-handle-manager.cc,
url-handle-manager.h, urlwrite.cc, utils.cc, utils.h, variables.cc,
variables.h, xdiv.cc, xdiv.h, xnorm.cc, xnorm.h, xpow.cc, xpow.h,
__delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc,
audioread.cc, convhulln.cc, fftw.cc, gzip.cc, mk-build-env-features.sh,
mk-builtins.pl, cdef-class.cc, cdef-class.h, cdef-fwd.h, cdef-manager.cc,
cdef-manager.h, cdef-method.cc, cdef-method.h, cdef-object.cc, cdef-object.h,
cdef-package.cc, cdef-package.h, cdef-property.cc, cdef-property.h,
cdef-utils.cc, cdef-utils.h, ov-base.cc, ov-base.h, ov-bool-mat.cc,
ov-builtin.h, ov-cell.cc, ov-class.cc, ov-class.h, ov-classdef.cc,
ov-classdef.h, ov-complex.cc, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h,
ov-java.cc, ov-java.h, ov-mex-fcn.h, ov-null-mat.cc, ov-oncleanup.cc,
ov-struct.cc, ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h,
ov.cc, ov.h, octave.cc, octave.h, mk-ops.sh, op-b-b.cc, op-b-bm.cc,
op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc,
op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc,
op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc,
op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc,
op-dm-template.cc, op-dms-template.cc, op-fcdm-fcdm.cc, op-fcm-fcm.cc,
op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc, op-fcs-fcm.cc,
op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc, op-fm-fcm.cc,
op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc, op-fs-fcm.cc, op-fs-fcs.cc,
op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc, op-i32-i32.cc, op-i64-i64.cc,
op-i8-i8.cc, op-int-concat.cc, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc,
op-m-scm.cc, op-m-sm.cc, op-mi.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc,
op-pm-template.cc, op-range.cc, op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc,
op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc,
op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc,
op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc,
op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc,
op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc, ops.h,
anon-fcn-validator.cc, anon-fcn-validator.h, bp-table.cc, bp-table.h,
comment-list.cc, comment-list.h, filepos.h, lex.h, lex.ll, oct-lvalue.cc,
oct-lvalue.h, oct-parse.yy, parse.h, profiler.cc, profiler.h,
pt-anon-scopes.cc, pt-anon-scopes.h, pt-arg-list.cc, pt-arg-list.h,
pt-args-block.cc, pt-args-block.h, pt-array-list.cc, pt-array-list.h,
pt-assign.cc, pt-assign.h, pt-binop.cc, pt-binop.h, pt-bp.cc, pt-bp.h,
pt-cbinop.cc, pt-cbinop.h, pt-cell.cc, pt-cell.h, pt-check.cc, pt-check.h,
pt-classdef.cc, pt-classdef.h, pt-cmd.h, pt-colon.cc, pt-colon.h, pt-const.cc,
pt-const.h, pt-decl.cc, pt-decl.h, pt-eval.cc, pt-eval.h, pt-except.cc,
pt-except.h, pt-exp.cc, pt-exp.h, pt-fcn-handle.cc, pt-fcn-handle.h, pt-id.cc,
pt-id.h, pt-idx.cc, pt-idx.h, pt-jump.h, pt-loop.cc, pt-loop.h, pt-mat.cc,
pt-mat.h, pt-misc.cc, pt-misc.h, pt-pr-code.cc, pt-pr-code.h, pt-select.cc,
pt-select.h, pt-spmd.cc, pt-spmd.h, pt-stmt.cc, pt-stmt.h, pt-tm-const.cc,
pt-tm-const.h, pt-unop.cc, pt-unop.h, pt-vm-eval.cc, pt-walk.cc, pt-walk.h,
pt.cc, pt.h, token.cc, token.h, Range.cc, Range.h, idx-vector.cc, idx-vector.h,
range-fwd.h, CollocWt.cc, CollocWt.h, aepbalance.cc, aepbalance.h, chol.cc,
chol.h, gepbalance.cc, gepbalance.h, gsvd.cc, gsvd.h, hess.cc, hess.h,
lo-mappers.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, lu.cc, lu.h,
oct-convn.cc, oct-convn.h, oct-fftw.cc, oct-fftw.h, oct-norm.cc, oct-norm.h,
oct-rand.cc, oct-rand.h, oct-spparms.cc, oct-spparms.h, qr.cc, qr.h, qrp.cc,
qrp.h, randgamma.cc, randgamma.h, randmtzig.cc, randmtzig.h, randpoisson.cc,
randpoisson.h, schur.cc, schur.h, sparse-chol.cc, sparse-chol.h, sparse-lu.cc,
sparse-lu.h, sparse-qr.cc, sparse-qr.h, svd.cc, svd.h, child-list.cc,
child-list.h, dir-ops.cc, dir-ops.h, file-ops.cc, file-ops.h, file-stat.cc,
file-stat.h, lo-sysdep.cc, lo-sysdep.h, lo-sysinfo.cc, lo-sysinfo.h,
mach-info.cc, mach-info.h, oct-env.cc, oct-env.h, oct-group.cc, oct-group.h,
oct-password.cc, oct-password.h, oct-syscalls.cc, oct-syscalls.h, oct-time.cc,
oct-time.h, oct-uname.cc, oct-uname.h, action-container.cc, action-container.h,
base-list.h, cmd-edit.cc, cmd-edit.h, cmd-hist.cc, cmd-hist.h, f77-fcn.h,
file-info.cc, file-info.h, lo-array-errwarn.cc, lo-array-errwarn.h, lo-hash.cc,
lo-hash.h, lo-ieee.h, lo-regexp.cc, lo-regexp.h, lo-utils.cc, lo-utils.h,
oct-base64.cc, oct-base64.h, oct-glob.cc, oct-glob.h, oct-inttypes.h,
oct-mutex.cc, oct-mutex.h, oct-refcount.h, oct-shlib.cc, oct-shlib.h,
oct-sparse.cc, oct-sparse.h, oct-string.h, octave-preserve-stream-state.h,
pathsearch.cc, pathsearch.h, quit.cc, quit.h, unwind-prot.cc, unwind-prot.h,
url-transfer.cc, url-transfer.h : Use new macros to begin/end C++ namespaces.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 01 Dec 2022 14:23:45 -0800 |
parents | 68ec7f275f0e |
children | aac27ad79be6 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2001-2022 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // This file is part of Octave. // // Octave is free software: you can redistribute it and/or modify it // under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Octave is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Octave; see the file COPYING. If not, see // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if defined (HAVE_CONFIG_H) # include "config.h" #endif #if defined (HAVE_FFTW3_H) # include <fftw3.h> #endif #include "lo-error.h" #include "oct-fftw.h" #include "oct-locbuf.h" #include "quit.h" #include "singleton-cleanup.h" #if defined (HAVE_FFTW3_THREADS) || defined (HAVE_FFTW3F_THREADS) # include "nproc-wrapper.h" #endif OCTAVE_BEGIN_NAMESPACE(octave) #if defined (HAVE_FFTW) fftw_planner *fftw_planner::s_instance = nullptr; // Helper class to create and cache FFTW plans for both 1D and // 2D. This implementation defaults to using FFTW_ESTIMATE to create // the plans, which in theory is suboptimal, but provides quite // reasonable performance in practice. // Also note that if FFTW_ESTIMATE is not used then the planner in FFTW3 // will destroy the input and output arrays. We must, therefore, create a // temporary input array with the same size and 16-byte alignment as // the original array when using a different planner strategy. // Note that we also use any wisdom that is available, either in a // FFTW3 system wide file or as supplied by the user. // FIXME: if we can ensure 16 byte alignment in Array<T> // (<T> *data) the FFTW3 can use SIMD instructions for further // acceleration. // Note that it is profitable to store the FFTW3 plans, for small FFTs. fftw_planner::fftw_planner (void) : m_meth (ESTIMATE), m_rplan (nullptr), m_rd (0), m_rs (0), m_rr (0), m_rh (0), m_rn (), m_rsimd_align (false), m_nthreads (1) { m_plan[0] = m_plan[1] = nullptr; m_d[0] = m_d[1] = m_s[0] = m_s[1] = m_r[0] = m_r[1] = m_h[0] = m_h[1] = 0; m_simd_align[0] = m_simd_align[1] = false; m_inplace[0] = m_inplace[1] = false; m_n[0] = m_n[1] = dim_vector (); #if defined (HAVE_FFTW3_THREADS) int init_ret = fftw_init_threads (); if (! init_ret) (*current_liboctave_error_handler) ("Error initializing FFTW threads"); // Check number of processors available to the current process m_nthreads = octave_num_processors_wrapper (OCTAVE_NPROC_CURRENT_OVERRIDABLE); // Limit number of threads to 3 by default // See: https://octave.discourse.group/t/3121 // This can be later changed with fftw ("threads", nthreads). if (m_nthreads > 3) m_nthreads = 3; fftw_plan_with_nthreads (m_nthreads); #endif // If we have a system wide wisdom file, import it. fftw_import_system_wisdom (); } fftw_planner::~fftw_planner (void) { fftw_plan *plan_p; plan_p = reinterpret_cast<fftw_plan *> (&m_rplan); if (*plan_p) fftw_destroy_plan (*plan_p); plan_p = reinterpret_cast<fftw_plan *> (&m_plan[0]); if (*plan_p) fftw_destroy_plan (*plan_p); plan_p = reinterpret_cast<fftw_plan *> (&m_plan[1]); if (*plan_p) fftw_destroy_plan (*plan_p); } bool fftw_planner::instance_ok (void) { bool retval = true; if (! s_instance) { s_instance = new fftw_planner (); singleton_cleanup_list::add (cleanup_instance); } return retval; } void fftw_planner::threads (int nt) { #if defined (HAVE_FFTW3_THREADS) if (instance_ok () && nt != threads ()) { s_instance->m_nthreads = nt; fftw_plan_with_nthreads (nt); // Clear the current plans. s_instance->m_rplan = nullptr; s_instance->m_plan[0] = s_instance->m_plan[1] = nullptr; } #else octave_unused_parameter (nt); (*current_liboctave_warning_handler) ("unable to change number of threads without FFTW thread support"); #endif } #define CHECK_SIMD_ALIGNMENT(x) \ (((reinterpret_cast<std::ptrdiff_t> (x)) & 0xF) == 0) void * fftw_planner::do_create_plan (int dir, const int rank, const dim_vector& dims, octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, const Complex *in, Complex *out) { int which = (dir == FFTW_FORWARD) ? 0 : 1; fftw_plan *cur_plan_p = reinterpret_cast<fftw_plan *> (&m_plan[which]); bool create_new_plan = false; bool ioalign = CHECK_SIMD_ALIGNMENT (in) && CHECK_SIMD_ALIGNMENT (out); bool ioinplace = (in == out); // Don't create a new plan if we have a non SIMD plan already but // can do SIMD. This prevents endlessly recreating plans if we // change the alignment. if (m_plan[which] == nullptr || m_d[which] != dist || m_s[which] != stride || m_r[which] != rank || m_h[which] != howmany || ioinplace != m_inplace[which] || ((ioalign != m_simd_align[which]) ? ! ioalign : false)) create_new_plan = true; else { // We still might not have the same shape of array. for (int i = 0; i < rank; i++) if (dims(i) != m_n[which](i)) { create_new_plan = true; break; } } if (create_new_plan) { m_d[which] = dist; m_s[which] = stride; m_r[which] = rank; m_h[which] = howmany; m_simd_align[which] = ioalign; m_inplace[which] = ioinplace; m_n[which] = dims; // Note reversal of dimensions for column major storage in FFTW. octave_idx_type nn = 1; OCTAVE_LOCAL_BUFFER (int, tmp, rank); for (int i = 0, j = rank-1; i < rank; i++, j--) { tmp[i] = dims(j); nn *= dims(j); } int plan_flags = 0; bool plan_destroys_in = true; switch (m_meth) { case UNKNOWN: case ESTIMATE: plan_flags |= FFTW_ESTIMATE; plan_destroys_in = false; break; case MEASURE: plan_flags |= FFTW_MEASURE; break; case PATIENT: plan_flags |= FFTW_PATIENT; break; case EXHAUSTIVE: plan_flags |= FFTW_EXHAUSTIVE; break; case HYBRID: if (nn < 8193) plan_flags |= FFTW_MEASURE; else { plan_flags |= FFTW_ESTIMATE; plan_destroys_in = false; } break; } if (ioalign) plan_flags &= ~FFTW_UNALIGNED; else plan_flags |= FFTW_UNALIGNED; if (*cur_plan_p) fftw_destroy_plan (*cur_plan_p); if (plan_destroys_in) { // Create matrix with the same size and 16-byte alignment as input OCTAVE_LOCAL_BUFFER (Complex, itmp, nn * howmany + 32); itmp = reinterpret_cast<Complex *> (((reinterpret_cast<std::ptrdiff_t> (itmp) + 15) & ~ 0xF) + ((reinterpret_cast<std::ptrdiff_t> (in)) & 0xF)); *cur_plan_p = fftw_plan_many_dft (rank, tmp, howmany, reinterpret_cast<fftw_complex *> (itmp), nullptr, stride, dist, reinterpret_cast<fftw_complex *> (out), nullptr, stride, dist, dir, plan_flags); } else { *cur_plan_p = fftw_plan_many_dft (rank, tmp, howmany, reinterpret_cast<fftw_complex *> (const_cast<Complex *> (in)), nullptr, stride, dist, reinterpret_cast<fftw_complex *> (out), nullptr, stride, dist, dir, plan_flags); } if (*cur_plan_p == nullptr) (*current_liboctave_error_handler) ("Error creating FFTW plan"); } return *cur_plan_p; } void * fftw_planner::do_create_plan (const int rank, const dim_vector& dims, octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, const double *in, Complex *out) { fftw_plan *cur_plan_p = reinterpret_cast<fftw_plan *> (&m_rplan); bool create_new_plan = false; bool ioalign = CHECK_SIMD_ALIGNMENT (in) && CHECK_SIMD_ALIGNMENT (out); // Don't create a new plan if we have a non SIMD plan already but // can do SIMD. This prevents endlessly recreating plans if we // change the alignment. if (m_rplan == nullptr || m_rd != dist || m_rs != stride || m_rr != rank || m_rh != howmany || ((ioalign != m_rsimd_align) ? ! ioalign : false)) create_new_plan = true; else { // We still might not have the same shape of array. for (int i = 0; i < rank; i++) if (dims(i) != m_rn(i)) { create_new_plan = true; break; } } if (create_new_plan) { m_rd = dist; m_rs = stride; m_rr = rank; m_rh = howmany; m_rsimd_align = ioalign; m_rn = dims; // Note reversal of dimensions for column major storage in FFTW. octave_idx_type nn = 1; OCTAVE_LOCAL_BUFFER (int, tmp, rank); for (int i = 0, j = rank-1; i < rank; i++, j--) { tmp[i] = dims(j); nn *= dims(j); } int plan_flags = 0; bool plan_destroys_in = true; switch (m_meth) { case UNKNOWN: case ESTIMATE: plan_flags |= FFTW_ESTIMATE; plan_destroys_in = false; break; case MEASURE: plan_flags |= FFTW_MEASURE; break; case PATIENT: plan_flags |= FFTW_PATIENT; break; case EXHAUSTIVE: plan_flags |= FFTW_EXHAUSTIVE; break; case HYBRID: if (nn < 8193) plan_flags |= FFTW_MEASURE; else { plan_flags |= FFTW_ESTIMATE; plan_destroys_in = false; } break; } if (ioalign) plan_flags &= ~FFTW_UNALIGNED; else plan_flags |= FFTW_UNALIGNED; if (*cur_plan_p) fftw_destroy_plan (*cur_plan_p); if (plan_destroys_in) { // Create matrix with the same size and 16-byte alignment as input OCTAVE_LOCAL_BUFFER (double, itmp, nn + 32); itmp = reinterpret_cast<double *> (((reinterpret_cast<std::ptrdiff_t> (itmp) + 15) & ~ 0xF) + ((reinterpret_cast<std::ptrdiff_t> (in)) & 0xF)); *cur_plan_p = fftw_plan_many_dft_r2c (rank, tmp, howmany, itmp, nullptr, stride, dist, reinterpret_cast<fftw_complex *> (out), nullptr, stride, dist, plan_flags); } else { *cur_plan_p = fftw_plan_many_dft_r2c (rank, tmp, howmany, (const_cast<double *> (in)), nullptr, stride, dist, reinterpret_cast<fftw_complex *> (out), nullptr, stride, dist, plan_flags); } if (*cur_plan_p == nullptr) (*current_liboctave_error_handler) ("Error creating FFTW plan"); } return *cur_plan_p; } fftw_planner::FftwMethod fftw_planner::do_method (void) { return m_meth; } fftw_planner::FftwMethod fftw_planner::do_method (FftwMethod _meth) { FftwMethod ret = m_meth; if (_meth == ESTIMATE || _meth == MEASURE || _meth == PATIENT || _meth == EXHAUSTIVE || _meth == HYBRID) { if (m_meth != _meth) { m_meth = _meth; if (m_rplan) fftw_destroy_plan (reinterpret_cast<fftw_plan> (m_rplan)); if (m_plan[0]) fftw_destroy_plan (reinterpret_cast<fftw_plan> (m_plan[0])); if (m_plan[1]) fftw_destroy_plan (reinterpret_cast<fftw_plan> (m_plan[1])); m_rplan = m_plan[0] = m_plan[1] = nullptr; } } else ret = UNKNOWN; return ret; } float_fftw_planner *float_fftw_planner::s_instance = nullptr; float_fftw_planner::float_fftw_planner (void) : m_meth (ESTIMATE), m_rplan (nullptr), m_rd (0), m_rs (0), m_rr (0), m_rh (0), m_rn (), m_rsimd_align (false), m_nthreads (1) { m_plan[0] = m_plan[1] = nullptr; m_d[0] = m_d[1] = m_s[0] = m_s[1] = m_r[0] = m_r[1] = m_h[0] = m_h[1] = 0; m_simd_align[0] = m_simd_align[1] = false; m_inplace[0] = m_inplace[1] = false; m_n[0] = m_n[1] = dim_vector (); #if defined (HAVE_FFTW3F_THREADS) int init_ret = fftwf_init_threads (); if (! init_ret) (*current_liboctave_error_handler) ("Error initializing FFTW3F threads"); // Use number of processors available to the current process // This can be later changed with fftw ("threads", nthreads). m_nthreads = octave_num_processors_wrapper (OCTAVE_NPROC_CURRENT_OVERRIDABLE); fftwf_plan_with_nthreads (m_nthreads); #endif // If we have a system wide wisdom file, import it. fftwf_import_system_wisdom (); } float_fftw_planner::~float_fftw_planner (void) { fftwf_plan *plan_p; plan_p = reinterpret_cast<fftwf_plan *> (&m_rplan); if (*plan_p) fftwf_destroy_plan (*plan_p); plan_p = reinterpret_cast<fftwf_plan *> (&m_plan[0]); if (*plan_p) fftwf_destroy_plan (*plan_p); plan_p = reinterpret_cast<fftwf_plan *> (&m_plan[1]); if (*plan_p) fftwf_destroy_plan (*plan_p); } bool float_fftw_planner::instance_ok (void) { bool retval = true; if (! s_instance) { s_instance = new float_fftw_planner (); singleton_cleanup_list::add (cleanup_instance); } return retval; } void float_fftw_planner::threads (int nt) { #if defined (HAVE_FFTW3F_THREADS) if (instance_ok () && nt != threads ()) { s_instance->m_nthreads = nt; fftwf_plan_with_nthreads (nt); // Clear the current plans. s_instance->m_rplan = nullptr; s_instance->m_plan[0] = s_instance->m_plan[1] = nullptr; } #else octave_unused_parameter (nt); (*current_liboctave_warning_handler) ("unable to change number of threads without FFTW thread support"); #endif } void * float_fftw_planner::do_create_plan (int dir, const int rank, const dim_vector& dims, octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, const FloatComplex *in, FloatComplex *out) { int which = (dir == FFTW_FORWARD) ? 0 : 1; fftwf_plan *cur_plan_p = reinterpret_cast<fftwf_plan *> (&m_plan[which]); bool create_new_plan = false; bool ioalign = CHECK_SIMD_ALIGNMENT (in) && CHECK_SIMD_ALIGNMENT (out); bool ioinplace = (in == out); // Don't create a new plan if we have a non SIMD plan already but // can do SIMD. This prevents endlessly recreating plans if we // change the alignment. if (m_plan[which] == nullptr || m_d[which] != dist || m_s[which] != stride || m_r[which] != rank || m_h[which] != howmany || ioinplace != m_inplace[which] || ((ioalign != m_simd_align[which]) ? ! ioalign : false)) create_new_plan = true; else { // We still might not have the same shape of array. for (int i = 0; i < rank; i++) if (dims(i) != m_n[which](i)) { create_new_plan = true; break; } } if (create_new_plan) { m_d[which] = dist; m_s[which] = stride; m_r[which] = rank; m_h[which] = howmany; m_simd_align[which] = ioalign; m_inplace[which] = ioinplace; m_n[which] = dims; // Note reversal of dimensions for column major storage in FFTW. octave_idx_type nn = 1; OCTAVE_LOCAL_BUFFER (int, tmp, rank); for (int i = 0, j = rank-1; i < rank; i++, j--) { tmp[i] = dims(j); nn *= dims(j); } int plan_flags = 0; bool plan_destroys_in = true; switch (m_meth) { case UNKNOWN: case ESTIMATE: plan_flags |= FFTW_ESTIMATE; plan_destroys_in = false; break; case MEASURE: plan_flags |= FFTW_MEASURE; break; case PATIENT: plan_flags |= FFTW_PATIENT; break; case EXHAUSTIVE: plan_flags |= FFTW_EXHAUSTIVE; break; case HYBRID: if (nn < 8193) plan_flags |= FFTW_MEASURE; else { plan_flags |= FFTW_ESTIMATE; plan_destroys_in = false; } break; } if (ioalign) plan_flags &= ~FFTW_UNALIGNED; else plan_flags |= FFTW_UNALIGNED; if (*cur_plan_p) fftwf_destroy_plan (*cur_plan_p); if (plan_destroys_in) { // Create matrix with the same size and 16-byte alignment as input OCTAVE_LOCAL_BUFFER (FloatComplex, itmp, nn * howmany + 32); itmp = reinterpret_cast<FloatComplex *> (((reinterpret_cast<std::ptrdiff_t> (itmp) + 15) & ~ 0xF) + ((reinterpret_cast<std::ptrdiff_t> (in)) & 0xF)); *cur_plan_p = fftwf_plan_many_dft (rank, tmp, howmany, reinterpret_cast<fftwf_complex *> (itmp), nullptr, stride, dist, reinterpret_cast<fftwf_complex *> (out), nullptr, stride, dist, dir, plan_flags); } else { *cur_plan_p = fftwf_plan_many_dft (rank, tmp, howmany, reinterpret_cast<fftwf_complex *> (const_cast<FloatComplex *> (in)), nullptr, stride, dist, reinterpret_cast<fftwf_complex *> (out), nullptr, stride, dist, dir, plan_flags); } if (*cur_plan_p == nullptr) (*current_liboctave_error_handler) ("Error creating FFTW plan"); } return *cur_plan_p; } void * float_fftw_planner::do_create_plan (const int rank, const dim_vector& dims, octave_idx_type howmany, octave_idx_type stride, octave_idx_type dist, const float *in, FloatComplex *out) { fftwf_plan *cur_plan_p = reinterpret_cast<fftwf_plan *> (&m_rplan); bool create_new_plan = false; bool ioalign = CHECK_SIMD_ALIGNMENT (in) && CHECK_SIMD_ALIGNMENT (out); // Don't create a new plan if we have a non SIMD plan already but // can do SIMD. This prevents endlessly recreating plans if we // change the alignment. if (m_rplan == nullptr || m_rd != dist || m_rs != stride || m_rr != rank || m_rh != howmany || ((ioalign != m_rsimd_align) ? ! ioalign : false)) create_new_plan = true; else { // We still might not have the same shape of array. for (int i = 0; i < rank; i++) if (dims(i) != m_rn(i)) { create_new_plan = true; break; } } if (create_new_plan) { m_rd = dist; m_rs = stride; m_rr = rank; m_rh = howmany; m_rsimd_align = ioalign; m_rn = dims; // Note reversal of dimensions for column major storage in FFTW. octave_idx_type nn = 1; OCTAVE_LOCAL_BUFFER (int, tmp, rank); for (int i = 0, j = rank-1; i < rank; i++, j--) { tmp[i] = dims(j); nn *= dims(j); } int plan_flags = 0; bool plan_destroys_in = true; switch (m_meth) { case UNKNOWN: case ESTIMATE: plan_flags |= FFTW_ESTIMATE; plan_destroys_in = false; break; case MEASURE: plan_flags |= FFTW_MEASURE; break; case PATIENT: plan_flags |= FFTW_PATIENT; break; case EXHAUSTIVE: plan_flags |= FFTW_EXHAUSTIVE; break; case HYBRID: if (nn < 8193) plan_flags |= FFTW_MEASURE; else { plan_flags |= FFTW_ESTIMATE; plan_destroys_in = false; } break; } if (ioalign) plan_flags &= ~FFTW_UNALIGNED; else plan_flags |= FFTW_UNALIGNED; if (*cur_plan_p) fftwf_destroy_plan (*cur_plan_p); if (plan_destroys_in) { // Create matrix with the same size and 16-byte alignment as input OCTAVE_LOCAL_BUFFER (float, itmp, nn + 32); itmp = reinterpret_cast<float *> (((reinterpret_cast<std::ptrdiff_t> (itmp) + 15) & ~ 0xF) + ((reinterpret_cast<std::ptrdiff_t> (in)) & 0xF)); *cur_plan_p = fftwf_plan_many_dft_r2c (rank, tmp, howmany, itmp, nullptr, stride, dist, reinterpret_cast<fftwf_complex *> (out), nullptr, stride, dist, plan_flags); } else { *cur_plan_p = fftwf_plan_many_dft_r2c (rank, tmp, howmany, (const_cast<float *> (in)), nullptr, stride, dist, reinterpret_cast<fftwf_complex *> (out), nullptr, stride, dist, plan_flags); } if (*cur_plan_p == nullptr) (*current_liboctave_error_handler) ("Error creating FFTW plan"); } return *cur_plan_p; } float_fftw_planner::FftwMethod float_fftw_planner::do_method (void) { return m_meth; } float_fftw_planner::FftwMethod float_fftw_planner::do_method (FftwMethod _meth) { FftwMethod ret = m_meth; if (_meth == ESTIMATE || _meth == MEASURE || _meth == PATIENT || _meth == EXHAUSTIVE || _meth == HYBRID) { if (m_meth != _meth) { m_meth = _meth; if (m_rplan) fftwf_destroy_plan (reinterpret_cast<fftwf_plan> (m_rplan)); if (m_plan[0]) fftwf_destroy_plan (reinterpret_cast<fftwf_plan> (m_plan[0])); if (m_plan[1]) fftwf_destroy_plan (reinterpret_cast<fftwf_plan> (m_plan[1])); m_rplan = m_plan[0] = m_plan[1] = nullptr; } } else ret = UNKNOWN; return ret; } template <typename T> static inline void convert_packcomplex_1d (T *out, std::size_t nr, std::size_t nc, octave_idx_type stride, octave_idx_type dist) { octave_quit (); // Fill in the missing data. for (std::size_t i = 0; i < nr; i++) for (std::size_t j = nc/2+1; j < nc; j++) out[j*stride + i*dist] = conj (out[(nc - j)*stride + i*dist]); octave_quit (); } template <typename T> static inline void convert_packcomplex_Nd (T *out, const dim_vector& dv) { std::size_t nc = dv(0); std::size_t nr = dv(1); std::size_t np = (dv.ndims () > 2 ? dv.numel () / nc / nr : 1); std::size_t nrp = nr * np; T *ptr1, *ptr2; octave_quit (); // Create space for the missing elements. for (std::size_t i = 0; i < nrp; i++) { ptr1 = out + i * (nc/2 + 1) + nrp*((nc-1)/2); ptr2 = out + i * nc; for (std::size_t j = 0; j < nc/2+1; j++) *ptr2++ = *ptr1++; } octave_quit (); // Fill in the missing data for the rank = 2 case directly for speed. for (std::size_t i = 0; i < np; i++) { for (std::size_t j = 1; j < nr; j++) for (std::size_t k = nc/2+1; k < nc; k++) out[k + (j + i*nr)*nc] = conj (out[nc - k + ((i+1)*nr - j)*nc]); for (std::size_t j = nc/2+1; j < nc; j++) out[j + i*nr*nc] = conj (out[(i*nr+1)*nc - j]); } octave_quit (); // Now do the permutations needed for rank > 2 cases. std::size_t jstart = dv(0) * dv(1); std::size_t kstep = dv(0); std::size_t nel = dv.numel (); for (int inner = 2; inner < dv.ndims (); inner++) { std::size_t jmax = jstart * dv(inner); for (std::size_t i = 0; i < nel; i+=jmax) for (std::size_t j = jstart, jj = jmax-jstart; j < jj; j+=jstart, jj-=jstart) for (std::size_t k = 0; k < jstart; k+= kstep) for (std::size_t l = nc/2+1; l < nc; l++) { T tmp = out[i+ j + k + l]; out[i + j + k + l] = out[i + jj + k + l]; out[i + jj + k + l] = tmp; } jstart = jmax; } octave_quit (); } int fftw::fft (const double *in, Complex *out, std::size_t npts, std::size_t nsamples, octave_idx_type stride, octave_idx_type dist) { dist = (dist < 0 ? npts : dist); dim_vector dv (npts, 1); void *vplan = fftw_planner::create_plan (1, dv, nsamples, stride, dist, in, out); fftw_plan m_plan = reinterpret_cast<fftw_plan> (vplan); fftw_execute_dft_r2c (m_plan, (const_cast<double *>(in)), reinterpret_cast<fftw_complex *> (out)); // Need to create other half of the transform. convert_packcomplex_1d (out, nsamples, npts, stride, dist); return 0; } int fftw::fft (const Complex *in, Complex *out, std::size_t npts, std::size_t nsamples, octave_idx_type stride, octave_idx_type dist) { dist = (dist < 0 ? npts : dist); dim_vector dv (npts, 1); void *vplan = fftw_planner::create_plan (FFTW_FORWARD, 1, dv, nsamples, stride, dist, in, out); fftw_plan m_plan = reinterpret_cast<fftw_plan> (vplan); fftw_execute_dft (m_plan, reinterpret_cast<fftw_complex *> (const_cast<Complex *>(in)), reinterpret_cast<fftw_complex *> (out)); return 0; } int fftw::ifft (const Complex *in, Complex *out, std::size_t npts, std::size_t nsamples, octave_idx_type stride, octave_idx_type dist) { dist = (dist < 0 ? npts : dist); dim_vector dv (npts, 1); void *vplan = fftw_planner::create_plan (FFTW_BACKWARD, 1, dv, nsamples, stride, dist, in, out); fftw_plan m_plan = reinterpret_cast<fftw_plan> (vplan); fftw_execute_dft (m_plan, reinterpret_cast<fftw_complex *> (const_cast<Complex *>(in)), reinterpret_cast<fftw_complex *> (out)); const Complex scale = npts; for (std::size_t j = 0; j < nsamples; j++) for (std::size_t i = 0; i < npts; i++) out[i*stride + j*dist] /= scale; return 0; } int fftw::fftNd (const double *in, Complex *out, const int rank, const dim_vector& dv) { octave_idx_type dist = 1; for (int i = 0; i < rank; i++) dist *= dv(i); // Fool with the position of the start of the output matrix, so that // creating other half of the matrix won't cause cache problems. octave_idx_type offset = (dv.numel () / dv(0)) * ((dv(0) - 1) / 2); void *vplan = fftw_planner::create_plan (rank, dv, 1, 1, dist, in, out + offset); fftw_plan m_plan = reinterpret_cast<fftw_plan> (vplan); fftw_execute_dft_r2c (m_plan, (const_cast<double *>(in)), reinterpret_cast<fftw_complex *> (out+ offset)); // Need to create other half of the transform. convert_packcomplex_Nd (out, dv); return 0; } int fftw::fftNd (const Complex *in, Complex *out, const int rank, const dim_vector& dv) { octave_idx_type dist = 1; for (int i = 0; i < rank; i++) dist *= dv(i); void *vplan = fftw_planner::create_plan (FFTW_FORWARD, rank, dv, 1, 1, dist, in, out); fftw_plan m_plan = reinterpret_cast<fftw_plan> (vplan); fftw_execute_dft (m_plan, reinterpret_cast<fftw_complex *> (const_cast<Complex *>(in)), reinterpret_cast<fftw_complex *> (out)); return 0; } int fftw::ifftNd (const Complex *in, Complex *out, const int rank, const dim_vector& dv) { octave_idx_type dist = 1; for (int i = 0; i < rank; i++) dist *= dv(i); void *vplan = fftw_planner::create_plan (FFTW_BACKWARD, rank, dv, 1, 1, dist, in, out); fftw_plan m_plan = reinterpret_cast<fftw_plan> (vplan); fftw_execute_dft (m_plan, reinterpret_cast<fftw_complex *> (const_cast<Complex *>(in)), reinterpret_cast<fftw_complex *> (out)); const std::size_t npts = dv.numel (); const Complex scale = npts; for (std::size_t i = 0; i < npts; i++) out[i] /= scale; return 0; } int fftw::fft (const float *in, FloatComplex *out, std::size_t npts, std::size_t nsamples, octave_idx_type stride, octave_idx_type dist) { dist = (dist < 0 ? npts : dist); dim_vector dv (npts, 1); void *vplan = float_fftw_planner::create_plan (1, dv, nsamples, stride, dist, in, out); fftwf_plan m_plan = reinterpret_cast<fftwf_plan> (vplan); fftwf_execute_dft_r2c (m_plan, (const_cast<float *>(in)), reinterpret_cast<fftwf_complex *> (out)); // Need to create other half of the transform. convert_packcomplex_1d (out, nsamples, npts, stride, dist); return 0; } int fftw::fft (const FloatComplex *in, FloatComplex *out, std::size_t npts, std::size_t nsamples, octave_idx_type stride, octave_idx_type dist) { dist = (dist < 0 ? npts : dist); dim_vector dv (npts, 1); void *vplan = float_fftw_planner::create_plan (FFTW_FORWARD, 1, dv, nsamples, stride, dist, in, out); fftwf_plan m_plan = reinterpret_cast<fftwf_plan> (vplan); fftwf_execute_dft (m_plan, reinterpret_cast<fftwf_complex *> (const_cast<FloatComplex *>(in)), reinterpret_cast<fftwf_complex *> (out)); return 0; } int fftw::ifft (const FloatComplex *in, FloatComplex *out, std::size_t npts, std::size_t nsamples, octave_idx_type stride, octave_idx_type dist) { dist = (dist < 0 ? npts : dist); dim_vector dv (npts, 1); void *vplan = float_fftw_planner::create_plan (FFTW_BACKWARD, 1, dv, nsamples, stride, dist, in, out); fftwf_plan m_plan = reinterpret_cast<fftwf_plan> (vplan); fftwf_execute_dft (m_plan, reinterpret_cast<fftwf_complex *> (const_cast<FloatComplex *>(in)), reinterpret_cast<fftwf_complex *> (out)); const FloatComplex scale = npts; for (std::size_t j = 0; j < nsamples; j++) for (std::size_t i = 0; i < npts; i++) out[i*stride + j*dist] /= scale; return 0; } int fftw::fftNd (const float *in, FloatComplex *out, const int rank, const dim_vector& dv) { octave_idx_type dist = 1; for (int i = 0; i < rank; i++) dist *= dv(i); // Fool with the position of the start of the output matrix, so that // creating other half of the matrix won't cause cache problems. octave_idx_type offset = (dv.numel () / dv(0)) * ((dv(0) - 1) / 2); void *vplan = float_fftw_planner::create_plan (rank, dv, 1, 1, dist, in, out + offset); fftwf_plan m_plan = reinterpret_cast<fftwf_plan> (vplan); fftwf_execute_dft_r2c (m_plan, (const_cast<float *>(in)), reinterpret_cast<fftwf_complex *> (out+ offset)); // Need to create other half of the transform. convert_packcomplex_Nd (out, dv); return 0; } int fftw::fftNd (const FloatComplex *in, FloatComplex *out, const int rank, const dim_vector& dv) { octave_idx_type dist = 1; for (int i = 0; i < rank; i++) dist *= dv(i); void *vplan = float_fftw_planner::create_plan (FFTW_FORWARD, rank, dv, 1, 1, dist, in, out); fftwf_plan m_plan = reinterpret_cast<fftwf_plan> (vplan); fftwf_execute_dft (m_plan, reinterpret_cast<fftwf_complex *> (const_cast<FloatComplex *>(in)), reinterpret_cast<fftwf_complex *> (out)); return 0; } int fftw::ifftNd (const FloatComplex *in, FloatComplex *out, const int rank, const dim_vector& dv) { octave_idx_type dist = 1; for (int i = 0; i < rank; i++) dist *= dv(i); void *vplan = float_fftw_planner::create_plan (FFTW_BACKWARD, rank, dv, 1, 1, dist, in, out); fftwf_plan m_plan = reinterpret_cast<fftwf_plan> (vplan); fftwf_execute_dft (m_plan, reinterpret_cast<fftwf_complex *> (const_cast<FloatComplex *>(in)), reinterpret_cast<fftwf_complex *> (out)); const std::size_t npts = dv.numel (); const FloatComplex scale = npts; for (std::size_t i = 0; i < npts; i++) out[i] /= scale; return 0; } #endif std::string fftw_version (void) { #if defined (HAVE_FFTW) return ::fftw_version; #else return "none"; #endif } std::string fftwf_version (void) { #if defined (HAVE_FFTW) return ::fftwf_version; #else return "none"; #endif } OCTAVE_END_NAMESPACE(octave)