Skip to content

Commit

Permalink
fix: typos in docstrings based on a review
Browse files Browse the repository at this point in the history
  • Loading branch information
Yuuichi Asahi committed Feb 24, 2025
1 parent 8b2352c commit b49b375
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 22 deletions.
12 changes: 6 additions & 6 deletions common/src/KokkosFFT_Helpers.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
///
Expand All @@ -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
Expand Down Expand Up @@ -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
///
Expand Down
4 changes: 2 additions & 2 deletions fft/src/KokkosFFT_Plans.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down
28 changes: 14 additions & 14 deletions fft/src/KokkosFFT_Transform.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
///
Expand Down Expand Up @@ -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
///
Expand Down Expand Up @@ -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
///
Expand Down Expand Up @@ -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
///
Expand Down Expand Up @@ -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
///
Expand Down Expand Up @@ -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
///
Expand Down Expand Up @@ -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
///
Expand Down Expand Up @@ -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
///
Expand Down Expand Up @@ -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
///
Expand Down Expand Up @@ -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
///
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit b49b375

Please sign in to comment.