Update fft.hpp

Added comments
xtensor-stack · Nov 24, 2023 · 77783b8 · 77783b8
1 parent 8b2ac01
commit 77783b8
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/include/xtensor-signal/fft.hpp b/include/xtensor-signal/fft.hpp
@@ -58,6 +58,12 @@ inline auto fft(E &&e) {
 }
 } // namespace detail
 
+/**
+* @breif 1D FFT of an Nd array along a specified axis
+* @param e an Nd expression to be transformed to the fourier domain
+* @param axis the axis along which to perform the 1D FFT
+* @return a transformed xarray of the specified precision
+*/
 template <class E,
           typename std::enable_if<
               xtl::is_complex<typename std::decay<E>::type::value_type>::value,
@@ -75,6 +81,12 @@ inline auto fft(E &&e, std::ptrdiff_t axis = -1) {
   return out;
 }
 
+/**
+* @breif 1D FFT of an Nd array along a specified axis
+* @param e an Nd expression to be transformed to the fourier domain
+* @param axis the axis along which to perform the 1D FFT
+* @return a transformed xarray of the specified precision
+*/
 template <class E,
           typename std::enable_if<
               !xtl::is_complex<typename std::decay<E>::type::value_type>::value,