From 3923481a53a183edfd8ccd7b02eccd5a3c7cda1c Mon Sep 17 00:00:00 2001 From: Yuuichi Asahi Date: Tue, 12 Mar 2024 17:13:53 +0900 Subject: [PATCH 01/11] Update License to Apache2 with LLVM exception --- LICENSE | 260 ++++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 236 insertions(+), 24 deletions(-) diff --git a/LICENSE b/LICENSE index 82701ebd..1e7a7e5e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,24 +1,236 @@ -MIT License - -Copyright (c) 2023-2024 Centre national de la recherche scientifique (CNRS) -Copyright (c) 2023-2024 Commissariat a l'énergie atomique et aux énergies alternatives (CEA) -Copyright (c) 2023-2024 Université Paris-Saclay -Copyright (c) 2023-2024 Université de Versailles Saint-Quentin-en-Yvelines - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +*************************************************************************************** + + Kokkos-fft v. 0.1 +Copyright (c) 2024 Centre national de la recherche scientifique (CNRS) +Copyright (c) 2024 Commissariat a l'énergie atomique et aux énergies alternatives (CEA) +Copyright (c) 2024 Université Paris-Saclay +Copyright (c) 2024 Université de Versailles Saint-Quentin-en-Yvelines + +============================================================================== +Kokkos-fft is under the Apache License v2.0 with LLVM Exceptions: +============================================================================== + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS Apache 2.0 + +---- LLVM Exceptions to the Apache 2.0 License ---- + +As an exception, if, as a result of your compiling your source code, portions +of this Software are embedded into an Object form of such source code, you +may redistribute such embedded portions in such Object form without complying +with the conditions of Sections 4(a), 4(b) and 4(d) of the License. + +In addition, if you combine or link compiled forms of this Software with +software that is licensed under the GPLv2 ("Combined Software") and if a +court of competent jurisdiction determines that the patent provision (Section +3), the indemnity provision (Section 9) or other Section of the License +conflicts with the conditions of the GPLv2, you may retroactively and +prospectively choose to deem waived or otherwise exclude such Section(s) of +the License, but only in their entirety and only with respect to the Combined +Software. + +============================================================================== +Software from third parties included in Kokkos-fft: +============================================================================== + +Kokkos contains third party software which is under different license +terms. All such code will be identified clearly using at least one of two +mechanisms: +1) It will be in a separate directory tree with its own `LICENSE.txt` or +`LICENSE` file at the top containing the specific license and restrictions +which apply to that software, or +2) It will contain specific license and restriction terms at the top of every +file. + + +THIS SOFTWARE IS PROVIDED BY NTESS "AS IS" AND ANY +EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NTESS OR THE +CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, +PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Questions? Contact: +Yuuichi Asahi (yuuichi.asahi(at)cea.fr) +Paul Zehner (paul.Zehner(at)cea.fr) + +*************************************************************************************** \ No newline at end of file From 64283642bb35d39d377a49cd7e733d3c811433c3 Mon Sep 17 00:00:00 2001 From: Yuuichi Asahi Date: Tue, 12 Mar 2024 17:25:33 +0900 Subject: [PATCH 02/11] Update the location of CI badge in README.md --- README.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0039f977..c0ba002e 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ # kokkos-fft -[![CI](https://github.com/CExA-project/kokkos-fft/actions/workflows/build_test.yaml/badge.svg)](https://github.com/CExA-project/kokkos-fft/actions) +[![CI](https://github.com/kokkos/kokkos-fft/actions/workflows/build_test.yaml/badge.svg)](https://github.com/kokkos/kokkos-fft/actions) [![docs](https://readthedocs.org/projects/kokkosfft/badge/?version=latest)](https://kokkosfft.readthedocs.io/en/latest/?badge=latest) > [!WARNING] > UNOFFICIAL FFT interfaces for Kokkos C++ Performance Portability Programming EcoSystem -KokkosFFT implements local interfaces between [Kokkos](https://github.com/kokkos/kokkos) and de facto standard FFT libraries, including [fftw](http://www.fftw.org), [cufft](https://developer.nvidia.com/cufft), [hipfft](https://github.com/ROCm/hipFFT) ([rocfft](https://github.com/ROCm/rocFFT)), and [oneMKL](https://spec.oneapi.io/versions/latest/elements/oneMKL/source/index.html). "Local" means not using MPI, or running within a single MPI process without knowing about MPI. We are inclined to implement the [numpy.fft](https://numpy.org/doc/stable/reference/routines.fft.html)-like interfaces adapted for [Kokkos](https://github.com/kokkos/kokkos). +Kokkos-fft implements local interfaces between [Kokkos](https://github.com/kokkos/kokkos) and de facto standard FFT libraries, including [fftw](http://www.fftw.org), [cufft](https://developer.nvidia.com/cufft), [hipfft](https://github.com/ROCm/hipFFT) ([rocfft](https://github.com/ROCm/rocFFT)), and [oneMKL](https://spec.oneapi.io/versions/latest/elements/oneMKL/source/index.html). "Local" means not using MPI, or running within a single MPI process without knowing about MPI. We are inclined to implement the [numpy.fft](https://numpy.org/doc/stable/reference/routines.fft.html)-like interfaces adapted for [Kokkos](https://github.com/kokkos/kokkos). A key concept is that **"As easy as numpy, as fast as vendor libraries"**. Accordingly, our API follows the API by [numpy.fft](https://numpy.org/doc/stable/reference/routines.fft.html) with minor differences. A fft library dedicated to Kokkos Device backend (e.g. [cufft](https://developer.nvidia.com/cufft) for CUDA backend) is automatically used. If something is wrong with runtime values (say `View` extents), it will raise runtime errors (C++ exceptions or assertions). See [documentations](https://kokkosfft.readthedocs.io/) for more information. -Here is an example for 1D real to complex transform with `rfft` in KokkosFFT. +Here is an example for 1D real to complex transform with `rfft` in Kokkos-fft. ```C++ #include #include @@ -37,7 +37,7 @@ x = np.random.rand(4) x_hat = np.fft.rfft(x) ``` -There are two major differences: [`execution_space`](https://kokkos.org/kokkos-core-wiki/API/core/execution_spaces.html) argument and output value (`x_hat`) is an argument of API (not returned value from API). As imagined, KokkosFFT only accepts [Kokkos Views](https://kokkos.org/kokkos-core-wiki/API/core/View.html) as input data. The accessibilities of Views from `execution_space` are statically checked (compilation errors if not accessible). +There are two major differences: [`execution_space`](https://kokkos.org/kokkos-core-wiki/API/core/execution_spaces.html) argument and output value (`x_hat`) is an argument of API (not returned value from API). As imagined, Kokkos-fft only accepts [Kokkos Views](https://kokkos.org/kokkos-core-wiki/API/core/View.html) as input data. The accessibilities of Views from `execution_space` are statically checked (compilation errors if not accessible). Depending on a View dimension, it automatically uses the batched plans as follows ```C++ @@ -74,15 +74,24 @@ In this example, the 1D batched `rfft` over 2D View along `axis -1` is executed. **KokkosFFT is under development and subject to change without warning. The authors do not guarantee that this code runs correctly in all the environments.** ## Using KokkosFFT -For the moment, there are two ways to use KokkosFFT: including as a subdirectory in CMake project or installing as a library. First of all, you need to clone this repo. +For the moment, there are two ways to use Kokkos-fft: including as a subdirectory in CMake project or installing as a library. First of all, you need to clone this repo. ```bash git clone --recursive https://github.com/CExA-project/kokkos-fft.git ``` +### Prerequisites +To use Kokkos-fft, we need the followings: +* `CMake 3.22+` +* `Kokkos 4.2+` +* `gcc 8.3.0+` (CPUs) +* `IntelLLVM 2023.0.0+` (CPUs, Intel GPUs) +* `nvcc 11.0.0+` (NVIDIA GPUs) +* `rocm 5.3.0+` (AMD GPUs) + ### CMake -Since KokkosFFT is a header-only library, it is enough to simply add as a subdirectory. It is assumed that kokkos and kokkosFFT are placed under `/tpls`. +Since Kokkos-fft is a header-only library, it is enough to simply add as a subdirectory. It is assumed that kokkos and Kokkos-fft are placed under `/tpls`. -Here is an example to use KokkosFFT in the following CMake project. +Here is an example to use Kokkos-fft in the following CMake project. ``` ---/ | @@ -118,5 +127,5 @@ cmake --build build -j 8 This way, all the functionalities are executed on A100 GPUs. For installation, details are provided in the [documentation](https://kokkosfft.readthedocs.io/en/latest/intro/building.html#install-kokkosfft-as-a-library). ## LICENCE -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -KokkosFFT is licensed under the MIT License. +[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +Kokkos-fft is under the Apache License v2.0 with LLVM Exceptions. \ No newline at end of file From bfe7b2fb4741380a834b4f0f13f3975e99716495 Mon Sep 17 00:00:00 2001 From: Yuuichi Asahi Date: Tue, 12 Mar 2024 17:36:52 +0900 Subject: [PATCH 03/11] fix path in docs --- docs/api_reference.rst | 2 +- docs/examples.rst | 8 ++++---- docs/finding_libraries.rst | 2 +- docs/index.rst | 8 ++++---- docs/intro/building.rst | 32 ++++++++++++++++---------------- docs/intro/quick_start.rst | 20 ++++++++++---------- docs/intro/using.rst | 14 +++++++------- 7 files changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/api_reference.rst b/docs/api_reference.rst index 15cee34b..c5ea58b7 100644 --- a/docs/api_reference.rst +++ b/docs/api_reference.rst @@ -3,7 +3,7 @@ API Reference ============= -This section documents the public user interface of ``KokkosFFT``. +This section documents the public user interface of ``Kokkos-fft``. APIs are defined in ``KokkosFFT`` namespace and implementation details are defined in ``KokkosFFT::Impl`` namespace. Thus, it is highly discouraged for users to access functions in ``KokkosFFT::Impl`` namespace except for ``Plan``. Except for ``KokkosFFT::Impl::Plan``, there are corresponding functions in ``numpy.fft`` as shown below. diff --git a/docs/examples.rst b/docs/examples.rst index 85183995..5e01367b 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -4,10 +4,10 @@ Examples ======== There are some `examples -`_ in the -KokkosFFT repository. Each example includes Kokkos and numpy implementations. +`_ in the +Kokkos-fft repository. Each example includes Kokkos and numpy implementations. For example, `01_1DFFT -`_ includes, +`_ includes, .. code-block:: bash @@ -15,7 +15,7 @@ For example, `01_1DFFT | └──01_1DFFT/ |--CMakeLists.txt - |--01_1DFFT.cpp (KokkosFFT version) + |--01_1DFFT.cpp (Kokkos-fft version) └──numpy_1DFFT.py (numpy version) Please find the examples from following links. diff --git a/docs/finding_libraries.rst b/docs/finding_libraries.rst index d0f438ba..b3354d67 100644 --- a/docs/finding_libraries.rst +++ b/docs/finding_libraries.rst @@ -41,4 +41,4 @@ Please make sure to initialize ``oneAPI`` as .. code-block:: bash - /setvars.sh --include-intel-llvm + /setvars.sh --include-intel-llvm diff --git a/docs/index.rst b/docs/index.rst index ddc95fd1..aacea809 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,8 @@ -KokkosFFT documentation +Kokkos-fft documentation ======================================= -KokkosFFT implements local interfaces between `Kokkos `_ +Kokkos-fft implements local interfaces between `Kokkos `_ and de facto standard FFT libraries, including `fftw `_, `cufft `_, @@ -12,9 +12,9 @@ We are inclined to implement the `numpy.fft `_. +Kokkos-fft is open source and available on `GitHub `_. -Here is an example for 1D real to complex transform with ``rfft`` in KokkosFFT. +Here is an example for 1D real to complex transform with ``rfft`` in Kokkos-fft. .. code-block:: C++ diff --git a/docs/intro/building.rst b/docs/intro/building.rst index 87dcc61a..966975ec 100644 --- a/docs/intro/building.rst +++ b/docs/intro/building.rst @@ -1,17 +1,17 @@ .. _building: -Building KokkosFFT -================== +Building Kokkos-fft +=================== -This section describes how to build KokkosFFT with some advanced options. -In order to build KokkosFFT, we use ``CMake`` with following compilers. +This section describes how to build Kokkos-fft with some advanced options. +In order to build Kokkos-fft, we use ``CMake`` with following compilers. Kokkos and backend FFT libraries are also necessary. -Available CMake options for KokkosFFT are listed. +Available CMake options for Kokkos-fft are listed. Compiler versions ----------------- -KokkosFFT relies on quite basic functionalities of Kokkos, and thus it is supposed to work with compilers used for `Kokkos `_. +Kokkos-fft relies on quite basic functionalities of Kokkos, and thus it is supposed to work with compilers used for `Kokkos `_. However, we have not tested all the listed compilers there and thus recommend the following compilers which we use frequently for testing. * ``gcc 8.3.0+`` - CPUs @@ -19,10 +19,10 @@ However, we have not tested all the listed compilers there and thus recommend th * ``nvcc 12.0.0+`` - NVIDIA GPUs * ``rocm 5.3.0+`` - AMD GPUs -Install KokkosFFT as a library ------------------------------- +Install Kokkos-fft as a library +------------------------------- -Let's assume Kokkos is installed under ```` with ``OpenMP`` backend. We build and install KokkosFFT under ````. +Let's assume Kokkos is installed under ```` with ``OpenMP`` backend. We build and install Kokkos-fft under ````. .. code-block:: bash @@ -35,7 +35,7 @@ Let's assume Kokkos is installed under ```` with ``OpenMP`` back cmake --build build_KokkosFFT -j 8 cmake --install build_KokkosFFT -Here is an example to use KokkosFFT in the following CMake project. +Here is an example to use Kokkos-fft in the following CMake project. .. code-block:: bash @@ -70,9 +70,9 @@ The code can be built as CMake options ------------- -We rely on CMake to build KokkosFFT, more specifically ``CMake 3.22+``. Here is the list of CMake options. +We rely on CMake to build Kokkos-fft, more specifically ``CMake 3.22+``. Here is the list of CMake options. For FFTs on Kokkos device only, we do not need to add extra compile options but for Kokkos ones. -In order to use KokkosFFT from both host and device, it is necessary to add ``KokkosFFT_ENABLE_HOST_AND_DEVICE=ON``. +In order to use Kokkos-fft from both host and device, it is necessary to add ``KokkosFFT_ENABLE_HOST_AND_DEVICE=ON``. This option may be useful, for example FFT is used for initialization at host. However, to enable this option, we need a pre-installed ``fftw`` for FFT on host, so it is disabled in default (see :doc:`minimum working example<../samples/05_1DFFT_HOST_DEVICE>`). @@ -91,13 +91,13 @@ However, to enable this option, we need a pre-installed ``fftw`` for FFT on host - Build internal Kokkos instead of relying on external one. - OFF * - ``KokkosFFT_ENABLE_EXAMPLES`` - - Build KokkosFFT examples + - Build Kokkos-fft examples - OFF * - ``KokkosFFT_ENABLE_TESTS`` - - Build KokkosFFT tests + - Build Kokkos-fft tests - OFF * - ``KokkosFFT_ENABLE_BENCHMARK`` - - Build benchmarks for KokkosFFT + - Build benchmarks for Kokkos-fft - OFF * - ``KokkosFFT_ENABLE_ROCFFT`` - Use `rocfft `_ for HIP backend @@ -106,7 +106,7 @@ However, to enable this option, we need a pre-installed ``fftw`` for FFT on host Kokkos backends --------------- -KokkosFFT requires ``Kokkos 4.2+``. For the moment, we support following backends for CPUs and GPUs. +Kokkos-fft requires ``Kokkos 4.2+``. For the moment, we support following backends for CPUs and GPUs. A FFT library dedicated to Kokkos Device backend (e.g. cufft for CUDA backend) is automatically used. If CMake fails to find a backend FFT library, see :doc:`How to find fft libraries?<../finding_libraries>`. We may support experimental backends like ``OPENMPTARGET`` in the future. diff --git a/docs/intro/quick_start.rst b/docs/intro/quick_start.rst index 1381392a..fed39759 100644 --- a/docs/intro/quick_start.rst +++ b/docs/intro/quick_start.rst @@ -3,20 +3,20 @@ Quickstart guide ================ -This section will quickly illustrate how to use KokkosFFT. +This section will quickly illustrate how to use Kokkos-fft. First of all, you need to clone this repo. .. code-block:: bash - git clone --recursive https://github.com/CExA-project/kokkos-fft.git + git clone --recursive https://github.com/kokkos/kokkos-fft.git -To configure KokkosFFT, we can just use CMake options for Kokkos, which automatically enables the FFT interface on Kokkos device. +To configure Kokkos-fft, we can just use CMake options for Kokkos, which automatically enables the FFT interface on Kokkos device. If CMake fails to find a backend FFT library, see :doc:`How to find fft libraries?<../finding_libraries>`. Requirements ------------ -KokkosFFT requires ``Kokkos 4.2+`` and dedicated compilers for CPUs or GPUs. +Kokkos-fft requires ``Kokkos 4.2+`` and dedicated compilers for CPUs or GPUs. It employs ``CMake 3.22+`` for building. Here are list of compilers we frequently use for testing. @@ -29,11 +29,11 @@ Here are list of compilers we frequently use for testing. Building -------- -For the moment, there are two ways to use KokkosFFT: including as a subdirectory in CMake project or installing as a library. -For simplicity, however, we demonstrate an example to use KokkosFFT as a subdirectory in a CMake project. For installation, see :ref:`Building KokkosFFT`. -Since KokkosFFT is a header-only library, it is enough to simply add as a subdirectory. It is assumed that kokkos and kokkosFFT are placed under ``/tpls``. +For the moment, there are two ways to use Kokkos-fft: including as a subdirectory in CMake project or installing as a library. +For simplicity, however, we demonstrate an example to use Kokkos-fft as a subdirectory in a CMake project. For installation, see :ref:`Building Kokkos-fft`. +Since Kokkos-fft is a header-only library, it is enough to simply add as a subdirectory. It is assumed that kokkos and Kokkos-fft are placed under ``/tpls``. -Here is an example to use KokkosFFT in the following CMake project. +Here is an example to use Kokkos-fft in the following CMake project. .. code-block:: bash @@ -76,7 +76,7 @@ Trying ------ For those who are familiar with `numpy.fft `_, -you may use KokkosFFT quite easily. Here is an example for 1D real to complex transform with ``rfft`` in KokkosFFT and python. +you may use Kokkos-fft quite easily. Here is an example for 1D real to complex transform with ``rfft`` in Kokkos-fft and python. .. code-block:: C++ @@ -108,4 +108,4 @@ There are two major differences: ``execution_space`` argument and output value ( Instead of numpy.array, we rely on `Kokkos Views `_. The accessibilities of Views from ``execution_space`` are statically checked (compilation errors if not accessible). It is easiest to rely only on the ``Kokkos::DefaultExecutionSpace`` for both View allocation and KokkosFFT APIs. -See :ref:`Using KokkosFFT` for detail. +See :ref:`Using Kokkos-fft` for detail. diff --git a/docs/intro/using.rst b/docs/intro/using.rst index b2eccd4e..92f15c2b 100644 --- a/docs/intro/using.rst +++ b/docs/intro/using.rst @@ -1,16 +1,16 @@ .. _using: -Using KokkosFFT -=============== +Using Kokkos-fft +================ -This section describes how to use KokkosFFT in practice. +This section describes how to use Kokkos-fft in practice. We also explain some tips to use it efficiently. Brief introduction ------------------ -Most of the numpy.fft APIs (``numpy.fft.``) are available in KokkosFFT (``KokkosFFT::``) on the Kokkos device. -In fact, these are the only APIs available in KokkosFFT (see :doc:`API reference<../api_reference>` for detail). KokkosFFT support 1D to 3D FFT over chosen axes. +Most of the numpy.fft APIs (``numpy.fft.``) are available in Kokkos-fft (``KokkosFFT::``) on the Kokkos device. +In fact, these are the only APIs available in Kokkos-fft (see :doc:`API reference<../api_reference>` for detail). Kokkos-fft support 1D to 3D FFT over chosen axes. Inside FFT APIs, we first create a FFT plan for a backend FFT library based on the Views and chosen axes. Then, we execute the FFT using the created plan on the given Views. Then, we may perform normalization based on the users' choice. Finally, we destroy the plan. Depending on the View Layout and chosen axes, we may need transpose operations to make data contiguous. @@ -94,7 +94,7 @@ Memory consmpution ------------------ In order to support FFT over arbitral axes, -KokkosFFT performs transpose operations internally and apply FFT on contiguous data. +Kokkos-fft performs transpose operations internally and apply FFT on contiguous data. For size ``n`` input, this requires internal buffers of size ``2n`` in addition to the buffers used by FFT library. Performance overhead from transpose may be not critical but memory consumptions are problematic. If memory consumption matters, it is recommended to make data contiguous so that transpose is not performed. @@ -118,7 +118,7 @@ The following listing shows examples with and without transpose operation. Reuse FFT plan -------------- -Apart from the basic APIs, KokkosFFT APIs include overloaded APIs which can take a FFT plan as an argument. +Apart from the basic APIs, Kokkos-fft APIs include overloaded APIs which can take a FFT plan as an argument. Using these overloaded APIs, we can reuse the FFT plan created before. In some backend, FFT plan creation leads to some overhead, wherein we need this functionality. (see :doc:`minimum working example<../samples/06_1DFFT_reuse_plans>`) From 211ca1158eba5975e8822e4030b18d07eba65482 Mon Sep 17 00:00:00 2001 From: Yuuichi Asahi Date: Tue, 12 Mar 2024 17:38:25 +0900 Subject: [PATCH 04/11] fix path in REAEME.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c0ba002e..f3e45fb7 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ x = np.random.rand(4, 8) x_hat = np.fft.rfft(x, axis=-1) ``` -In this example, the 1D batched `rfft` over 2D View along `axis -1` is executed. Some basic examples are found in [examples](https://github.com/CExA-project/kokkos-fft/tree/main/examples). +In this example, the 1D batched `rfft` over 2D View along `axis -1` is executed. Some basic examples are found in [examples](examples). ## Disclaimer **KokkosFFT is under development and subject to change without warning. The authors do not guarantee that this code runs correctly in all the environments.** @@ -76,7 +76,7 @@ In this example, the 1D batched `rfft` over 2D View along `axis -1` is executed. ## Using KokkosFFT For the moment, there are two ways to use Kokkos-fft: including as a subdirectory in CMake project or installing as a library. First of all, you need to clone this repo. ```bash -git clone --recursive https://github.com/CExA-project/kokkos-fft.git +git clone --recursive https://github.com/kokkos/kokkos-fft.git ``` ### Prerequisites From fa9d0315cc60038f6857ebe7b53f6f8b0a70d939 Mon Sep 17 00:00:00 2001 From: Yuuichi Asahi Date: Tue, 12 Mar 2024 17:57:01 +0900 Subject: [PATCH 05/11] Update License --- common/src/KokkosFFT_Helpers.hpp | 2 +- common/src/KokkosFFT_common_types.hpp | 2 +- common/src/KokkosFFT_normalization.hpp | 2 +- common/src/KokkosFFT_padding.hpp | 2 +- common/src/KokkosFFT_transpose.hpp | 2 +- common/src/KokkosFFT_utils.hpp | 2 +- common/unit_test/Test_Helpers.cpp | 2 +- common/unit_test/Test_Layouts.cpp | 2 +- common/unit_test/Test_Main.cpp | 2 ++ common/unit_test/Test_Normalization.cpp | 2 +- common/unit_test/Test_Padding.cpp | 2 +- common/unit_test/Test_Transpose.cpp | 2 +- common/unit_test/Test_Types.hpp | 2 +- common/unit_test/Test_Utils.cpp | 2 +- common/unit_test/Test_Utils.hpp | 2 +- examples/01_1DFFT/01_1DFFT.cpp | 2 +- examples/02_2DFFT/02_2DFFT.cpp | 2 +- examples/03_NDFFT/03_NDFFT.cpp | 2 +- examples/04_batchedFFT/04_batchedFFT.cpp | 2 +- examples/05_1DFFT_HOST_DEVICE/05_1DFFT_HOST_DEVICE.cpp | 2 +- examples/06_1DFFT_reuse_plans/06_1DFFT_reuse_plans.cpp | 2 +- fft/perf_test/BenchmarkMain.cpp | 2 ++ fft/perf_test/Benchmark_Context.hpp | 2 ++ fft/perf_test/KokkosFFT_PrintConfiguration.hpp | 2 ++ fft/perf_test/KokkosFFT_TplsVersion.hpp | 2 ++ fft/perf_test/PerfTest_FFT1.cpp | 2 +- fft/perf_test/PerfTest_FFT1.hpp | 2 +- fft/perf_test/PerfTest_FFT2.cpp | 2 +- fft/perf_test/PerfTest_FFT2.hpp | 2 +- fft/src/KokkosFFT.hpp | 2 +- fft/src/KokkosFFT_Cuda_plans.hpp | 2 +- fft/src/KokkosFFT_Cuda_transform.hpp | 2 +- fft/src/KokkosFFT_Cuda_types.hpp | 2 +- fft/src/KokkosFFT_HIP_plans.hpp | 2 +- fft/src/KokkosFFT_HIP_transform.hpp | 2 +- fft/src/KokkosFFT_HIP_types.hpp | 2 +- fft/src/KokkosFFT_OpenMP_plans.hpp | 2 +- fft/src/KokkosFFT_OpenMP_transform.hpp | 2 +- fft/src/KokkosFFT_OpenMP_types.hpp | 2 +- fft/src/KokkosFFT_Plans.hpp | 2 +- fft/src/KokkosFFT_ROCM_plans.hpp | 2 +- fft/src/KokkosFFT_ROCM_transform.hpp | 2 +- fft/src/KokkosFFT_ROCM_types.hpp | 2 +- fft/src/KokkosFFT_SYCL_plans.hpp | 2 +- fft/src/KokkosFFT_SYCL_transform.hpp | 2 +- fft/src/KokkosFFT_SYCL_types.hpp | 2 +- fft/src/KokkosFFT_Transform.hpp | 2 +- fft/src/KokkosFFT_default_types.hpp | 2 +- fft/unit_test/Test_Main.cpp | 2 ++ fft/unit_test/Test_Plans.cpp | 2 +- fft/unit_test/Test_Transform.cpp | 2 +- fft/unit_test/Test_Types.hpp | 2 +- fft/unit_test/Test_Utils.hpp | 2 +- install_test/as_library/hello.cpp | 2 +- install_test/as_subdirectory/hello.cpp | 2 +- 55 files changed, 61 insertions(+), 49 deletions(-) diff --git a/common/src/KokkosFFT_Helpers.hpp b/common/src/KokkosFFT_Helpers.hpp index 34f6079c..c6d7fe8c 100644 --- a/common/src/KokkosFFT_Helpers.hpp +++ b/common/src/KokkosFFT_Helpers.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_HELPERS_HPP #define KOKKOSFFT_HELPERS_HPP diff --git a/common/src/KokkosFFT_common_types.hpp b/common/src/KokkosFFT_common_types.hpp index b74e13ee..a8c4701b 100644 --- a/common/src/KokkosFFT_common_types.hpp +++ b/common/src/KokkosFFT_common_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_COMMON_TYPES_HPP #define KOKKOSFFT_COMMON_TYPES_HPP diff --git a/common/src/KokkosFFT_normalization.hpp b/common/src/KokkosFFT_normalization.hpp index 0199e1de..9c77366f 100644 --- a/common/src/KokkosFFT_normalization.hpp +++ b/common/src/KokkosFFT_normalization.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_NORMALIZATION_HPP #define KOKKOSFFT_NORMALIZATION_HPP diff --git a/common/src/KokkosFFT_padding.hpp b/common/src/KokkosFFT_padding.hpp index 5bea8a73..f9daf79e 100644 --- a/common/src/KokkosFFT_padding.hpp +++ b/common/src/KokkosFFT_padding.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_PADDING_HPP #define KOKKOSFFT_PADDING_HPP diff --git a/common/src/KokkosFFT_transpose.hpp b/common/src/KokkosFFT_transpose.hpp index c28a5520..46bf2da9 100644 --- a/common/src/KokkosFFT_transpose.hpp +++ b/common/src/KokkosFFT_transpose.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_TRANSPOSE_HPP #define KOKKOSFFT_TRANSPOSE_HPP diff --git a/common/src/KokkosFFT_utils.hpp b/common/src/KokkosFFT_utils.hpp index 006ca346..e3b86ca6 100644 --- a/common/src/KokkosFFT_utils.hpp +++ b/common/src/KokkosFFT_utils.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_UTILS_HPP #define KOKKOSFFT_UTILS_HPP diff --git a/common/unit_test/Test_Helpers.cpp b/common/unit_test/Test_Helpers.cpp index 25e9ff8f..31a9b3dc 100644 --- a/common/unit_test/Test_Helpers.cpp +++ b/common/unit_test/Test_Helpers.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/common/unit_test/Test_Layouts.cpp b/common/unit_test/Test_Layouts.cpp index 5e2d4b7e..ec0ddef6 100644 --- a/common/unit_test/Test_Layouts.cpp +++ b/common/unit_test/Test_Layouts.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/common/unit_test/Test_Main.cpp b/common/unit_test/Test_Main.cpp index b4cfc19a..4e736989 100644 --- a/common/unit_test/Test_Main.cpp +++ b/common/unit_test/Test_Main.cpp @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + //@HEADER // ************************************************************************ // diff --git a/common/unit_test/Test_Normalization.cpp b/common/unit_test/Test_Normalization.cpp index e6423147..5881edf8 100644 --- a/common/unit_test/Test_Normalization.cpp +++ b/common/unit_test/Test_Normalization.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/common/unit_test/Test_Padding.cpp b/common/unit_test/Test_Padding.cpp index 92f9779b..562d1210 100644 --- a/common/unit_test/Test_Padding.cpp +++ b/common/unit_test/Test_Padding.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/common/unit_test/Test_Transpose.cpp b/common/unit_test/Test_Transpose.cpp index d96c22c9..b9e2da67 100644 --- a/common/unit_test/Test_Transpose.cpp +++ b/common/unit_test/Test_Transpose.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/common/unit_test/Test_Types.hpp b/common/unit_test/Test_Types.hpp index ce71654f..024433f3 100644 --- a/common/unit_test/Test_Types.hpp +++ b/common/unit_test/Test_Types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef TEST_TYPES_HPP #define TEST_TYPES_HPP diff --git a/common/unit_test/Test_Utils.cpp b/common/unit_test/Test_Utils.cpp index 44ec69a3..d92ccdac 100644 --- a/common/unit_test/Test_Utils.cpp +++ b/common/unit_test/Test_Utils.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include "KokkosFFT_utils.hpp" diff --git a/common/unit_test/Test_Utils.hpp b/common/unit_test/Test_Utils.hpp index cb76da8e..b6710daa 100644 --- a/common/unit_test/Test_Utils.hpp +++ b/common/unit_test/Test_Utils.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef TEST_UTILS_HPP #define TEST_UTILS_HPP diff --git a/examples/01_1DFFT/01_1DFFT.cpp b/examples/01_1DFFT/01_1DFFT.cpp index 1755b5c3..0280ab43 100644 --- a/examples/01_1DFFT/01_1DFFT.cpp +++ b/examples/01_1DFFT/01_1DFFT.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/examples/02_2DFFT/02_2DFFT.cpp b/examples/02_2DFFT/02_2DFFT.cpp index 28f886e1..5df61a4f 100644 --- a/examples/02_2DFFT/02_2DFFT.cpp +++ b/examples/02_2DFFT/02_2DFFT.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/examples/03_NDFFT/03_NDFFT.cpp b/examples/03_NDFFT/03_NDFFT.cpp index dbaa1f11..ef2953e0 100644 --- a/examples/03_NDFFT/03_NDFFT.cpp +++ b/examples/03_NDFFT/03_NDFFT.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/examples/04_batchedFFT/04_batchedFFT.cpp b/examples/04_batchedFFT/04_batchedFFT.cpp index d4c34b99..d108efe9 100644 --- a/examples/04_batchedFFT/04_batchedFFT.cpp +++ b/examples/04_batchedFFT/04_batchedFFT.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/examples/05_1DFFT_HOST_DEVICE/05_1DFFT_HOST_DEVICE.cpp b/examples/05_1DFFT_HOST_DEVICE/05_1DFFT_HOST_DEVICE.cpp index 922704c3..03e16495 100644 --- a/examples/05_1DFFT_HOST_DEVICE/05_1DFFT_HOST_DEVICE.cpp +++ b/examples/05_1DFFT_HOST_DEVICE/05_1DFFT_HOST_DEVICE.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/examples/06_1DFFT_reuse_plans/06_1DFFT_reuse_plans.cpp b/examples/06_1DFFT_reuse_plans/06_1DFFT_reuse_plans.cpp index 5eae0f7c..0dd32945 100644 --- a/examples/06_1DFFT_reuse_plans/06_1DFFT_reuse_plans.cpp +++ b/examples/06_1DFFT_reuse_plans/06_1DFFT_reuse_plans.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/fft/perf_test/BenchmarkMain.cpp b/fft/perf_test/BenchmarkMain.cpp index 2b6c856b..7b1bd0a6 100644 --- a/fft/perf_test/BenchmarkMain.cpp +++ b/fft/perf_test/BenchmarkMain.cpp @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + /* //@HEADER // ************************************************************************ diff --git a/fft/perf_test/Benchmark_Context.hpp b/fft/perf_test/Benchmark_Context.hpp index d1dd2edb..3e889e09 100644 --- a/fft/perf_test/Benchmark_Context.hpp +++ b/fft/perf_test/Benchmark_Context.hpp @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + #ifndef KOKKOSFFT_BENCHMARK_CONTEXT_HPP #define KOKKOSFFT_BENCHMARK_CONTEXT_HPP diff --git a/fft/perf_test/KokkosFFT_PrintConfiguration.hpp b/fft/perf_test/KokkosFFT_PrintConfiguration.hpp index d1b5119c..95a1104f 100644 --- a/fft/perf_test/KokkosFFT_PrintConfiguration.hpp +++ b/fft/perf_test/KokkosFFT_PrintConfiguration.hpp @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + //@HEADER // ************************************************************************ // diff --git a/fft/perf_test/KokkosFFT_TplsVersion.hpp b/fft/perf_test/KokkosFFT_TplsVersion.hpp index 4e2aa367..c693143f 100644 --- a/fft/perf_test/KokkosFFT_TplsVersion.hpp +++ b/fft/perf_test/KokkosFFT_TplsVersion.hpp @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + //@HEADER // ************************************************************************ // diff --git a/fft/perf_test/PerfTest_FFT1.cpp b/fft/perf_test/PerfTest_FFT1.cpp index d08b36a7..349f4909 100644 --- a/fft/perf_test/PerfTest_FFT1.cpp +++ b/fft/perf_test/PerfTest_FFT1.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include "PerfTest_FFT1.hpp" diff --git a/fft/perf_test/PerfTest_FFT1.hpp b/fft/perf_test/PerfTest_FFT1.hpp index b40605d5..5d5f26cb 100644 --- a/fft/perf_test/PerfTest_FFT1.hpp +++ b/fft/perf_test/PerfTest_FFT1.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_PERFTEST_FFT1_HPP #define KOKKOSFFT_PERFTEST_FFT1_HPP diff --git a/fft/perf_test/PerfTest_FFT2.cpp b/fft/perf_test/PerfTest_FFT2.cpp index f3b63685..5d3f016c 100644 --- a/fft/perf_test/PerfTest_FFT2.cpp +++ b/fft/perf_test/PerfTest_FFT2.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include "PerfTest_FFT2.hpp" diff --git a/fft/perf_test/PerfTest_FFT2.hpp b/fft/perf_test/PerfTest_FFT2.hpp index 950c76c9..6002ce3e 100644 --- a/fft/perf_test/PerfTest_FFT2.hpp +++ b/fft/perf_test/PerfTest_FFT2.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_PERFTEST_FFT2_HPP #define KOKKOSFFT_PERFTEST_FFT2_HPP diff --git a/fft/src/KokkosFFT.hpp b/fft/src/KokkosFFT.hpp index 9ed176ee..980d391c 100644 --- a/fft/src/KokkosFFT.hpp +++ b/fft/src/KokkosFFT.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOS_FFT_HPP #define KOKKOS_FFT_HPP diff --git a/fft/src/KokkosFFT_Cuda_plans.hpp b/fft/src/KokkosFFT_Cuda_plans.hpp index 6f1b6457..dcc8e156 100644 --- a/fft/src/KokkosFFT_Cuda_plans.hpp +++ b/fft/src/KokkosFFT_Cuda_plans.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_CUDA_PLANS_HPP #define KOKKOSFFT_CUDA_PLANS_HPP diff --git a/fft/src/KokkosFFT_Cuda_transform.hpp b/fft/src/KokkosFFT_Cuda_transform.hpp index ad842750..52cd0001 100644 --- a/fft/src/KokkosFFT_Cuda_transform.hpp +++ b/fft/src/KokkosFFT_Cuda_transform.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_CUDA_TRANSFORM_HPP #define KOKKOSFFT_CUDA_TRANSFORM_HPP diff --git a/fft/src/KokkosFFT_Cuda_types.hpp b/fft/src/KokkosFFT_Cuda_types.hpp index 5d70f245..5a73e0c7 100644 --- a/fft/src/KokkosFFT_Cuda_types.hpp +++ b/fft/src/KokkosFFT_Cuda_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_CUDA_TYPES_HPP #define KOKKOSFFT_CUDA_TYPES_HPP diff --git a/fft/src/KokkosFFT_HIP_plans.hpp b/fft/src/KokkosFFT_HIP_plans.hpp index 902f5ac8..5b3b007f 100644 --- a/fft/src/KokkosFFT_HIP_plans.hpp +++ b/fft/src/KokkosFFT_HIP_plans.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_HIP_PLANS_HPP #define KOKKOSFFT_HIP_PLANS_HPP diff --git a/fft/src/KokkosFFT_HIP_transform.hpp b/fft/src/KokkosFFT_HIP_transform.hpp index 2518ad4d..2dccdde1 100644 --- a/fft/src/KokkosFFT_HIP_transform.hpp +++ b/fft/src/KokkosFFT_HIP_transform.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_HIP_TRANSFORM_HPP #define KOKKOSFFT_HIP_TRANSFORM_HPP diff --git a/fft/src/KokkosFFT_HIP_types.hpp b/fft/src/KokkosFFT_HIP_types.hpp index c65de3d4..590b0487 100644 --- a/fft/src/KokkosFFT_HIP_types.hpp +++ b/fft/src/KokkosFFT_HIP_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_HIP_TYPES_HPP #define KOKKOSFFT_HIP_TYPES_HPP diff --git a/fft/src/KokkosFFT_OpenMP_plans.hpp b/fft/src/KokkosFFT_OpenMP_plans.hpp index 9b6e0b0a..4dfd3eb0 100644 --- a/fft/src/KokkosFFT_OpenMP_plans.hpp +++ b/fft/src/KokkosFFT_OpenMP_plans.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_OPENMP_PLANS_HPP #define KOKKOSFFT_OPENMP_PLANS_HPP diff --git a/fft/src/KokkosFFT_OpenMP_transform.hpp b/fft/src/KokkosFFT_OpenMP_transform.hpp index a56113e5..9f4da510 100644 --- a/fft/src/KokkosFFT_OpenMP_transform.hpp +++ b/fft/src/KokkosFFT_OpenMP_transform.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_OPENMP_TRANSFORM_HPP #define KOKKOSFFT_OPENMP_TRANSFORM_HPP diff --git a/fft/src/KokkosFFT_OpenMP_types.hpp b/fft/src/KokkosFFT_OpenMP_types.hpp index c04bc55d..75731c35 100644 --- a/fft/src/KokkosFFT_OpenMP_types.hpp +++ b/fft/src/KokkosFFT_OpenMP_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_OPENMP_TYPES_HPP #define KOKKOSFFT_OPENMP_TYPES_HPP diff --git a/fft/src/KokkosFFT_Plans.hpp b/fft/src/KokkosFFT_Plans.hpp index 8fdc34e7..fa22ba7b 100644 --- a/fft/src/KokkosFFT_Plans.hpp +++ b/fft/src/KokkosFFT_Plans.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception /// \file KokkosFFT_Plans.hpp /// \brief Wrapping fft plans of different fft libraries diff --git a/fft/src/KokkosFFT_ROCM_plans.hpp b/fft/src/KokkosFFT_ROCM_plans.hpp index e82a590f..1b6c5c7b 100644 --- a/fft/src/KokkosFFT_ROCM_plans.hpp +++ b/fft/src/KokkosFFT_ROCM_plans.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_ROCM_PLANS_HPP #define KOKKOSFFT_ROCM_PLANS_HPP diff --git a/fft/src/KokkosFFT_ROCM_transform.hpp b/fft/src/KokkosFFT_ROCM_transform.hpp index dc1a263b..194929b5 100644 --- a/fft/src/KokkosFFT_ROCM_transform.hpp +++ b/fft/src/KokkosFFT_ROCM_transform.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_ROCM_TRANSFORM_HPP #define KOKKOSFFT_ROCM_TRANSFORM_HPP diff --git a/fft/src/KokkosFFT_ROCM_types.hpp b/fft/src/KokkosFFT_ROCM_types.hpp index e586e285..a377a740 100644 --- a/fft/src/KokkosFFT_ROCM_types.hpp +++ b/fft/src/KokkosFFT_ROCM_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_ROCM_TYPES_HPP #define KOKKOSFFT_ROCM_TYPES_HPP diff --git a/fft/src/KokkosFFT_SYCL_plans.hpp b/fft/src/KokkosFFT_SYCL_plans.hpp index e426a78b..642963d9 100644 --- a/fft/src/KokkosFFT_SYCL_plans.hpp +++ b/fft/src/KokkosFFT_SYCL_plans.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_SYCL_PLANS_HPP #define KOKKOSFFT_SYCL_PLANS_HPP diff --git a/fft/src/KokkosFFT_SYCL_transform.hpp b/fft/src/KokkosFFT_SYCL_transform.hpp index 832d63a9..7c7dafce 100644 --- a/fft/src/KokkosFFT_SYCL_transform.hpp +++ b/fft/src/KokkosFFT_SYCL_transform.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_SYCL_TRANSFORM_HPP #define KOKKOSFFT_SYCL_TRANSFORM_HPP diff --git a/fft/src/KokkosFFT_SYCL_types.hpp b/fft/src/KokkosFFT_SYCL_types.hpp index f698d02d..898cb8ad 100644 --- a/fft/src/KokkosFFT_SYCL_types.hpp +++ b/fft/src/KokkosFFT_SYCL_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_SYCL_TYPES_HPP #define KOKKOSFFT_SYCL_TYPES_HPP diff --git a/fft/src/KokkosFFT_Transform.hpp b/fft/src/KokkosFFT_Transform.hpp index 74cd63f1..372b8021 100644 --- a/fft/src/KokkosFFT_Transform.hpp +++ b/fft/src/KokkosFFT_Transform.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_TRANSFORM_HPP #define KOKKOSFFT_TRANSFORM_HPP diff --git a/fft/src/KokkosFFT_default_types.hpp b/fft/src/KokkosFFT_default_types.hpp index 89b1790e..ecf8f343 100644 --- a/fft/src/KokkosFFT_default_types.hpp +++ b/fft/src/KokkosFFT_default_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_DEFAULT_TYPES_HPP #define KOKKOSFFT_DEFAULT_TYPES_HPP diff --git a/fft/unit_test/Test_Main.cpp b/fft/unit_test/Test_Main.cpp index b4cfc19a..4e736989 100644 --- a/fft/unit_test/Test_Main.cpp +++ b/fft/unit_test/Test_Main.cpp @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + //@HEADER // ************************************************************************ // diff --git a/fft/unit_test/Test_Plans.cpp b/fft/unit_test/Test_Plans.cpp index 1bdb7006..f049d7ac 100644 --- a/fft/unit_test/Test_Plans.cpp +++ b/fft/unit_test/Test_Plans.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include "KokkosFFT_Plans.hpp" diff --git a/fft/unit_test/Test_Transform.cpp b/fft/unit_test/Test_Transform.cpp index 913500ac..03702c56 100644 --- a/fft/unit_test/Test_Transform.cpp +++ b/fft/unit_test/Test_Transform.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/fft/unit_test/Test_Types.hpp b/fft/unit_test/Test_Types.hpp index b99b859a..b68322b2 100644 --- a/fft/unit_test/Test_Types.hpp +++ b/fft/unit_test/Test_Types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef TEST_TYPES_HPP #define TEST_TYPES_HPP diff --git a/fft/unit_test/Test_Utils.hpp b/fft/unit_test/Test_Utils.hpp index 782a1feb..53435fad 100644 --- a/fft/unit_test/Test_Utils.hpp +++ b/fft/unit_test/Test_Utils.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #ifndef TEST_UTILS_HPP #define TEST_UTILS_HPP diff --git a/install_test/as_library/hello.cpp b/install_test/as_library/hello.cpp index 1755b5c3..0280ab43 100644 --- a/install_test/as_library/hello.cpp +++ b/install_test/as_library/hello.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include diff --git a/install_test/as_subdirectory/hello.cpp b/install_test/as_subdirectory/hello.cpp index 28f886e1..5df61a4f 100644 --- a/install_test/as_subdirectory/hello.cpp +++ b/install_test/as_subdirectory/hello.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception #include #include From 6dce793e36bae672b8a54cfd2a5b19469f9292ea Mon Sep 17 00:00:00 2001 From: Yuuichi Asahi Date: Tue, 12 Mar 2024 21:38:07 +0900 Subject: [PATCH 06/11] nvcc version to 11.0.0+ --- docs/intro/building.rst | 2 +- docs/intro/quick_start.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/intro/building.rst b/docs/intro/building.rst index 966975ec..d290da11 100644 --- a/docs/intro/building.rst +++ b/docs/intro/building.rst @@ -16,7 +16,7 @@ However, we have not tested all the listed compilers there and thus recommend th * ``gcc 8.3.0+`` - CPUs * ``IntelLLVM 2023.0.0+`` - CPUs, Intel GPUs -* ``nvcc 12.0.0+`` - NVIDIA GPUs +* ``nvcc 11.0.0+`` - NVIDIA GPUs * ``rocm 5.3.0+`` - AMD GPUs Install Kokkos-fft as a library diff --git a/docs/intro/quick_start.rst b/docs/intro/quick_start.rst index fed39759..0c6435c7 100644 --- a/docs/intro/quick_start.rst +++ b/docs/intro/quick_start.rst @@ -23,7 +23,7 @@ Here are list of compilers we frequently use for testing. * ``gcc 8.3.0+`` - CPUs * ``IntelLLVM 2023.0.0+`` - CPUs, Intel GPUs -* ``nvcc 12.0.0+`` - NVIDIA GPUs +* ``nvcc 11.0.0+`` - NVIDIA GPUs * ``rocm 5.3.0+`` - AMD GPUs Building From 678baea218751161c9c1d697fa58f9b8a76514c7 Mon Sep 17 00:00:00 2001 From: Yuuichi Asahi Date: Tue, 12 Mar 2024 21:55:35 +0900 Subject: [PATCH 07/11] licenses in two separate files --- ...ache-License-v2.0-with-LLVM-Exceptions.txt | 0 LICENSES/MIT-License.txt | 24 +++++++++++++++++++ 2 files changed, 24 insertions(+) rename LICENSE => LICENSES/Apache-License-v2.0-with-LLVM-Exceptions.txt (100%) create mode 100644 LICENSES/MIT-License.txt diff --git a/LICENSE b/LICENSES/Apache-License-v2.0-with-LLVM-Exceptions.txt similarity index 100% rename from LICENSE rename to LICENSES/Apache-License-v2.0-with-LLVM-Exceptions.txt diff --git a/LICENSES/MIT-License.txt b/LICENSES/MIT-License.txt new file mode 100644 index 00000000..c0723a62 --- /dev/null +++ b/LICENSES/MIT-License.txt @@ -0,0 +1,24 @@ +MIT License + + Copyright (c) 2023-2024 Centre national de la recherche scientifique (CNRS) + Copyright (c) 2023-2024 Commissariat a l'énergie atomique et aux énergies alternatives (CEA) + Copyright (c) 2023-2024 Université Paris-Saclay + Copyright (c) 2023-2024 Université de Versailles Saint-Quentin-en-Yvelines + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. \ No newline at end of file From 4ed4d36bf98ad4c7dcd8c957dd1b2b7bae7726a9 Mon Sep 17 00:00:00 2001 From: Yuuichi Asahi Date: Tue, 12 Mar 2024 21:56:38 +0900 Subject: [PATCH 08/11] update embeded license --- common/src/KokkosFFT_Helpers.hpp | 2 +- common/src/KokkosFFT_common_types.hpp | 2 +- common/src/KokkosFFT_normalization.hpp | 2 +- common/src/KokkosFFT_padding.hpp | 2 +- common/src/KokkosFFT_transpose.hpp | 2 +- common/src/KokkosFFT_utils.hpp | 2 +- common/unit_test/Test_Helpers.cpp | 2 +- common/unit_test/Test_Layouts.cpp | 2 +- common/unit_test/Test_Main.cpp | 4 ++-- common/unit_test/Test_Normalization.cpp | 2 +- common/unit_test/Test_Padding.cpp | 2 +- common/unit_test/Test_Transpose.cpp | 2 +- common/unit_test/Test_Types.hpp | 2 +- common/unit_test/Test_Utils.cpp | 2 +- common/unit_test/Test_Utils.hpp | 2 +- examples/01_1DFFT/01_1DFFT.cpp | 2 +- examples/02_2DFFT/02_2DFFT.cpp | 2 +- examples/03_NDFFT/03_NDFFT.cpp | 2 +- examples/04_batchedFFT/04_batchedFFT.cpp | 2 +- examples/05_1DFFT_HOST_DEVICE/05_1DFFT_HOST_DEVICE.cpp | 2 +- examples/06_1DFFT_reuse_plans/06_1DFFT_reuse_plans.cpp | 2 +- fft/perf_test/BenchmarkMain.cpp | 4 ++-- fft/perf_test/Benchmark_Context.hpp | 2 +- fft/perf_test/KokkosFFT_PrintConfiguration.hpp | 4 ++-- fft/perf_test/KokkosFFT_TplsVersion.hpp | 4 ++-- fft/perf_test/PerfTest_FFT1.cpp | 2 +- fft/perf_test/PerfTest_FFT1.hpp | 2 +- fft/perf_test/PerfTest_FFT2.cpp | 2 +- fft/perf_test/PerfTest_FFT2.hpp | 2 +- fft/src/KokkosFFT.hpp | 2 +- fft/src/KokkosFFT_Cuda_plans.hpp | 2 +- fft/src/KokkosFFT_Cuda_transform.hpp | 2 +- fft/src/KokkosFFT_Cuda_types.hpp | 2 +- fft/src/KokkosFFT_HIP_plans.hpp | 2 +- fft/src/KokkosFFT_HIP_transform.hpp | 2 +- fft/src/KokkosFFT_HIP_types.hpp | 2 +- fft/src/KokkosFFT_OpenMP_plans.hpp | 2 +- fft/src/KokkosFFT_OpenMP_transform.hpp | 2 +- fft/src/KokkosFFT_OpenMP_types.hpp | 2 +- fft/src/KokkosFFT_Plans.hpp | 2 +- fft/src/KokkosFFT_ROCM_plans.hpp | 2 +- fft/src/KokkosFFT_ROCM_transform.hpp | 2 +- fft/src/KokkosFFT_ROCM_types.hpp | 2 +- fft/src/KokkosFFT_SYCL_plans.hpp | 2 +- fft/src/KokkosFFT_SYCL_transform.hpp | 2 +- fft/src/KokkosFFT_SYCL_types.hpp | 2 +- fft/src/KokkosFFT_Transform.hpp | 2 +- fft/src/KokkosFFT_default_types.hpp | 2 +- fft/unit_test/Test_Main.cpp | 4 ++-- fft/unit_test/Test_Plans.cpp | 2 +- fft/unit_test/Test_Transform.cpp | 2 +- fft/unit_test/Test_Types.hpp | 2 +- fft/unit_test/Test_Utils.hpp | 2 +- 53 files changed, 58 insertions(+), 58 deletions(-) diff --git a/common/src/KokkosFFT_Helpers.hpp b/common/src/KokkosFFT_Helpers.hpp index c6d7fe8c..bbc06247 100644 --- a/common/src/KokkosFFT_Helpers.hpp +++ b/common/src/KokkosFFT_Helpers.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_HELPERS_HPP #define KOKKOSFFT_HELPERS_HPP diff --git a/common/src/KokkosFFT_common_types.hpp b/common/src/KokkosFFT_common_types.hpp index a8c4701b..7080a9d8 100644 --- a/common/src/KokkosFFT_common_types.hpp +++ b/common/src/KokkosFFT_common_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_COMMON_TYPES_HPP #define KOKKOSFFT_COMMON_TYPES_HPP diff --git a/common/src/KokkosFFT_normalization.hpp b/common/src/KokkosFFT_normalization.hpp index 9c77366f..273c4b05 100644 --- a/common/src/KokkosFFT_normalization.hpp +++ b/common/src/KokkosFFT_normalization.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_NORMALIZATION_HPP #define KOKKOSFFT_NORMALIZATION_HPP diff --git a/common/src/KokkosFFT_padding.hpp b/common/src/KokkosFFT_padding.hpp index f9daf79e..d220e5e5 100644 --- a/common/src/KokkosFFT_padding.hpp +++ b/common/src/KokkosFFT_padding.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_PADDING_HPP #define KOKKOSFFT_PADDING_HPP diff --git a/common/src/KokkosFFT_transpose.hpp b/common/src/KokkosFFT_transpose.hpp index 46bf2da9..9bcf4b87 100644 --- a/common/src/KokkosFFT_transpose.hpp +++ b/common/src/KokkosFFT_transpose.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_TRANSPOSE_HPP #define KOKKOSFFT_TRANSPOSE_HPP diff --git a/common/src/KokkosFFT_utils.hpp b/common/src/KokkosFFT_utils.hpp index e3b86ca6..6c869a95 100644 --- a/common/src/KokkosFFT_utils.hpp +++ b/common/src/KokkosFFT_utils.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_UTILS_HPP #define KOKKOSFFT_UTILS_HPP diff --git a/common/unit_test/Test_Helpers.cpp b/common/unit_test/Test_Helpers.cpp index 31a9b3dc..e3f8f9f3 100644 --- a/common/unit_test/Test_Helpers.cpp +++ b/common/unit_test/Test_Helpers.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/common/unit_test/Test_Layouts.cpp b/common/unit_test/Test_Layouts.cpp index ec0ddef6..9a3cb8f7 100644 --- a/common/unit_test/Test_Layouts.cpp +++ b/common/unit_test/Test_Layouts.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/common/unit_test/Test_Main.cpp b/common/unit_test/Test_Main.cpp index 4e736989..18fd3411 100644 --- a/common/unit_test/Test_Main.cpp +++ b/common/unit_test/Test_Main.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT //@HEADER // ************************************************************************ @@ -12,7 +12,7 @@ // // Part of Kokkos, under the Apache License v2.0 with LLVM Exceptions. // See https://kokkos.org/LICENSE for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT // //@HEADER #include diff --git a/common/unit_test/Test_Normalization.cpp b/common/unit_test/Test_Normalization.cpp index 5881edf8..ddf1a9fe 100644 --- a/common/unit_test/Test_Normalization.cpp +++ b/common/unit_test/Test_Normalization.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/common/unit_test/Test_Padding.cpp b/common/unit_test/Test_Padding.cpp index 562d1210..5957e615 100644 --- a/common/unit_test/Test_Padding.cpp +++ b/common/unit_test/Test_Padding.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/common/unit_test/Test_Transpose.cpp b/common/unit_test/Test_Transpose.cpp index b9e2da67..856a96a2 100644 --- a/common/unit_test/Test_Transpose.cpp +++ b/common/unit_test/Test_Transpose.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/common/unit_test/Test_Types.hpp b/common/unit_test/Test_Types.hpp index 024433f3..d327dd20 100644 --- a/common/unit_test/Test_Types.hpp +++ b/common/unit_test/Test_Types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef TEST_TYPES_HPP #define TEST_TYPES_HPP diff --git a/common/unit_test/Test_Utils.cpp b/common/unit_test/Test_Utils.cpp index d92ccdac..e431a8aa 100644 --- a/common/unit_test/Test_Utils.cpp +++ b/common/unit_test/Test_Utils.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include "KokkosFFT_utils.hpp" diff --git a/common/unit_test/Test_Utils.hpp b/common/unit_test/Test_Utils.hpp index b6710daa..35aea4f5 100644 --- a/common/unit_test/Test_Utils.hpp +++ b/common/unit_test/Test_Utils.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef TEST_UTILS_HPP #define TEST_UTILS_HPP diff --git a/examples/01_1DFFT/01_1DFFT.cpp b/examples/01_1DFFT/01_1DFFT.cpp index 0280ab43..701e400b 100644 --- a/examples/01_1DFFT/01_1DFFT.cpp +++ b/examples/01_1DFFT/01_1DFFT.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/examples/02_2DFFT/02_2DFFT.cpp b/examples/02_2DFFT/02_2DFFT.cpp index 5df61a4f..03a993df 100644 --- a/examples/02_2DFFT/02_2DFFT.cpp +++ b/examples/02_2DFFT/02_2DFFT.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/examples/03_NDFFT/03_NDFFT.cpp b/examples/03_NDFFT/03_NDFFT.cpp index ef2953e0..d3d163a6 100644 --- a/examples/03_NDFFT/03_NDFFT.cpp +++ b/examples/03_NDFFT/03_NDFFT.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/examples/04_batchedFFT/04_batchedFFT.cpp b/examples/04_batchedFFT/04_batchedFFT.cpp index d108efe9..c5342b5d 100644 --- a/examples/04_batchedFFT/04_batchedFFT.cpp +++ b/examples/04_batchedFFT/04_batchedFFT.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/examples/05_1DFFT_HOST_DEVICE/05_1DFFT_HOST_DEVICE.cpp b/examples/05_1DFFT_HOST_DEVICE/05_1DFFT_HOST_DEVICE.cpp index 03e16495..3e5ea5b6 100644 --- a/examples/05_1DFFT_HOST_DEVICE/05_1DFFT_HOST_DEVICE.cpp +++ b/examples/05_1DFFT_HOST_DEVICE/05_1DFFT_HOST_DEVICE.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/examples/06_1DFFT_reuse_plans/06_1DFFT_reuse_plans.cpp b/examples/06_1DFFT_reuse_plans/06_1DFFT_reuse_plans.cpp index 0dd32945..77daa555 100644 --- a/examples/06_1DFFT_reuse_plans/06_1DFFT_reuse_plans.cpp +++ b/examples/06_1DFFT_reuse_plans/06_1DFFT_reuse_plans.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/fft/perf_test/BenchmarkMain.cpp b/fft/perf_test/BenchmarkMain.cpp index 7b1bd0a6..fbae4bc1 100644 --- a/fft/perf_test/BenchmarkMain.cpp +++ b/fft/perf_test/BenchmarkMain.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT /* //@HEADER @@ -13,7 +13,7 @@ // // Part of Kokkos, under the Apache License v2.0 with LLVM Exceptions. // See https://kokkos.org/LICENSE for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT // //@HEADER */ diff --git a/fft/perf_test/Benchmark_Context.hpp b/fft/perf_test/Benchmark_Context.hpp index 3e889e09..1257c4e6 100644 --- a/fft/perf_test/Benchmark_Context.hpp +++ b/fft/perf_test/Benchmark_Context.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_BENCHMARK_CONTEXT_HPP #define KOKKOSFFT_BENCHMARK_CONTEXT_HPP diff --git a/fft/perf_test/KokkosFFT_PrintConfiguration.hpp b/fft/perf_test/KokkosFFT_PrintConfiguration.hpp index 95a1104f..425ebe15 100644 --- a/fft/perf_test/KokkosFFT_PrintConfiguration.hpp +++ b/fft/perf_test/KokkosFFT_PrintConfiguration.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT //@HEADER // ************************************************************************ @@ -12,7 +12,7 @@ // // Part of Kokkos, under the Apache License v2.0 with LLVM Exceptions. // See https://kokkos.org/LICENSE for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT // //@HEADER #ifndef KOKKOSFFT_PRINT_CONFIGURATION_HPP diff --git a/fft/perf_test/KokkosFFT_TplsVersion.hpp b/fft/perf_test/KokkosFFT_TplsVersion.hpp index c693143f..04ab0fcb 100644 --- a/fft/perf_test/KokkosFFT_TplsVersion.hpp +++ b/fft/perf_test/KokkosFFT_TplsVersion.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT //@HEADER // ************************************************************************ @@ -12,7 +12,7 @@ // // Part of Kokkos, under the Apache License v2.0 with LLVM Exceptions. // See https://kokkos.org/LICENSE for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT // //@HEADER #ifndef KOKKOSFFT_TPLS_VERSIONS_HPP diff --git a/fft/perf_test/PerfTest_FFT1.cpp b/fft/perf_test/PerfTest_FFT1.cpp index 349f4909..dc6a8666 100644 --- a/fft/perf_test/PerfTest_FFT1.cpp +++ b/fft/perf_test/PerfTest_FFT1.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include "PerfTest_FFT1.hpp" diff --git a/fft/perf_test/PerfTest_FFT1.hpp b/fft/perf_test/PerfTest_FFT1.hpp index 5d5f26cb..6ce65647 100644 --- a/fft/perf_test/PerfTest_FFT1.hpp +++ b/fft/perf_test/PerfTest_FFT1.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_PERFTEST_FFT1_HPP #define KOKKOSFFT_PERFTEST_FFT1_HPP diff --git a/fft/perf_test/PerfTest_FFT2.cpp b/fft/perf_test/PerfTest_FFT2.cpp index 5d3f016c..c7b4a58d 100644 --- a/fft/perf_test/PerfTest_FFT2.cpp +++ b/fft/perf_test/PerfTest_FFT2.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include "PerfTest_FFT2.hpp" diff --git a/fft/perf_test/PerfTest_FFT2.hpp b/fft/perf_test/PerfTest_FFT2.hpp index 6002ce3e..561931ce 100644 --- a/fft/perf_test/PerfTest_FFT2.hpp +++ b/fft/perf_test/PerfTest_FFT2.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_PERFTEST_FFT2_HPP #define KOKKOSFFT_PERFTEST_FFT2_HPP diff --git a/fft/src/KokkosFFT.hpp b/fft/src/KokkosFFT.hpp index 980d391c..969b8098 100644 --- a/fft/src/KokkosFFT.hpp +++ b/fft/src/KokkosFFT.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOS_FFT_HPP #define KOKKOS_FFT_HPP diff --git a/fft/src/KokkosFFT_Cuda_plans.hpp b/fft/src/KokkosFFT_Cuda_plans.hpp index dcc8e156..06c0681e 100644 --- a/fft/src/KokkosFFT_Cuda_plans.hpp +++ b/fft/src/KokkosFFT_Cuda_plans.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_CUDA_PLANS_HPP #define KOKKOSFFT_CUDA_PLANS_HPP diff --git a/fft/src/KokkosFFT_Cuda_transform.hpp b/fft/src/KokkosFFT_Cuda_transform.hpp index 52cd0001..56dac83f 100644 --- a/fft/src/KokkosFFT_Cuda_transform.hpp +++ b/fft/src/KokkosFFT_Cuda_transform.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_CUDA_TRANSFORM_HPP #define KOKKOSFFT_CUDA_TRANSFORM_HPP diff --git a/fft/src/KokkosFFT_Cuda_types.hpp b/fft/src/KokkosFFT_Cuda_types.hpp index 5a73e0c7..793a5c9d 100644 --- a/fft/src/KokkosFFT_Cuda_types.hpp +++ b/fft/src/KokkosFFT_Cuda_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_CUDA_TYPES_HPP #define KOKKOSFFT_CUDA_TYPES_HPP diff --git a/fft/src/KokkosFFT_HIP_plans.hpp b/fft/src/KokkosFFT_HIP_plans.hpp index 5b3b007f..d9f322bd 100644 --- a/fft/src/KokkosFFT_HIP_plans.hpp +++ b/fft/src/KokkosFFT_HIP_plans.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_HIP_PLANS_HPP #define KOKKOSFFT_HIP_PLANS_HPP diff --git a/fft/src/KokkosFFT_HIP_transform.hpp b/fft/src/KokkosFFT_HIP_transform.hpp index 2dccdde1..0fda21d3 100644 --- a/fft/src/KokkosFFT_HIP_transform.hpp +++ b/fft/src/KokkosFFT_HIP_transform.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_HIP_TRANSFORM_HPP #define KOKKOSFFT_HIP_TRANSFORM_HPP diff --git a/fft/src/KokkosFFT_HIP_types.hpp b/fft/src/KokkosFFT_HIP_types.hpp index 590b0487..eee2edcf 100644 --- a/fft/src/KokkosFFT_HIP_types.hpp +++ b/fft/src/KokkosFFT_HIP_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_HIP_TYPES_HPP #define KOKKOSFFT_HIP_TYPES_HPP diff --git a/fft/src/KokkosFFT_OpenMP_plans.hpp b/fft/src/KokkosFFT_OpenMP_plans.hpp index 4dfd3eb0..4900b167 100644 --- a/fft/src/KokkosFFT_OpenMP_plans.hpp +++ b/fft/src/KokkosFFT_OpenMP_plans.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_OPENMP_PLANS_HPP #define KOKKOSFFT_OPENMP_PLANS_HPP diff --git a/fft/src/KokkosFFT_OpenMP_transform.hpp b/fft/src/KokkosFFT_OpenMP_transform.hpp index 9f4da510..2fde13d8 100644 --- a/fft/src/KokkosFFT_OpenMP_transform.hpp +++ b/fft/src/KokkosFFT_OpenMP_transform.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_OPENMP_TRANSFORM_HPP #define KOKKOSFFT_OPENMP_TRANSFORM_HPP diff --git a/fft/src/KokkosFFT_OpenMP_types.hpp b/fft/src/KokkosFFT_OpenMP_types.hpp index 75731c35..ab717749 100644 --- a/fft/src/KokkosFFT_OpenMP_types.hpp +++ b/fft/src/KokkosFFT_OpenMP_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_OPENMP_TYPES_HPP #define KOKKOSFFT_OPENMP_TYPES_HPP diff --git a/fft/src/KokkosFFT_Plans.hpp b/fft/src/KokkosFFT_Plans.hpp index fa22ba7b..8e1a656c 100644 --- a/fft/src/KokkosFFT_Plans.hpp +++ b/fft/src/KokkosFFT_Plans.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT /// \file KokkosFFT_Plans.hpp /// \brief Wrapping fft plans of different fft libraries diff --git a/fft/src/KokkosFFT_ROCM_plans.hpp b/fft/src/KokkosFFT_ROCM_plans.hpp index 1b6c5c7b..99e3cb5c 100644 --- a/fft/src/KokkosFFT_ROCM_plans.hpp +++ b/fft/src/KokkosFFT_ROCM_plans.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_ROCM_PLANS_HPP #define KOKKOSFFT_ROCM_PLANS_HPP diff --git a/fft/src/KokkosFFT_ROCM_transform.hpp b/fft/src/KokkosFFT_ROCM_transform.hpp index 194929b5..0746fd93 100644 --- a/fft/src/KokkosFFT_ROCM_transform.hpp +++ b/fft/src/KokkosFFT_ROCM_transform.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_ROCM_TRANSFORM_HPP #define KOKKOSFFT_ROCM_TRANSFORM_HPP diff --git a/fft/src/KokkosFFT_ROCM_types.hpp b/fft/src/KokkosFFT_ROCM_types.hpp index a377a740..c1569c41 100644 --- a/fft/src/KokkosFFT_ROCM_types.hpp +++ b/fft/src/KokkosFFT_ROCM_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_ROCM_TYPES_HPP #define KOKKOSFFT_ROCM_TYPES_HPP diff --git a/fft/src/KokkosFFT_SYCL_plans.hpp b/fft/src/KokkosFFT_SYCL_plans.hpp index 642963d9..91f8e7f9 100644 --- a/fft/src/KokkosFFT_SYCL_plans.hpp +++ b/fft/src/KokkosFFT_SYCL_plans.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_SYCL_PLANS_HPP #define KOKKOSFFT_SYCL_PLANS_HPP diff --git a/fft/src/KokkosFFT_SYCL_transform.hpp b/fft/src/KokkosFFT_SYCL_transform.hpp index 7c7dafce..353b2050 100644 --- a/fft/src/KokkosFFT_SYCL_transform.hpp +++ b/fft/src/KokkosFFT_SYCL_transform.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_SYCL_TRANSFORM_HPP #define KOKKOSFFT_SYCL_TRANSFORM_HPP diff --git a/fft/src/KokkosFFT_SYCL_types.hpp b/fft/src/KokkosFFT_SYCL_types.hpp index 898cb8ad..b7cd1e52 100644 --- a/fft/src/KokkosFFT_SYCL_types.hpp +++ b/fft/src/KokkosFFT_SYCL_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_SYCL_TYPES_HPP #define KOKKOSFFT_SYCL_TYPES_HPP diff --git a/fft/src/KokkosFFT_Transform.hpp b/fft/src/KokkosFFT_Transform.hpp index 372b8021..14a5a69e 100644 --- a/fft/src/KokkosFFT_Transform.hpp +++ b/fft/src/KokkosFFT_Transform.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_TRANSFORM_HPP #define KOKKOSFFT_TRANSFORM_HPP diff --git a/fft/src/KokkosFFT_default_types.hpp b/fft/src/KokkosFFT_default_types.hpp index ecf8f343..7a08a313 100644 --- a/fft/src/KokkosFFT_default_types.hpp +++ b/fft/src/KokkosFFT_default_types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef KOKKOSFFT_DEFAULT_TYPES_HPP #define KOKKOSFFT_DEFAULT_TYPES_HPP diff --git a/fft/unit_test/Test_Main.cpp b/fft/unit_test/Test_Main.cpp index 4e736989..18fd3411 100644 --- a/fft/unit_test/Test_Main.cpp +++ b/fft/unit_test/Test_Main.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT //@HEADER // ************************************************************************ @@ -12,7 +12,7 @@ // // Part of Kokkos, under the Apache License v2.0 with LLVM Exceptions. // See https://kokkos.org/LICENSE for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT // //@HEADER #include diff --git a/fft/unit_test/Test_Plans.cpp b/fft/unit_test/Test_Plans.cpp index f049d7ac..b1b45ed8 100644 --- a/fft/unit_test/Test_Plans.cpp +++ b/fft/unit_test/Test_Plans.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include "KokkosFFT_Plans.hpp" diff --git a/fft/unit_test/Test_Transform.cpp b/fft/unit_test/Test_Transform.cpp index 03702c56..07ee9d3c 100644 --- a/fft/unit_test/Test_Transform.cpp +++ b/fft/unit_test/Test_Transform.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/fft/unit_test/Test_Types.hpp b/fft/unit_test/Test_Types.hpp index b68322b2..fae2d38c 100644 --- a/fft/unit_test/Test_Types.hpp +++ b/fft/unit_test/Test_Types.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef TEST_TYPES_HPP #define TEST_TYPES_HPP diff --git a/fft/unit_test/Test_Utils.hpp b/fft/unit_test/Test_Utils.hpp index 53435fad..fb64754c 100644 --- a/fft/unit_test/Test_Utils.hpp +++ b/fft/unit_test/Test_Utils.hpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #ifndef TEST_UTILS_HPP #define TEST_UTILS_HPP From 05b947b0d291cff30866d23d2983a617ff830d71 Mon Sep 17 00:00:00 2001 From: Yuuichi Asahi Date: Tue, 12 Mar 2024 22:05:23 +0900 Subject: [PATCH 09/11] update license badge --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f3e45fb7..2a22ad52 100644 --- a/README.md +++ b/README.md @@ -127,5 +127,6 @@ cmake --build build -j 8 This way, all the functionalities are executed on A100 GPUs. For installation, details are provided in the [documentation](https://kokkosfft.readthedocs.io/en/latest/intro/building.html#install-kokkosfft-as-a-library). ## LICENCE -[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -Kokkos-fft is under the Apache License v2.0 with LLVM Exceptions. \ No newline at end of file +[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +Kokkos-fft is under the Apache License v2.0 with LLVM Exceptions or the MIT License. \ No newline at end of file From 1727343efd3ebdfbdcd9f004d57851f6b77ee5c0 Mon Sep 17 00:00:00 2001 From: Yuuichi Asahi Date: Tue, 12 Mar 2024 22:18:23 +0900 Subject: [PATCH 10/11] embed licenses in files for install_test --- install_test/as_library/hello.cpp | 2 +- install_test/as_subdirectory/hello.cpp | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/install_test/as_library/hello.cpp b/install_test/as_library/hello.cpp index 0280ab43..701e400b 100644 --- a/install_test/as_library/hello.cpp +++ b/install_test/as_library/hello.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include diff --git a/install_test/as_subdirectory/hello.cpp b/install_test/as_subdirectory/hello.cpp index 5df61a4f..03a993df 100644 --- a/install_test/as_subdirectory/hello.cpp +++ b/install_test/as_subdirectory/hello.cpp @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT #include #include From a6b1f7fb999bd5b53d1eb8140ba34335338e8736 Mon Sep 17 00:00:00 2001 From: Julien Bigot Date: Tue, 12 Mar 2024 17:45:26 +0100 Subject: [PATCH 11/11] Follow reuse spec --- .clang-format | 7 +- .github/workflows/__build_base.yaml | 14 +- .github/workflows/__check_docker_files.yaml | 4 + .github/workflows/build_test.yaml | 32 +- .github/workflows/cleanup_base.yaml | 6 +- .github/workflows/pre_build_base.yaml | 4 + .github/workflows/reuse.yml | 15 + .gitignore | 4 + .gitmodules | 4 + .readthedocs.yaml | 4 + AUTHORS | 8 +- CMakeLists.txt | 4 + COPYRIGHT.md | 19 + LICENSES/Apache-2.0.txt | 73 + ...ache-License-v2.0-with-LLVM-Exceptions.txt | 236 - LICENSES/BSD-3-Clause.txt | 11 + LICENSES/CC0-1.0.txt | 121 + LICENSES/LLVM-exception.txt | 15 + LICENSES/MIT-License.txt | 24 - LICENSES/MIT.txt | 9 + README.md | 10 +- cmake/FindFFTW.cmake | 40 +- cmake/FindSphinx.cmake | 22 +- cmake/KokkosFFTConfig.cmake.in | 4 + cmake/KokkosFFT_Git_Hash.cmake | 4 + cmake/KokkosFFT_Version_Info.hpp.in | 17 +- cmake/KokkosFFT_config.h.in | 6 +- cmake/KokkosFFT_tpls.cmake | 4 + common/CMakeLists.txt | 4 + common/src/CMakeLists.txt | 4 + common/src/KokkosFFT_Helpers.hpp | 4 +- common/src/KokkosFFT_common_types.hpp | 4 +- common/src/KokkosFFT_layouts.hpp | 6 +- common/src/KokkosFFT_normalization.hpp | 4 +- common/src/KokkosFFT_padding.hpp | 4 +- common/src/KokkosFFT_transpose.hpp | 4 +- common/src/KokkosFFT_utils.hpp | 4 +- common/unit_test/CMakeLists.txt | 4 + common/unit_test/Test_Helpers.cpp | 4 +- common/unit_test/Test_Layouts.cpp | 4 +- common/unit_test/Test_Main.cpp | 22 +- common/unit_test/Test_Normalization.cpp | 4 +- common/unit_test/Test_Padding.cpp | 4 +- common/unit_test/Test_Transpose.cpp | 4 +- common/unit_test/Test_Types.hpp | 4 +- common/unit_test/Test_Utils.cpp | 4 +- common/unit_test/Test_Utils.hpp | 4 +- docker/gcc/Dockerfile | 4 + docker/intel/Dockerfile | 4 + docker/nvcc/Dockerfile | 4 + docker/rocm/Dockerfile | 4 + docs/CMakeLists.txt | 108 +- docs/Doxyfile.in | 5136 +++++++++-------- docs/Makefile | 4 + docs/api/helper/fftfreq.rst | 3 + docs/api/helper/fftshift.rst | 3 + docs/api/helper/ifftshift.rst | 3 + docs/api/helper/rfftfreq.rst | 3 + docs/api/hermitian/hfft.rst | 3 + docs/api/hermitian/ihfft.rst | 3 + docs/api/plan.rst | 3 + docs/api/real/irfft.rst | 3 + docs/api/real/irfft2.rst | 3 + docs/api/real/irfftn.rst | 3 + docs/api/real/rfft.rst | 3 + docs/api/real/rfft2.rst | 3 + docs/api/real/rfftn.rst | 3 + docs/api/standard/fft.rst | 3 + docs/api/standard/fft2.rst | 3 + docs/api/standard/fftn.rst | 3 + docs/api/standard/ifft.rst | 3 + docs/api/standard/ifft2.rst | 3 + docs/api/standard/ifftn.rst | 3 + docs/api_reference.rst | 4 + docs/conf.py | 218 +- docs/examples.rst | 4 + docs/finding_libraries.rst | 4 + docs/getting_started.rst | 4 + docs/index.rst | 131 +- docs/intro/building.rst | 4 + docs/intro/quick_start.rst | 4 + docs/intro/using.rst | 4 + docs/requirements.txt | 4 + docs/samples/01_1DFFT.rst | 4 + docs/samples/02_2DFFT.rst | 4 + docs/samples/03_NDFFT.rst | 4 + docs/samples/04_batchedFFT.rst | 4 + docs/samples/05_1DFFT_HOST_DEVICE.rst | 4 + docs/samples/06_1DFFT_reuse_plans.rst | 4 + examples/01_1DFFT/01_1DFFT.cpp | 4 +- examples/01_1DFFT/CMakeLists.txt | 4 + examples/01_1DFFT/numpy_1DFFT.py | 4 + examples/02_2DFFT/02_2DFFT.cpp | 4 +- examples/02_2DFFT/CMakeLists.txt | 4 + examples/02_2DFFT/numpy_2DFFT.py | 4 + examples/03_NDFFT/03_NDFFT.cpp | 4 +- examples/03_NDFFT/CMakeLists.txt | 4 + examples/03_NDFFT/numpy_NDFFT.py | 4 + examples/04_batchedFFT/04_batchedFFT.cpp | 4 +- examples/04_batchedFFT/CMakeLists.txt | 4 + examples/04_batchedFFT/numpy_batchedFFT.py | 4 + .../05_1DFFT_HOST_DEVICE.cpp | 4 +- examples/05_1DFFT_HOST_DEVICE/CMakeLists.txt | 4 + examples/05_1DFFT_HOST_DEVICE/numpy_1DFFT.py | 4 + .../06_1DFFT_reuse_plans.cpp | 4 +- examples/06_1DFFT_reuse_plans/CMakeLists.txt | 4 + examples/06_1DFFT_reuse_plans/numpy_1DFFT.py | 4 + examples/CMakeLists.txt | 4 + fft/CMakeLists.txt | 4 + fft/perf_test/BenchmarkMain.cpp | 23 +- fft/perf_test/Benchmark_Context.hpp | 4 +- fft/perf_test/CMakeLists.txt | 4 + .../KokkosFFT_PrintConfiguration.hpp | 22 +- fft/perf_test/KokkosFFT_TplsVersion.hpp | 22 +- fft/perf_test/PerfTest_FFT1.cpp | 4 +- fft/perf_test/PerfTest_FFT1.hpp | 4 +- fft/perf_test/PerfTest_FFT2.cpp | 4 +- fft/perf_test/PerfTest_FFT2.hpp | 4 +- fft/src/CMakeLists.txt | 4 + fft/src/KokkosFFT.hpp | 4 +- fft/src/KokkosFFT_Cuda_plans.hpp | 4 +- fft/src/KokkosFFT_Cuda_transform.hpp | 4 +- fft/src/KokkosFFT_Cuda_types.hpp | 4 +- fft/src/KokkosFFT_HIP_plans.hpp | 4 +- fft/src/KokkosFFT_HIP_transform.hpp | 4 +- fft/src/KokkosFFT_HIP_types.hpp | 4 +- fft/src/KokkosFFT_OpenMP_plans.hpp | 4 +- fft/src/KokkosFFT_OpenMP_transform.hpp | 4 +- fft/src/KokkosFFT_OpenMP_types.hpp | 4 +- fft/src/KokkosFFT_Plans.hpp | 4 +- fft/src/KokkosFFT_ROCM_plans.hpp | 4 +- fft/src/KokkosFFT_ROCM_transform.hpp | 4 +- fft/src/KokkosFFT_ROCM_types.hpp | 4 +- fft/src/KokkosFFT_SYCL_plans.hpp | 4 +- fft/src/KokkosFFT_SYCL_transform.hpp | 4 +- fft/src/KokkosFFT_SYCL_types.hpp | 4 +- fft/src/KokkosFFT_Transform.hpp | 4 +- fft/src/KokkosFFT_default_types.hpp | 4 +- fft/unit_test/CMakeLists.txt | 4 + fft/unit_test/Test_Main.cpp | 22 +- fft/unit_test/Test_Plans.cpp | 4 +- fft/unit_test/Test_Transform.cpp | 4 +- fft/unit_test/Test_Types.hpp | 4 +- fft/unit_test/Test_Utils.hpp | 4 +- install_test/as_library/CMakeLists.txt | 4 + install_test/as_library/hello.cpp | 4 +- install_test/as_subdirectory/CMakeLists.txt | 4 + install_test/as_subdirectory/hello.cpp | 4 +- 148 files changed, 3580 insertions(+), 3272 deletions(-) create mode 100644 .github/workflows/reuse.yml create mode 100644 COPYRIGHT.md create mode 100644 LICENSES/Apache-2.0.txt delete mode 100644 LICENSES/Apache-License-v2.0-with-LLVM-Exceptions.txt create mode 100644 LICENSES/BSD-3-Clause.txt create mode 100644 LICENSES/CC0-1.0.txt create mode 100644 LICENSES/LLVM-exception.txt delete mode 100644 LICENSES/MIT-License.txt create mode 100644 LICENSES/MIT.txt diff --git a/.clang-format b/.clang-format index 6048a76d..7729ac95 100644 --- a/.clang-format +++ b/.clang-format @@ -1,5 +1,10 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + BasedOnStyle: google SortIncludes: false AlignConsecutiveAssignments: true AllowShortCaseLabelsOnASingleLine: true -AllowShortIfStatementsOnASingleLine: true \ No newline at end of file +AllowShortIfStatementsOnASingleLine: true +CommentPragmas: ' SPDX-' diff --git a/.github/workflows/__build_base.yaml b/.github/workflows/__build_base.yaml index 1767d599..744732e0 100644 --- a/.github/workflows/__build_base.yaml +++ b/.github/workflows/__build_base.yaml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + # Generate base images for each compiler environment. Images are stored on # Github registry as Docker format inconditionnaly and as Singularity format # only if requested. Docker images are used for building Kokkos FFT, while @@ -66,19 +70,19 @@ jobs: - name: Build Docker image run: | docker build \ - -t ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.image.name }}_${{ inputs.image_suffix }}:${{ inputs.image_tag }} \ - --cache-from ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.image.name }}_main:latest \ + -t ghcr.io/kokkos/kokkos-fft/base_${{ matrix.image.name }}_${{ inputs.image_suffix }}:${{ inputs.image_tag }} \ + --cache-from ghcr.io/kokkos/kokkos-fft/base_${{ matrix.image.name }}_main:latest \ --build-arg BUILDKIT_INLINE_CACHE=1 \ --progress=plain \ docker/${{ matrix.image.name }} - name: Push Docker image - run: docker push ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.image.name }}_${{ inputs.image_suffix }}:${{ inputs.image_tag }} + run: docker push ghcr.io/kokkos/kokkos-fft/base_${{ matrix.image.name }}_${{ inputs.image_suffix }}:${{ inputs.image_tag }} - name: Convert Docker image to Singularity - run: singularity build base.sif docker://ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.image.name }}_${{ inputs.image_suffix }}:${{ inputs.image_tag }} + run: singularity build base.sif docker://ghcr.io/kokkos/kokkos-fft/base_${{ matrix.image.name }}_${{ inputs.image_suffix }}:${{ inputs.image_tag }} if: ${{ matrix.image.use_singularity }} - name: Push Singularity image - run: singularity push base.sif oras://ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.image.name }}_singularity_${{ inputs.image_suffix }}:${{ inputs.image_tag }} + run: singularity push base.sif oras://ghcr.io/kokkos/kokkos-fft/base_${{ matrix.image.name }}_singularity_${{ inputs.image_suffix }}:${{ inputs.image_tag }} if: ${{ matrix.image.use_singularity }} diff --git a/.github/workflows/__check_docker_files.yaml b/.github/workflows/__check_docker_files.yaml index 5d1119d2..9b374570 100644 --- a/.github/workflows/__check_docker_files.yaml +++ b/.github/workflows/__check_docker_files.yaml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + # Check if Docker images have changed. In that case, proposes images suffix and # tag. diff --git a/.github/workflows/build_test.yaml b/.github/workflows/build_test.yaml index 354bcf2a..106c59e6 100644 --- a/.github/workflows/build_test.yaml +++ b/.github/workflows/build_test.yaml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + # Build and test Kokkos FFT using Docker and Singularity images. Pre-generated # images are pulled from Github registry; they are updated only if the current # PR or commit modified the Docker files. @@ -153,7 +157,7 @@ jobs: - name: Configure run: | - docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v ${{ github.workspace }}:/work ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ cmake -B build \ -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \ -DCMAKE_C_COMPILER=${{ matrix.backend.compiler.c }} \ @@ -169,7 +173,7 @@ jobs: - name: Build run: | - docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v ${{ github.workspace }}:/work ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ cmake --build build -j $(( $(nproc) * 2 + 1 )) - name: Prepare artifacts @@ -203,7 +207,7 @@ jobs: - name: Configure and build test project as subdirectory run: | - docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v ${{ github.workspace }}:/work ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ cmake -B install_test/as_subdirectory/build \ -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \ -DCMAKE_C_COMPILER=${{ matrix.backend.compiler.c }} \ @@ -213,12 +217,12 @@ jobs: ${{ matrix.backend.cmake_flags.kokkos_fft }} \ ${{ matrix.target.cmake_flags }} \ install_test/as_subdirectory - docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v ${{ github.workspace }}:/work ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ cmake --build install_test/as_subdirectory/build - name: Configure, build and install Kokkos as library run: | - docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v ${{ github.workspace }}:/work ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ cmake -B build_kokkos \ -DCMAKE_INSTALL_PREFIX=/work/install \ -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \ @@ -227,14 +231,14 @@ jobs: -DCMAKE_CXX_STANDARD=17 \ ${{ matrix.backend.cmake_flags.kokkos }} \ tpls/kokkos - docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v ${{ github.workspace }}:/work ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ cmake --build build_kokkos -j $(( $(nproc) * 2 + 1 )) - docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v ${{ github.workspace }}:/work ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ cmake --install build_kokkos - name: Configure, build and install KokkosFFT as library run: | - docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v ${{ github.workspace }}:/work ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ cmake -B build_kokkos_fft \ -DCMAKE_INSTALL_PREFIX=/work/install\ -DCMAKE_PREFIX_PATH=/work/install \ @@ -244,14 +248,14 @@ jobs: -DCMAKE_CXX_STANDARD=17 \ ${{ matrix.backend.cmake_flags.kokkos_fft }} \ ${{ matrix.target.cmake_flags }} - docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v ${{ github.workspace }}:/work ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ cmake --build build_kokkos_fft -j $(( $(nproc) * 2 + 1 )) - docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v ${{ github.workspace }}:/work ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ cmake --install build_kokkos_fft - name: Configure and build test project as library run: | - docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v ${{ github.workspace }}:/work ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ cmake -B install_test/as_library/build \ -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \ -DCMAKE_PREFIX_PATH=/work/install \ @@ -259,7 +263,7 @@ jobs: -DCMAKE_CXX_COMPILER=${{ matrix.backend.compiler.cxx }} \ -DCMAKE_CXX_STANDARD=17 \ install_test/as_library - docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v ${{ github.workspace }}:/work ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ cmake --build install_test/as_library/build -j $(( $(nproc) * 2 + 1 )) # test the project @@ -305,7 +309,7 @@ jobs: - name: Pull Singularity image # pulling the image in advance seems necessary as sometimes invoking `singularity run` on the image URL fails because it cannot find ghcr.io - run: singularity pull oras://ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_singularity_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} + run: singularity pull oras://ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_singularity_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} if: ${{ matrix.backend.name == 'cuda' }} - name: Run CUDA tests within Slurm job and Singularity image @@ -317,6 +321,6 @@ jobs: - name: Run OpenMP/Threads/Serial tests within Docker image run: | - docker run -v $PWD/build:/work/build -w /work/build ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ + docker run -v $PWD/build:/work/build -w /work/build ghcr.io/kokkos/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \ ctest --output-on-failure if: ${{ matrix.backend.name == 'openmp' || matrix.backend.name == 'threads' || matrix.backend.name == 'serial' }} diff --git a/.github/workflows/cleanup_base.yaml b/.github/workflows/cleanup_base.yaml index d79eb484..d2acdc0d 100644 --- a/.github/workflows/cleanup_base.yaml +++ b/.github/workflows/cleanup_base.yaml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + # Clean old Docker and Singularity images that are too old periodically or # manually. @@ -16,7 +20,7 @@ jobs: - name: Cleanup old images uses: SmartsquareGmbH/delete-old-packages@v0.7.0 with: - organization: cexa-project + organization: kokkos type: container names: | kokkos-fft/base_nvcc_main diff --git a/.github/workflows/pre_build_base.yaml b/.github/workflows/pre_build_base.yaml index 091b0e73..21b8a49c 100644 --- a/.github/workflows/pre_build_base.yaml +++ b/.github/workflows/pre_build_base.yaml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + # Recreate the base images inconditionnaly on periodically or manually and on # push on the main branch. This is to ensure that anybody using the Docker # files for local development does not encounter weird bugs unnoticed by the diff --git a/.github/workflows/reuse.yml b/.github/workflows/reuse.yml new file mode 100644 index 00000000..c4002dd7 --- /dev/null +++ b/.github/workflows/reuse.yml @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: 2022 Free Software Foundation Europe e.V. +# +# SPDX-License-Identifier: CC0-1.0 + +name: REUSE Compliance Check + +on: [push, pull_request] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: REUSE Compliance Check + uses: fsfe/reuse-action@v3 diff --git a/.gitignore b/.gitignore index 259148fa..cc211608 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + # Prerequisites *.d diff --git a/.gitmodules b/.gitmodules index 1bff3dde..2fc7ee6c 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + [submodule "tpls/kokkos"] path = tpls/kokkos url = https://github.com/kokkos/kokkos.git diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 3108bfb5..37cb89ef 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + # .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details diff --git a/AUTHORS b/AUTHORS index f42c3a49..c6207ee6 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,3 +1,6 @@ +SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + Multiple people have contributed to kokkos-fft. To show our appreciation for their public spirit, we list here in alphabetical order a condensed list of their contributions. @@ -8,7 +11,10 @@ Yuuichi Asahi - CEA (yuuichi.asahi(at)cea.fr) * Initial designer and first development steps * Developer +Julien Bigot - CEA (julien.bigot@cea.fr) +* Licensing info + Paul Zehner - CEA (paul.Zehner(at)cea.fr) * Co-maintainer * CI/CD -* Developer \ No newline at end of file +* Developer diff --git a/CMakeLists.txt b/CMakeLists.txt index e9a46f16..1060d505 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + cmake_minimum_required(VERSION 3.22) set(KOKKOSFFT_TOP_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}) diff --git a/COPYRIGHT.md b/COPYRIGHT.md new file mode 100644 index 00000000..54ff3700 --- /dev/null +++ b/COPYRIGHT.md @@ -0,0 +1,19 @@ + + +The Kokkos-FFT project licencing information follows the REUSE specification. + +It is distributed under either: +* the MIT License whose full text is available in the LICENSES/MIT.txt file, +or, at your option, +* the Apache-2.0 licence with LLVM exception whose full text is available in + the LICENSES/Apache-2.0.txt and LICENSES/LLVM-exception.txt files. + +For the purpose of copyright, the Kokkos-FFT development team is defined as follow: +* Centre national de la recherche scientifique (CNRS) +* Commissariat a l'énergie atomique et aux énergies alternatives (CEA) +* Université Paris-Saclay +* Université de Versailles Saint-Quentin-en-Yvelines (UVSQ) diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt new file mode 100644 index 00000000..137069b8 --- /dev/null +++ b/LICENSES/Apache-2.0.txt @@ -0,0 +1,73 @@ +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. + +"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: + + (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. + + You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + +To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSES/Apache-License-v2.0-with-LLVM-Exceptions.txt b/LICENSES/Apache-License-v2.0-with-LLVM-Exceptions.txt deleted file mode 100644 index 1e7a7e5e..00000000 --- a/LICENSES/Apache-License-v2.0-with-LLVM-Exceptions.txt +++ /dev/null @@ -1,236 +0,0 @@ -*************************************************************************************** - - Kokkos-fft v. 0.1 -Copyright (c) 2024 Centre national de la recherche scientifique (CNRS) -Copyright (c) 2024 Commissariat a l'énergie atomique et aux énergies alternatives (CEA) -Copyright (c) 2024 Université Paris-Saclay -Copyright (c) 2024 Université de Versailles Saint-Quentin-en-Yvelines - -============================================================================== -Kokkos-fft is under the Apache License v2.0 with LLVM Exceptions: -============================================================================== - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS Apache 2.0 - ----- LLVM Exceptions to the Apache 2.0 License ---- - -As an exception, if, as a result of your compiling your source code, portions -of this Software are embedded into an Object form of such source code, you -may redistribute such embedded portions in such Object form without complying -with the conditions of Sections 4(a), 4(b) and 4(d) of the License. - -In addition, if you combine or link compiled forms of this Software with -software that is licensed under the GPLv2 ("Combined Software") and if a -court of competent jurisdiction determines that the patent provision (Section -3), the indemnity provision (Section 9) or other Section of the License -conflicts with the conditions of the GPLv2, you may retroactively and -prospectively choose to deem waived or otherwise exclude such Section(s) of -the License, but only in their entirety and only with respect to the Combined -Software. - -============================================================================== -Software from third parties included in Kokkos-fft: -============================================================================== - -Kokkos contains third party software which is under different license -terms. All such code will be identified clearly using at least one of two -mechanisms: -1) It will be in a separate directory tree with its own `LICENSE.txt` or -`LICENSE` file at the top containing the specific license and restrictions -which apply to that software, or -2) It will contain specific license and restriction terms at the top of every -file. - - -THIS SOFTWARE IS PROVIDED BY NTESS "AS IS" AND ANY -EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NTESS OR THE -CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, -EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, -PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR -PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF -LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING -NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -Questions? Contact: -Yuuichi Asahi (yuuichi.asahi(at)cea.fr) -Paul Zehner (paul.Zehner(at)cea.fr) - -*************************************************************************************** \ No newline at end of file diff --git a/LICENSES/BSD-3-Clause.txt b/LICENSES/BSD-3-Clause.txt new file mode 100644 index 00000000..ea890afb --- /dev/null +++ b/LICENSES/BSD-3-Clause.txt @@ -0,0 +1,11 @@ +Copyright (c) . + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 00000000..0e259d42 --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/LICENSES/LLVM-exception.txt b/LICENSES/LLVM-exception.txt new file mode 100644 index 00000000..fa4b725a --- /dev/null +++ b/LICENSES/LLVM-exception.txt @@ -0,0 +1,15 @@ +---- LLVM Exceptions to the Apache 2.0 License ---- + + As an exception, if, as a result of your compiling your source code, portions + of this Software are embedded into an Object form of such source code, you + may redistribute such embedded portions in such Object form without complying + with the conditions of Sections 4(a), 4(b) and 4(d) of the License. + + In addition, if you combine or link compiled forms of this Software with + software that is licensed under the GPLv2 ("Combined Software") and if a + court of competent jurisdiction determines that the patent provision (Section + 3), the indemnity provision (Section 9) or other Section of the License + conflicts with the conditions of the GPLv2, you may retroactively and + prospectively choose to deem waived or otherwise exclude such Section(s) of + the License, but only in their entirety and only with respect to the Combined + Software. diff --git a/LICENSES/MIT-License.txt b/LICENSES/MIT-License.txt deleted file mode 100644 index c0723a62..00000000 --- a/LICENSES/MIT-License.txt +++ /dev/null @@ -1,24 +0,0 @@ -MIT License - - Copyright (c) 2023-2024 Centre national de la recherche scientifique (CNRS) - Copyright (c) 2023-2024 Commissariat a l'énergie atomique et aux énergies alternatives (CEA) - Copyright (c) 2023-2024 Université Paris-Saclay - Copyright (c) 2023-2024 Université de Versailles Saint-Quentin-en-Yvelines - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to deal - in the Software without restriction, including without limitation the rights - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE. \ No newline at end of file diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 00000000..2071b23b --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 2a22ad52..1e1bf687 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ + + # kokkos-fft [![CI](https://github.com/kokkos/kokkos-fft/actions/workflows/build_test.yaml/badge.svg)](https://github.com/kokkos/kokkos-fft/actions) @@ -128,5 +134,5 @@ This way, all the functionalities are executed on A100 GPUs. For installation, d ## LICENCE [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -Kokkos-fft is under the Apache License v2.0 with LLVM Exceptions or the MIT License. \ No newline at end of file +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +Kokkos-FFT is distributed under either the MIT license, or at your option, the Apache-2.0 licence with LLVM exception. diff --git a/cmake/FindFFTW.cmake b/cmake/FindFFTW.cmake index 6e00529a..8c35b0e4 100644 --- a/cmake/FindFFTW.cmake +++ b/cmake/FindFFTW.cmake @@ -1,42 +1,10 @@ -################################################################################ -# Copyright (c) 2015, Wenzel Jakob; 2017, Patrick Bos -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# * Redistributions of source code must retain the above copyright notice, this -# list of conditions and the following disclaimer. -# -# * Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# * Neither the name of the copyright holder nor the names of its -# contributors may be used to endorse or promote products derived from -# this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -################################################################################ - +# SPDX-FileCopyrightText: (C) 2015 Wenzel Jakob +# SPDX-FileCopyrightText: (C) 2015 Patrick Bos +# +# SPDX-License-Identifier: BSD-3-Clause # - Find the FFTW library # -# Original version of this file: -# Copyright (c) 2015, Wenzel Jakob -# https://github.com/wjakob/layerlab/blob/master/cmake/FindFFTW.cmake, commit 4d58bfdc28891b4f9373dfe46239dda5a0b561c6 -# Modifications: -# Copyright (c) 2017, Patrick Bos -# # Usage: # find_package(FFTW [REQUIRED] [QUIET] [COMPONENTS component1 ... componentX] ) # diff --git a/cmake/FindSphinx.cmake b/cmake/FindSphinx.cmake index d085ba06..2e05fd77 100644 --- a/cmake/FindSphinx.cmake +++ b/cmake/FindSphinx.cmake @@ -1,10 +1,14 @@ -#Look for an executable called sphinx-build -find_program(SPHINX_EXECUTABLE - NAMES sphinx-build - DOC "Path to sphinx-build executable") - -include(FindPackageHandleStandardArgs) -#Handle standard arguments to find_package like REQUIRED and QUIET -find_package_handle_standard_args(Sphinx - "Failed to find sphinx-build executable" +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + +#Look for an executable called sphinx-build +find_program(SPHINX_EXECUTABLE + NAMES sphinx-build + DOC "Path to sphinx-build executable") + +include(FindPackageHandleStandardArgs) +#Handle standard arguments to find_package like REQUIRED and QUIET +find_package_handle_standard_args(Sphinx + "Failed to find sphinx-build executable" SPHINX_EXECUTABLE) \ No newline at end of file diff --git a/cmake/KokkosFFTConfig.cmake.in b/cmake/KokkosFFTConfig.cmake.in index 847c4673..ebaf1f64 100644 --- a/cmake/KokkosFFTConfig.cmake.in +++ b/cmake/KokkosFFTConfig.cmake.in @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + @PACKAGE_INIT@ # Set and Check must go first else macro might be redefined by find_dependency ... diff --git a/cmake/KokkosFFT_Git_Hash.cmake b/cmake/KokkosFFT_Git_Hash.cmake index bfa99f94..e6cd494d 100644 --- a/cmake/KokkosFFT_Git_Hash.cmake +++ b/cmake/KokkosFFT_Git_Hash.cmake @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + # https://jonathanhamberg.com/post/cmake-embedding-git-hash/ find_package(Git QUIET) diff --git a/cmake/KokkosFFT_Version_Info.hpp.in b/cmake/KokkosFFT_Version_Info.hpp.in index dcd893a6..cbddbee3 100644 --- a/cmake/KokkosFFT_Version_Info.hpp.in +++ b/cmake/KokkosFFT_Version_Info.hpp.in @@ -1,18 +1,7 @@ -//@HEADER -// ************************************************************************ +// SPDX-FileCopyrightText: (C) 2022 National Technology & Engineering Solutions of Sandia, LLC (NTESS). +// SPDX-FileCopyrightText: Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software. // -// Kokkos v. 4.0 -// Copyright (2022) National Technology & Engineering -// Solutions of Sandia, LLC (NTESS). -// -// Under the terms of Contract DE-NA0003525 with NTESS, -// the U.S. Government retains certain rights in this software. -// -// Part of Kokkos, under the Apache License v2.0 with LLVM Exceptions. -// See https://kokkos.org/LICENSE for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -// -//@HEADER #ifndef KOKKOSFFT_VERSION_INFO_HPP #define KOKKOSFFT_VERSION_INFO_HPP @@ -32,4 +21,4 @@ constexpr std::string_view GIT_COMMIT_DATE = "@GIT_COMMIT_DATE@"; } // namespace Impl } // namespace KokkosFFT -#endif \ No newline at end of file +#endif diff --git a/cmake/KokkosFFT_config.h.in b/cmake/KokkosFFT_config.h.in index cf8321a3..4b7365dc 100644 --- a/cmake/KokkosFFT_config.h.in +++ b/cmake/KokkosFFT_config.h.in @@ -1,3 +1,7 @@ +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + #ifndef KOKKOSFFT_CONFIG_H #define KOKKOSFFT_CONFIG_H @@ -27,4 +31,4 @@ /* ONEMKL */ #cmakedefine KOKKOSFFT_ENABLE_TPL_ONEMKL -#endif \ No newline at end of file +#endif diff --git a/cmake/KokkosFFT_tpls.cmake b/cmake/KokkosFFT_tpls.cmake index 5c397d05..15d14a29 100644 --- a/cmake/KokkosFFT_tpls.cmake +++ b/cmake/KokkosFFT_tpls.cmake @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + function(get_tpls_list tpls_list) if(Kokkos_ENABLE_CUDA) list(APPEND tpls_list CUFFT) diff --git a/common/CMakeLists.txt b/common/CMakeLists.txt index 52e4d48c..3271ff89 100644 --- a/common/CMakeLists.txt +++ b/common/CMakeLists.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + add_subdirectory(src) if(KokkosFFT_ENABLE_TESTS) add_subdirectory(unit_test) diff --git a/common/src/CMakeLists.txt b/common/src/CMakeLists.txt index ee9adf17..f1271c72 100644 --- a/common/src/CMakeLists.txt +++ b/common/src/CMakeLists.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + add_library(common INTERFACE) target_link_libraries(common diff --git a/common/src/KokkosFFT_Helpers.hpp b/common/src/KokkosFFT_Helpers.hpp index bbc06247..4edc5cda 100644 --- a/common/src/KokkosFFT_Helpers.hpp +++ b/common/src/KokkosFFT_Helpers.hpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_HELPERS_HPP #define KOKKOSFFT_HELPERS_HPP diff --git a/common/src/KokkosFFT_common_types.hpp b/common/src/KokkosFFT_common_types.hpp index 7080a9d8..2c7c2eee 100644 --- a/common/src/KokkosFFT_common_types.hpp +++ b/common/src/KokkosFFT_common_types.hpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_COMMON_TYPES_HPP #define KOKKOSFFT_COMMON_TYPES_HPP diff --git a/common/src/KokkosFFT_layouts.hpp b/common/src/KokkosFFT_layouts.hpp index 18ba3d46..dc5e6d1a 100644 --- a/common/src/KokkosFFT_layouts.hpp +++ b/common/src/KokkosFFT_layouts.hpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_LAYOUTS_HPP #define KOKKOSFFT_LAYOUTS_HPP @@ -195,4 +197,4 @@ auto get_extents_batched(InViewType& in, OutViewType& out, int _axis) { } // namespace Impl }; // namespace KokkosFFT -#endif \ No newline at end of file +#endif diff --git a/common/src/KokkosFFT_normalization.hpp b/common/src/KokkosFFT_normalization.hpp index 273c4b05..90199dac 100644 --- a/common/src/KokkosFFT_normalization.hpp +++ b/common/src/KokkosFFT_normalization.hpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_NORMALIZATION_HPP #define KOKKOSFFT_NORMALIZATION_HPP diff --git a/common/src/KokkosFFT_padding.hpp b/common/src/KokkosFFT_padding.hpp index d220e5e5..cc30e4e5 100644 --- a/common/src/KokkosFFT_padding.hpp +++ b/common/src/KokkosFFT_padding.hpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_PADDING_HPP #define KOKKOSFFT_PADDING_HPP diff --git a/common/src/KokkosFFT_transpose.hpp b/common/src/KokkosFFT_transpose.hpp index 9bcf4b87..3bef843d 100644 --- a/common/src/KokkosFFT_transpose.hpp +++ b/common/src/KokkosFFT_transpose.hpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_TRANSPOSE_HPP #define KOKKOSFFT_TRANSPOSE_HPP diff --git a/common/src/KokkosFFT_utils.hpp b/common/src/KokkosFFT_utils.hpp index 6c869a95..b26b75a3 100644 --- a/common/src/KokkosFFT_utils.hpp +++ b/common/src/KokkosFFT_utils.hpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #ifndef KOKKOSFFT_UTILS_HPP #define KOKKOSFFT_UTILS_HPP diff --git a/common/unit_test/CMakeLists.txt b/common/unit_test/CMakeLists.txt index ad9019dc..952c5047 100644 --- a/common/unit_test/CMakeLists.txt +++ b/common/unit_test/CMakeLists.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + add_executable(unit-tests-kokkos-fft-common Test_Main.cpp Test_Utils.cpp diff --git a/common/unit_test/Test_Helpers.cpp b/common/unit_test/Test_Helpers.cpp index e3f8f9f3..d60293d0 100644 --- a/common/unit_test/Test_Helpers.cpp +++ b/common/unit_test/Test_Helpers.cpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #include #include diff --git a/common/unit_test/Test_Layouts.cpp b/common/unit_test/Test_Layouts.cpp index 9a3cb8f7..e1aefb24 100644 --- a/common/unit_test/Test_Layouts.cpp +++ b/common/unit_test/Test_Layouts.cpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #include #include diff --git a/common/unit_test/Test_Main.cpp b/common/unit_test/Test_Main.cpp index 18fd3411..b3086838 100644 --- a/common/unit_test/Test_Main.cpp +++ b/common/unit_test/Test_Main.cpp @@ -1,20 +1,8 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT - -//@HEADER -// ************************************************************************ -// -// Kokkos v. 4.0 -// Copyright (2022) National Technology & Engineering -// Solutions of Sandia, LLC (NTESS). -// -// Under the terms of Contract DE-NA0003525 with NTESS, -// the U.S. Government retains certain rights in this software. +// SPDX-FileCopyrightText: (C) 2022 National Technology & Engineering Solutions of Sandia, LLC (NTESS). +// SPDX-FileCopyrightText: Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software. // -// Part of Kokkos, under the Apache License v2.0 with LLVM Exceptions. -// See https://kokkos.org/LICENSE for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT -// -//@HEADER +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception + #include #include @@ -36,4 +24,4 @@ int main(int argc, char* argv[]) { } return result; -} \ No newline at end of file +} diff --git a/common/unit_test/Test_Normalization.cpp b/common/unit_test/Test_Normalization.cpp index ddf1a9fe..1db78a28 100644 --- a/common/unit_test/Test_Normalization.cpp +++ b/common/unit_test/Test_Normalization.cpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #include #include diff --git a/common/unit_test/Test_Padding.cpp b/common/unit_test/Test_Padding.cpp index 5957e615..9cdea642 100644 --- a/common/unit_test/Test_Padding.cpp +++ b/common/unit_test/Test_Padding.cpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #include #include diff --git a/common/unit_test/Test_Transpose.cpp b/common/unit_test/Test_Transpose.cpp index 856a96a2..e221a8ae 100644 --- a/common/unit_test/Test_Transpose.cpp +++ b/common/unit_test/Test_Transpose.cpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #include #include diff --git a/common/unit_test/Test_Types.hpp b/common/unit_test/Test_Types.hpp index d327dd20..69d38011 100644 --- a/common/unit_test/Test_Types.hpp +++ b/common/unit_test/Test_Types.hpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #ifndef TEST_TYPES_HPP #define TEST_TYPES_HPP diff --git a/common/unit_test/Test_Utils.cpp b/common/unit_test/Test_Utils.cpp index e431a8aa..2322443c 100644 --- a/common/unit_test/Test_Utils.cpp +++ b/common/unit_test/Test_Utils.cpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #include #include "KokkosFFT_utils.hpp" diff --git a/common/unit_test/Test_Utils.hpp b/common/unit_test/Test_Utils.hpp index 35aea4f5..d30aa9b0 100644 --- a/common/unit_test/Test_Utils.hpp +++ b/common/unit_test/Test_Utils.hpp @@ -1,4 +1,6 @@ -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT +// SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +// +// SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception #ifndef TEST_UTILS_HPP #define TEST_UTILS_HPP diff --git a/docker/gcc/Dockerfile b/docker/gcc/Dockerfile index d432af36..c305a5ef 100644 --- a/docker/gcc/Dockerfile +++ b/docker/gcc/Dockerfile @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + ARG BASE=ubuntu:20.04 FROM $BASE diff --git a/docker/intel/Dockerfile b/docker/intel/Dockerfile index 9e4b3a32..cab5320e 100644 --- a/docker/intel/Dockerfile +++ b/docker/intel/Dockerfile @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + ARG BASE=intel/oneapi-basekit:2024.0.1-devel-ubuntu20.04 FROM $BASE diff --git a/docker/nvcc/Dockerfile b/docker/nvcc/Dockerfile index fdd955a9..b2ab0435 100644 --- a/docker/nvcc/Dockerfile +++ b/docker/nvcc/Dockerfile @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + ARG BASE=nvidia/cuda:12.3.1-devel-ubuntu20.04 FROM $BASE diff --git a/docker/rocm/Dockerfile b/docker/rocm/Dockerfile index 5526f387..c0f5fc5c 100644 --- a/docker/rocm/Dockerfile +++ b/docker/rocm/Dockerfile @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + ARG BASE=rocm/dev-ubuntu-20.04 FROM $BASE diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 49be952f..c107314d 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -1,52 +1,56 @@ -# source: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/ - -# Find all the public headers -file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/conf.py DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) -file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/index.rst DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) - -file(GLOB_RECURSE ${PROJECT_NAME}_PUBLIC_HEADERS - ${PROJECT_SOURCE_DIR}/fft/src/*.hpp) - -set(DOXYGEN_INPUT_DIR ${PROJECT_SOURCE_DIR}/fft/src/) -set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen) -set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml) -set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) -set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) - -# Set the Doxygen input and output directories in the Doxyfile -configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT}) - -# Doxygen won't create this for us -file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR}) - -# Only regenerate Doxygen when the Doxyfile or public headers change -add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE} - DEPENDS ${${PROJECT_NAME}_PUBLIC_HEADERS} - COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} - MAIN_DEPENDENCY Doxyfile - COMMENT "Generating docs") - -# Nice named target so we can run the job easily -add_custom_target(Doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE}) - -set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR}) -set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/sphinx) -set(SPHINX_INDEX_FILE ${SPHINX_BUILD}/index.html) - -# Only regenerate Sphinx when: -# - Doxygen has rerun -# - Our doc files have been updated -# - The Sphinx config has been updated -add_custom_target(Sphinx ALL - COMMAND ${SPHINX_EXECUTABLE} -W --keep-going -b html - # Tell Breathe where to find the Doxygen output - -Dbreathe_projects.${PROJECT_NAME}=${DOXYGEN_OUTPUT_DIR}/xml - ${SPHINX_SOURCE} ${SPHINX_BUILD} - WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} - DEPENDS Doxygen - COMMENT "Generating documentation with Sphinx") - -include(GNUInstallDirs) -install(DIRECTORY ${SPHINX_BUILD} - DESTINATION ${CMAKE_INSTALL_DOCDIR}) +# SPDX-FileCopyrightText: (C) The Kokkos-FFT development team, see COPYRIGHT.md file +# +# SPDX-License-Identifier: MIT OR Apache-2.0 WITH LLVM-exception + +# source: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/ + +# Find all the public headers +file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/conf.py DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) +file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/index.rst DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) + +file(GLOB_RECURSE ${PROJECT_NAME}_PUBLIC_HEADERS + ${PROJECT_SOURCE_DIR}/fft/src/*.hpp) + +set(DOXYGEN_INPUT_DIR ${PROJECT_SOURCE_DIR}/fft/src/) +set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen) +set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml) +set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) +set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) + +# Set the Doxygen input and output directories in the Doxyfile +configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT}) + +# Doxygen won't create this for us +file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR}) + +# Only regenerate Doxygen when the Doxyfile or public headers change +add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE} + DEPENDS ${${PROJECT_NAME}_PUBLIC_HEADERS} + COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + MAIN_DEPENDENCY Doxyfile + COMMENT "Generating docs") + +# Nice named target so we can run the job easily +add_custom_target(Doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE}) + +set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR}) +set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/sphinx) +set(SPHINX_INDEX_FILE ${SPHINX_BUILD}/index.html) + +# Only regenerate Sphinx when: +# - Doxygen has rerun +# - Our doc files have been updated +# - The Sphinx config has been updated +add_custom_target(Sphinx ALL + COMMAND ${SPHINX_EXECUTABLE} -W --keep-going -b html + # Tell Breathe where to find the Doxygen output + -Dbreathe_projects.${PROJECT_NAME}=${DOXYGEN_OUTPUT_DIR}/xml + ${SPHINX_SOURCE} ${SPHINX_BUILD} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + DEPENDS Doxygen + COMMENT "Generating documentation with Sphinx") + +include(GNUInstallDirs) +install(DIRECTORY ${SPHINX_BUILD} + DESTINATION ${CMAKE_INSTALL_DOCDIR}) diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 9f3448ce..1e4224ef 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -1,2566 +1,2570 @@ -# Doxyfile 1.8.15 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the configuration -# file that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# https://www.gnu.org/software/libiconv/ for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = "@PROJECT_NAME@" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = "@DOXYGEN_OUTPUT_DIR@" - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all generated output in the proper direction. -# Possible values are: None, LTR, RTL and Context. -# The default value is: None. - -OUTPUT_TEXT_DIRECTION = None - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines (in the resulting output). You can put ^^ in the value part of an -# alias to insert a newline as if a physical newline was in the original file. -# When you need a literal { or } or , in the value part of an alias you have to -# escape them by means of a backslash (\), this can lead to conflicts with the -# commands \{ and \} for these it is advised to use the version @{ and @} or use -# a double escape (\\{ and \\}) - -ALIASES = - -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice -# sources only. Doxygen will then generate output that is more tailored for that -# language. For instance, namespaces will be presented as modules, types will be -# separated into more groups, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_SLICE = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, -# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: -# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser -# tries to guess whether the code is fixed or free formatted code, this is the -# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat -# .inc files as Fortran files (default is PHP), and .f files as C (default is -# Fortran), use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See https://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up -# to that level are automatically included in the table of contents, even if -# they do not have an id attribute. -# Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 0. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -TOC_INCLUDE_HEADINGS = 0 - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = NO - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO, these declarations will be -# included in the documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES, upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. If -# EXTRACT_ALL is set to YES then this flag will automatically be disabled. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. -# The default value is: NO. - -WARN_AS_ERROR = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = ../fft/src/ \ - ../common/src/ - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: https://www.gnu.org/software/libiconv/) for the list of -# possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, -# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. - -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.pyw \ - *.f90 \ - *.f95 \ - *.f03 \ - *.f08 \ - *.f \ - *.for \ - *.tcl \ - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf \ - *.ice - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = NO - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# entity all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see https://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the -# cost of reduced performance. This can be particularly helpful with template -# rich C++ code for which doxygen's built-in parser lacks the necessary type -# information. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -# If clang assisted parsing is enabled you can provide the clang parser with the -# path to the compilation database (see: -# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files -# were built. This is equivalent to specifying the "-p" option to a clang tool, -# such as clang-check. These options will then be passed to the parser. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. - -CLANG_DATABASE_PATH = - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# https://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - -# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML -# documentation will contain a main index with vertical navigation menus that -# are dynamically created via Javascript. If disabled, the navigation index will -# consists of multiple levels of tabs that are statically embedded in every HTML -# page. Disable this option to support browsers that do not have Javascript, -# like the Qt help browser. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_MENUS = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: https://developer.apple.com/xcode/), introduced with OSX -# 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy -# genXcode/_index.html for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the master .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# https://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from https://www.mathjax.org before deployment. -# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /