From b49b375a45cfdeacd562d451eda99951e2bd4244 Mon Sep 17 00:00:00 2001 From: Yuuichi Asahi Date: Mon, 24 Feb 2025 20:04:44 +0900 Subject: [PATCH] fix: typos in docstrings based on a review --- common/src/KokkosFFT_Helpers.hpp | 12 ++++++------ fft/src/KokkosFFT_Plans.hpp | 4 ++-- fft/src/KokkosFFT_Transform.hpp | 28 ++++++++++++++-------------- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/common/src/KokkosFFT_Helpers.hpp b/common/src/KokkosFFT_Helpers.hpp index 896df6e9..ca7f7ee3 100644 --- a/common/src/KokkosFFT_Helpers.hpp +++ b/common/src/KokkosFFT_Helpers.hpp @@ -150,7 +150,7 @@ void ifftshift_impl(const ExecutionSpace& exec_space, const ViewType& inout, namespace KokkosFFT { /// \brief Return the DFT sample frequencies /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam RealType: The floating point precision type to represent frequencies /// /// \param exec_space [in] Kokkos execution space @@ -188,7 +188,7 @@ auto fftfreq(const ExecutionSpace&, const std::size_t n, /// \brief Return the DFT sample frequencies for Real FFTs /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam RealType: The floating point precision type to represent frequencies /// /// \param exec_space [in] Kokkos execution space @@ -220,7 +220,7 @@ auto rfftfreq(const ExecutionSpace&, const std::size_t n, /// \brief Shift the zero-frequency component to the center of the spectrum /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam ViewType: Input/Output View type for the shift /// /// \param exec_space [in] Kokkos execution space @@ -251,7 +251,7 @@ void fftshift(const ExecutionSpace& exec_space, const ViewType& inout, /// \brief Shift the zero-frequency component to the center of the spectrum /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam ViewType: Input/Output View type for the shift /// \tparam DIM: The dimensionality of the shift /// @@ -277,7 +277,7 @@ void fftshift(const ExecutionSpace& exec_space, const ViewType& inout, /// \brief The inverse of fftshift /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam ViewType: Input/Output View type for the shift /// /// \param exec_space [in] Kokkos execution space @@ -307,7 +307,7 @@ void ifftshift(const ExecutionSpace& exec_space, const ViewType& inout, /// \brief The inverse of fftshift /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam ViewType: Input/Output View type for the shift /// \tparam DIM: The dimensionality of the shift /// diff --git a/fft/src/KokkosFFT_Plans.hpp b/fft/src/KokkosFFT_Plans.hpp index d97d58fd..8f8a11a0 100644 --- a/fft/src/KokkosFFT_Plans.hpp +++ b/fft/src/KokkosFFT_Plans.hpp @@ -64,7 +64,7 @@ namespace KokkosFFT { /// created. If there are inconsistency in input and output views, the /// compilation would fail. /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// \tparam DIM: The dimensionality of the fft @@ -140,7 +140,7 @@ class Plan { public: /// \brief Constructor /// - /// \param exec_space [in] Kokkos execution device + /// \param exec_space [in] Kokkos execution space for this plan /// \param in [in] Input data /// \param out [in] Output data /// \param direction [in] Direction of FFT (forward/backward) diff --git a/fft/src/KokkosFFT_Transform.hpp b/fft/src/KokkosFFT_Transform.hpp index f1d230d6..b60bf289 100644 --- a/fft/src/KokkosFFT_Transform.hpp +++ b/fft/src/KokkosFFT_Transform.hpp @@ -34,7 +34,7 @@ void execute( /// \brief One dimensional FFT in forward direction /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// @@ -70,7 +70,7 @@ void fft(const ExecutionSpace& exec_space, const InViewType& in, /// \brief One dimensional FFT in backward direction /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// @@ -106,7 +106,7 @@ void ifft(const ExecutionSpace& exec_space, const InViewType& in, /// \brief One dimensional FFT for real input /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// @@ -148,7 +148,7 @@ void rfft(const ExecutionSpace& exec_space, const InViewType& in, /// \brief Inverse of rfft /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// @@ -191,7 +191,7 @@ void irfft(const ExecutionSpace& exec_space, const InViewType& in, /// \brief One dimensional FFT of a signal that has Hermitian symmetry /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// @@ -241,7 +241,7 @@ void hfft(const ExecutionSpace& exec_space, const InViewType& in, /// \brief Inverse of hfft /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// @@ -289,7 +289,7 @@ void ihfft(const ExecutionSpace& exec_space, const InViewType& in, /// \brief Two dimensional FFT in forward direction /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// @@ -324,7 +324,7 @@ void fft2(const ExecutionSpace& exec_space, const InViewType& in, /// \brief Two dimensional FFT in backward direction /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// @@ -360,7 +360,7 @@ void ifft2(const ExecutionSpace& exec_space, const InViewType& in, /// \brief Two dimensional FFT for real input /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// @@ -402,7 +402,7 @@ void rfft2(const ExecutionSpace& exec_space, const InViewType& in, /// \brief Inverse of rfft2 /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// @@ -446,7 +446,7 @@ void irfft2(const ExecutionSpace& exec_space, const InViewType& in, /// \brief N-dimensional FFT in forward direction /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// \tparam DIM: The dimensionality of the fft @@ -494,7 +494,7 @@ void fftn( /// \brief Inverse of fftn /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// \tparam DIM: The dimensionality of the fft @@ -544,7 +544,7 @@ void ifftn( /// \brief N-dimensional FFT for real input /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// \tparam DIM: The dimensionality of the fft @@ -600,7 +600,7 @@ void rfftn( /// \brief Inverse of rfftn /// -/// \tparam ExecutionSpace: The type of Kokkos execution pace +/// \tparam ExecutionSpace: The type of Kokkos execution space /// \tparam InViewType: Input View type for the fft /// \tparam OutViewType: Output View type for the fft /// \tparam DIM: The dimensionality of the fft