octave: liboctave/numeric/oct-fftw.h annotate

annotate liboctave/numeric/oct-fftw.h @ 27923:bd51beb6205e

update formatting of copyright notices * Use <https://octave.org/copyright/> instead of <https://octave.org/COPYRIGHT.html/>. * For consistency with other comments in the Octave sources, use C++-style comments for copyright blocks in C and C++ files. * Use delimiters above and below copyright blocks that are appropriate for the language used in the file. * Eliminate extra spacing inside copyright blocks. * lex.ll (looks_like_copyright): Also allow newlines and carriage returns before the word "Copyright". * scripts/mk-doc.pl (gethelp): Also skip empty comment lines. * bp-table.cc, type.m: Adjust tests.

author	John W. Eaton <jwe@octave.org>
date	Wed, 08 Jan 2020 11:59:41 -0500
parents	1891570abac8
children	0a5b15007766

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	3 // Copyright (C) 2001-2020 The Octave Project Developers
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
3828 adc217ebe692 [project @ 2001-05-02 14:50:46 by jwe] jwe parents: diff changeset	25
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	26 #if ! defined (octave_oct_fftw_h)
3828 adc217ebe692 [project @ 2001-05-02 14:50:46 by jwe] jwe parents: diff changeset	27 #define octave_oct_fftw_h 1
adc217ebe692 [project @ 2001-05-02 14:50:46 by jwe] jwe parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21202 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21202 diff changeset	30
3828 adc217ebe692 [project @ 2001-05-02 14:50:46 by jwe] jwe parents: diff changeset	31 #include <cstddef>
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	32
23475 d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23440 diff changeset	33 #include <string>
d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23440 diff changeset	34
d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23440 diff changeset	35 #include "dim-vector.h"
3828 adc217ebe692 [project @ 2001-05-02 14:50:46 by jwe] jwe parents: diff changeset	36 #include "oct-cmplx.h"
adc217ebe692 [project @ 2001-05-02 14:50:46 by jwe] jwe parents: diff changeset	37
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	38 namespace octave
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	39 {
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	40 class
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	41 OCTAVE_API
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	42 fftw_planner
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	43 {
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	44 protected:
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	45
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	46 fftw_planner (void);
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	47
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	48 public:
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	49
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	50 // No copying!
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	51
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	52 fftw_planner (const fftw_planner&) = delete;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	53
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	54 fftw_planner& operator = (const fftw_planner&) = delete;
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	55
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	56 ~fftw_planner (void);
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	57
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	58 enum FftwMethod
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	59 {
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	60 UNKNOWN = -1,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	61 ESTIMATE,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	62 MEASURE,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	63 PATIENT,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	64 EXHAUSTIVE,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	65 HYBRID
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	66 };
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	67
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	68 static bool instance_ok (void);
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	69
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	70 static void *
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	71 create_plan (int dir, const int rank, const dim_vector& dims,
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	72 octave_idx_type howmany, octave_idx_type stride,
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	73 octave_idx_type dist, const Complex *in,
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	74 Complex *out)
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	75 {
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	76 return instance_ok ()
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	77 ? instance->do_create_plan (dir, rank, dims, howmany, stride,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	78 dist, in, out)
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23615 diff changeset	79 : nullptr;
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	80 }
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	81
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	82 static void *
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	83 create_plan (const int rank, const dim_vector& dims,
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	84 octave_idx_type howmany, octave_idx_type stride,
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	85 octave_idx_type dist, const double in, Complex out)
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	86 {
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	87 return instance_ok ()
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	88 ? instance->do_create_plan (rank, dims, howmany, stride, dist,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	89 in, out)
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23615 diff changeset	90 : nullptr;
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	91 }
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	92
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	93 static FftwMethod method (void)
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	94 {
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	95 static FftwMethod dummy;
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	96
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	97 return instance_ok () ? instance->do_method () : dummy;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	98 }
12122 f4689107dd8c Explicitly disallow copying in some classes. Pascal Dupuis <Pascal.Dupuis@uclouvain.be> parents: 11586 diff changeset	99
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	100 static FftwMethod method (FftwMethod _meth)
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	101 {
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	102 static FftwMethod dummy;
12122 f4689107dd8c Explicitly disallow copying in some classes. Pascal Dupuis <Pascal.Dupuis@uclouvain.be> parents: 11586 diff changeset	103
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	104 return instance_ok () ? instance->do_method (_meth) : dummy;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	105 }
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	106
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	107 static void threads (int nt);
13983 7dd7cccf0757 clean up memory allocated for singletons before exit John W. Eaton <jwe@octave.org> parents: 12122 diff changeset	108
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	109 static int threads (void)
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	110 {
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	111 return instance_ok () ? instance->nthreads : 0;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	112 }
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	113
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	114 private:
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	115
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	116 static fftw_planner *instance;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	117
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23615 diff changeset	118 static void cleanup_instance (void) { delete instance; instance = nullptr; }
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	119
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	120 void *
23440 f15f0d8b78c8 pass dim_vector as const reference, not by value John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	121 do_create_plan (int dir, const int rank, const dim_vector& dims,
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	122 octave_idx_type howmany, octave_idx_type stride,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	123 octave_idx_type dist, const Complex *in,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	124 Complex *out);
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	125
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	126 void *
23440 f15f0d8b78c8 pass dim_vector as const reference, not by value John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	127 do_create_plan (const int rank, const dim_vector& dims,
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	128 octave_idx_type howmany, octave_idx_type stride,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	129 octave_idx_type dist, const double in, Complex out);
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	130
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	131 FftwMethod do_method (void);
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	132
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	133 FftwMethod do_method (FftwMethod _meth);
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	134
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	135 FftwMethod meth;
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	136
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	137 // FIXME: perhaps this should be split into two classes?
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	138
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	139 // Plan for fft and ifft of complex values
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	140 void *plan[2];
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	141
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	142 // dist
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	143 octave_idx_type d[2];
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	144
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	145 // stride
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	146 octave_idx_type s[2];
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	147
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	148 // rank
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	149 int r[2];
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	150
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	151 // howmany
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	152 octave_idx_type h[2];
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	153
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	154 // dims
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	155 dim_vector n[2];
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	156
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	157 bool simd_align[2];
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	158 bool inplace[2];
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	159
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	160 // Plan for fft of real values
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	161 void *rplan;
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	162
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	163 // dist
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	164 octave_idx_type rd;
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	165
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	166 // stride
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	167 octave_idx_type rs;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	168
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	169 // rank
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	170 int rr;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	171
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	172 // howmany
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	173 octave_idx_type rh;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	174
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	175 // dims
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	176 dim_vector rn;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	177
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	178 bool rsimd_align;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	179
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	180 // number of threads. Always 1 unless compiled with multi-threading
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	181 // support.
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	182 int nthreads;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	183 };
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	184
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	185 class
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	186 OCTAVE_API
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	187 float_fftw_planner
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	188 {
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	189 protected:
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	190
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	191 float_fftw_planner (void);
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	192
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	193 public:
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	194
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	195 // No copying!
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	196
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	197 float_fftw_planner (const float_fftw_planner&) = delete;
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	198
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	199 float_fftw_planner&
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	200 operator = (const float_fftw_planner&) = delete;
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	201
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	202 ~float_fftw_planner (void);
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	203
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	204 enum FftwMethod
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	205 {
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	206 UNKNOWN = -1,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	207 ESTIMATE,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	208 MEASURE,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	209 PATIENT,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	210 EXHAUSTIVE,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	211 HYBRID
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	212 };
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	213
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	214 static bool instance_ok (void);
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	215
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	216 static void *
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	217 create_plan (int dir, const int rank, const dim_vector& dims,
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	218 octave_idx_type howmany, octave_idx_type stride,
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	219 octave_idx_type dist, const FloatComplex *in,
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	220 FloatComplex *out)
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	221 {
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	222 return instance_ok ()
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	223 ? instance->do_create_plan (dir, rank, dims, howmany, stride,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	224 dist, in, out)
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23615 diff changeset	225 : nullptr;
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	226 }
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	227
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	228 static void *
25103 078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	229 create_plan (const int rank, const dim_vector& dims,
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	230 octave_idx_type howmany, octave_idx_type stride,
078b795c5219 maint: style check C++ ahead of 4.4 release. Rik <rik@octave.org> parents: 25054 diff changeset	231 octave_idx_type dist, const float in, FloatComplex out)
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	232 {
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	233 return instance_ok ()
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	234 ? instance->do_create_plan (rank, dims, howmany, stride, dist,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	235 in, out)
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23615 diff changeset	236 : nullptr;
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	237 }
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	238
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	239 static FftwMethod method (void)
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	240 {
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	241 static FftwMethod dummy;
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	242
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	243 return instance_ok () ? instance->do_method () : dummy;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	244 }
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	245
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	246 static FftwMethod method (FftwMethod _meth)
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	247 {
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	248 static FftwMethod dummy;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	249
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	250 return instance_ok () ? instance->do_method (_meth) : dummy;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	251 }
12122 f4689107dd8c Explicitly disallow copying in some classes. Pascal Dupuis <Pascal.Dupuis@uclouvain.be> parents: 11586 diff changeset	252
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	253 static void threads (int nt);
12122 f4689107dd8c Explicitly disallow copying in some classes. Pascal Dupuis <Pascal.Dupuis@uclouvain.be> parents: 11586 diff changeset	254
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	255 static int threads (void)
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	256 {
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	257 return instance_ok () ? instance->nthreads : 0;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	258 }
12122 f4689107dd8c Explicitly disallow copying in some classes. Pascal Dupuis <Pascal.Dupuis@uclouvain.be> parents: 11586 diff changeset	259
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	260 private:
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	261
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	262 static float_fftw_planner *instance;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	263
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23615 diff changeset	264 static void cleanup_instance (void) { delete instance; instance = nullptr; }
13994 99f039289e95 also clean up float fftw planner John W. Eaton <jwe@octave.org> parents: 13983 diff changeset	265
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	266 void *
23440 f15f0d8b78c8 pass dim_vector as const reference, not by value John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	267 do_create_plan (int dir, const int rank, const dim_vector& dims,
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	268 octave_idx_type howmany, octave_idx_type stride,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	269 octave_idx_type dist, const FloatComplex *in,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	270 FloatComplex *out);
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	271
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	272 void *
23440 f15f0d8b78c8 pass dim_vector as const reference, not by value John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	273 do_create_plan (const int rank, const dim_vector& dims,
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	274 octave_idx_type howmany, octave_idx_type stride,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	275 octave_idx_type dist, const float in, FloatComplex out);
6228 aa5df9ba98d5 [project @ 2007-01-05 22:49:03 by dbateman] dbateman parents: 5307 diff changeset	276
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	277 FftwMethod do_method (void);
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	278
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	279 FftwMethod do_method (FftwMethod _meth);
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	280
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	281 FftwMethod meth;
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	282
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	283 // FIXME: perhaps this should be split into two classes?
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	284
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	285 // Plan for fft and ifft of complex values
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	286 void *plan[2];
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	287
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	288 // dist
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	289 octave_idx_type d[2];
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	290
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	291 // stride
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	292 octave_idx_type s[2];
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	293
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	294 // rank
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	295 int r[2];
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	296
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	297 // howmany
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	298 octave_idx_type h[2];
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	299
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	300 // dims
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	301 dim_vector n[2];
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	302
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	303 bool simd_align[2];
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	304 bool inplace[2];
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	305
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	306 // Plan for fft of real values
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	307 void *rplan;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	308
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	309 // dist
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	310 octave_idx_type rd;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	311
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	312 // stride
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	313 octave_idx_type rs;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	314
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	315 // rank
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	316 int rr;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	317
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	318 // howmany
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	319 octave_idx_type rh;
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	320
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	321 // dims
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	322 dim_vector rn;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	323
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	324 bool rsimd_align;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	325
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	326 // number of threads. Always 1 unless compiled with multi-threading
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	327 // support.
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	328 int nthreads;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	329 };
82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	330
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	331 class
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	332 OCTAVE_API
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	333 fftw
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	334 {
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	335 public:
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	336
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	337 fftw (void) = delete;
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	338
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	339 // No copying.
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	340
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	341 fftw (const fftw&) = delete;
9516 fb933db0c517 convert fftw planner classes to singleton objects John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	342
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	343 fftw& operator = (const fftw&) = delete;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	344
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	345 static int fft (const double in, Complex out, size_t npts,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	346 size_t nsamples = 1, octave_idx_type stride = 1,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	347 octave_idx_type dist = -1);
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	348 static int fft (const Complex in, Complex out, size_t npts,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	349 size_t nsamples = 1, octave_idx_type stride = 1,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	350 octave_idx_type dist = -1);
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	351 static int ifft (const Complex in, Complex out, size_t npts,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	352 size_t nsamples = 1, octave_idx_type stride = 1,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	353 octave_idx_type dist = -1);
9523 0ce82753dd72 more configure changes for libraries John W. Eaton <jwe@octave.org> parents: 9516 diff changeset	354
23440 f15f0d8b78c8 pass dim_vector as const reference, not by value John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	355 static int fftNd (const double, Complex, const int, const dim_vector&);
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	356 static int fftNd (const Complex, Complex, const int,
23440 f15f0d8b78c8 pass dim_vector as const reference, not by value John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	357 const dim_vector&);
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	358 static int ifftNd (const Complex, Complex, const int,
23440 f15f0d8b78c8 pass dim_vector as const reference, not by value John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	359 const dim_vector&);
3828 adc217ebe692 [project @ 2001-05-02 14:50:46 by jwe] jwe parents: diff changeset	360
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	361 static int fft (const float in, FloatComplex out, size_t npts,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	362 size_t nsamples = 1, octave_idx_type stride = 1,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	363 octave_idx_type dist = -1);
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	364 static int fft (const FloatComplex in, FloatComplex out, size_t npts,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	365 size_t nsamples = 1, octave_idx_type stride = 1,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	366 octave_idx_type dist = -1);
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	367 static int ifft (const FloatComplex in, FloatComplex out, size_t npts,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	368 size_t nsamples = 1, octave_idx_type stride = 1,
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	369 octave_idx_type dist = -1);
3828 adc217ebe692 [project @ 2001-05-02 14:50:46 by jwe] jwe parents: diff changeset	370
23440 f15f0d8b78c8 pass dim_vector as const reference, not by value John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	371 static int fftNd (const float, FloatComplex, const int, const dim_vector&);
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	372 static int fftNd (const FloatComplex, FloatComplex, const int,
23440 f15f0d8b78c8 pass dim_vector as const reference, not by value John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	373 const dim_vector&);
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	374 static int ifftNd (const FloatComplex, FloatComplex, const int,
23440 f15f0d8b78c8 pass dim_vector as const reference, not by value John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	375 const dim_vector&);
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	376 };
15960 bde7731b2b83 added FFTW multithreaded library support Andreas Weber <andy.weber.aw@gmail.com> parents: 15818 diff changeset	377
23058 5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	378 extern OCTAVE_API std::string fftw_version (void);
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	379 extern OCTAVE_API std::string fftwf_version (void);
5839d16828cb move fftw classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	380 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7017 diff changeset	381
3828 adc217ebe692 [project @ 2001-05-02 14:50:46 by jwe] jwe parents: diff changeset	382 #endif

Mercurial > octave

annotate liboctave/numeric/oct-fftw.h @ 27923:bd51beb6205e