Skip to content

Commit

Permalink
Add tparam in docstrings for common APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
Yuuichi Asahi committed Feb 24, 2025
1 parent 2bacc0b commit ed0a788
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions common/src/KokkosFFT_Helpers.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,9 @@ 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 RealType: The floating point precision type to represent frequencies
///
/// \param exec_space [in] Kokkos execution space
/// \param n [in] Window length
/// \param d [in] Sample spacing (default, 1)
Expand Down Expand Up @@ -185,6 +188,9 @@ 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 RealType: The floating point precision type to represent frequencies
///
/// \param exec_space [in] Kokkos execution space
/// \param n [in] Window length
/// \param d [in] Sample spacing (default, 1)
Expand Down Expand Up @@ -214,6 +220,9 @@ 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 ViewType: Input/Output View type for the shift
///
/// \param exec_space [in] Kokkos execution space
/// \param inout [in,out] Spectrum
/// \param axes [in] Axes over which to shift (default: nullopt, shifting over
Expand Down Expand Up @@ -242,6 +251,10 @@ 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 ViewType: Input/Output View type for the shift
/// \tparam DIM: The dimensionality of the shift
///
/// \param exec_space [in] Kokkos execution space
/// \param inout [in,out] Spectrum
/// \param axes [in] Axes over which to shift
Expand All @@ -264,6 +277,9 @@ void fftshift(const ExecutionSpace& exec_space, const ViewType& inout,

/// \brief The inverse of fftshift
///
/// \tparam ExecutionSpace: The type of Kokkos execution pace
/// \tparam ViewType: Input/Output View type for the shift
///
/// \param exec_space [in] Kokkos execution space
/// \param inout [in,out] Spectrum
/// \param axes [in] Axes over which to shift (default: nullopt, shifting over
Expand Down Expand Up @@ -291,6 +307,10 @@ void ifftshift(const ExecutionSpace& exec_space, const ViewType& inout,

/// \brief The inverse of fftshift
///
/// \tparam ExecutionSpace: The type of Kokkos execution pace
/// \tparam ViewType: Input/Output View type for the shift
/// \tparam DIM: The dimensionality of the shift
///
/// \param exec_space [in] Kokkos execution space
/// \param inout [in,out] Spectrum
/// \param axes [in] Axes over which to shift
Expand Down

0 comments on commit ed0a788

Please sign in to comment.