Mercurial > octave
view liboctave/numeric/oct-fftw.h @ 27918:b442ec6dda5c
use centralized file for copyright info for individual contributors
* COPYRIGHT.md: New file.
* In most other files, use "Copyright (C) YYYY-YYYY The Octave Project
Developers" instead of tracking individual names in separate source
files. The motivation is to reduce the effort required to update the
notices each year.
Until now, the Octave source files contained copyright notices that
list individual contributors. I adopted these file-scope copyright
notices because that is what everyone was doing 30 years ago in the
days before distributed version control systems. But now, with many
contributors and modern version control systems, having these
file-scope copyright notices causes trouble when we update copyright
years or refactor code.
Over time, the file-scope copyright notices may become outdated as new
contributions are made or code is moved from one file to
another. Sometimes people contribute significant patches but do not
add a line claiming copyright. Other times, people add a copyright
notice for their contribution but then a later refactoring moves part
or all of their contribution to another file and the notice is not
moved with the code. As a practical matter, moving such notices is
difficult -- determining what parts are due to a particular
contributor requires a time-consuming search through the project
history. Even managing the yearly update of copyright years is
problematic. We have some contributors who are no longer
living. Should we update the copyright dates for their contributions
when we release new versions? Probably not, but we do still want to
claim copyright for the project as a whole.
To minimize the difficulty of maintaining the copyright notices, I
would like to change Octave's sources to use what is described here:
https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html
in the section "Maintaining centralized copyright notices":
The centralized notice approach consolidates all copyright
notices in a single location, usually a top-level file.
This file should contain all of the copyright notices
provided project contributors, unless the contribution was
clearly insignificant. It may also credit -- without a copyright
notice -- anyone who helped with the project but did not
contribute code or other copyrighted material.
This approach captures less information about contributions
within individual files, recognizing that the DVCS is better
equipped to record those details. As we mentioned before, it
does have one disadvantage as compared to the file-scope
approach: if a single file is separated from the distribution,
the recipient won't see the contributors' copyright notices.
But this can be easily remedied by including a single
copyright notice in each file's header, pointing to the
top-level file:
Copyright YYYY-YYYY The Octave Project Developers
See the COPYRIGHT file at the top-level directory
of this distribution or at https://octave.org/COPYRIGHT.html.
followed by the usual GPL copyright statement.
For more background, see the discussion here:
https://lists.gnu.org/archive/html/octave-maintainers/2020-01/msg00009.html
Most files in the following directories have been skipped intentinally
in this changeset:
doc
libgui/qterminal
liboctave/external
m4
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 06 Jan 2020 15:38:17 -0500 |
parents | fff643eb3514 |
children | 1891570abac8 |
line wrap: on
line source
/* Copyright (C) 2001-2019 The Octave Project Developers See the file COPYRIGHT.md in the top-level directory of this distribution or <https://octave.org/COPYRIGHT.html/>. 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 (octave_oct_fftw_h) #define octave_oct_fftw_h 1 #include "octave-config.h" #include <cstddef> #include <string> #include "dim-vector.h" #include "oct-cmplx.h" namespace octave { class OCTAVE_API fftw_planner { protected: fftw_planner (void); public: // No copying! fftw_planner (const fftw_planner&) = delete; fftw_planner& operator = (const fftw_planner&) = delete; ~fftw_planner (void); enum FftwMethod { UNKNOWN = -1, ESTIMATE, MEASURE, PATIENT, EXHAUSTIVE, HYBRID }; static bool instance_ok (void); static void * 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) { return instance_ok () ? instance->do_create_plan (dir, rank, dims, howmany, stride, dist, in, out) : nullptr; } static void * 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) { return instance_ok () ? instance->do_create_plan (rank, dims, howmany, stride, dist, in, out) : nullptr; } static FftwMethod method (void) { static FftwMethod dummy; return instance_ok () ? instance->do_method () : dummy; } static FftwMethod method (FftwMethod _meth) { static FftwMethod dummy; return instance_ok () ? instance->do_method (_meth) : dummy; } static void threads (int nt); static int threads (void) { return instance_ok () ? instance->nthreads : 0; } private: static fftw_planner *instance; static void cleanup_instance (void) { delete instance; instance = nullptr; } void * 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); void * 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); FftwMethod do_method (void); FftwMethod do_method (FftwMethod _meth); FftwMethod meth; // FIXME: perhaps this should be split into two classes? // Plan for fft and ifft of complex values void *plan[2]; // dist octave_idx_type d[2]; // stride octave_idx_type s[2]; // rank int r[2]; // howmany octave_idx_type h[2]; // dims dim_vector n[2]; bool simd_align[2]; bool inplace[2]; // Plan for fft of real values void *rplan; // dist octave_idx_type rd; // stride octave_idx_type rs; // rank int rr; // howmany octave_idx_type rh; // dims dim_vector rn; bool rsimd_align; // number of threads. Always 1 unless compiled with multi-threading // support. int nthreads; }; class OCTAVE_API float_fftw_planner { protected: float_fftw_planner (void); public: // No copying! float_fftw_planner (const float_fftw_planner&) = delete; float_fftw_planner& operator = (const float_fftw_planner&) = delete; ~float_fftw_planner (void); enum FftwMethod { UNKNOWN = -1, ESTIMATE, MEASURE, PATIENT, EXHAUSTIVE, HYBRID }; static bool instance_ok (void); static void * 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) { return instance_ok () ? instance->do_create_plan (dir, rank, dims, howmany, stride, dist, in, out) : nullptr; } static void * 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) { return instance_ok () ? instance->do_create_plan (rank, dims, howmany, stride, dist, in, out) : nullptr; } static FftwMethod method (void) { static FftwMethod dummy; return instance_ok () ? instance->do_method () : dummy; } static FftwMethod method (FftwMethod _meth) { static FftwMethod dummy; return instance_ok () ? instance->do_method (_meth) : dummy; } static void threads (int nt); static int threads (void) { return instance_ok () ? instance->nthreads : 0; } private: static float_fftw_planner *instance; static void cleanup_instance (void) { delete instance; instance = nullptr; } void * 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); void * 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); FftwMethod do_method (void); FftwMethod do_method (FftwMethod _meth); FftwMethod meth; // FIXME: perhaps this should be split into two classes? // Plan for fft and ifft of complex values void *plan[2]; // dist octave_idx_type d[2]; // stride octave_idx_type s[2]; // rank int r[2]; // howmany octave_idx_type h[2]; // dims dim_vector n[2]; bool simd_align[2]; bool inplace[2]; // Plan for fft of real values void *rplan; // dist octave_idx_type rd; // stride octave_idx_type rs; // rank int rr; // howmany octave_idx_type rh; // dims dim_vector rn; bool rsimd_align; // number of threads. Always 1 unless compiled with multi-threading // support. int nthreads; }; class OCTAVE_API fftw { public: fftw (void) = delete; // No copying. fftw (const fftw&) = delete; fftw& operator = (const fftw&) = delete; static int fft (const double *in, Complex *out, size_t npts, size_t nsamples = 1, octave_idx_type stride = 1, octave_idx_type dist = -1); static int fft (const Complex *in, Complex *out, size_t npts, size_t nsamples = 1, octave_idx_type stride = 1, octave_idx_type dist = -1); static int ifft (const Complex *in, Complex *out, size_t npts, size_t nsamples = 1, octave_idx_type stride = 1, octave_idx_type dist = -1); static int fftNd (const double*, Complex*, const int, const dim_vector&); static int fftNd (const Complex*, Complex*, const int, const dim_vector&); static int ifftNd (const Complex*, Complex*, const int, const dim_vector&); static int fft (const float *in, FloatComplex *out, size_t npts, size_t nsamples = 1, octave_idx_type stride = 1, octave_idx_type dist = -1); static int fft (const FloatComplex *in, FloatComplex *out, size_t npts, size_t nsamples = 1, octave_idx_type stride = 1, octave_idx_type dist = -1); static int ifft (const FloatComplex *in, FloatComplex *out, size_t npts, size_t nsamples = 1, octave_idx_type stride = 1, octave_idx_type dist = -1); static int fftNd (const float*, FloatComplex*, const int, const dim_vector&); static int fftNd (const FloatComplex*, FloatComplex*, const int, const dim_vector&); static int ifftNd (const FloatComplex*, FloatComplex*, const int, const dim_vector&); }; extern OCTAVE_API std::string fftw_version (void); extern OCTAVE_API std::string fftwf_version (void); } #endif