aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Robinson <[email protected]>2019-09-14 18:37:00 -0700
committerChris Robinson <[email protected]>2019-09-14 18:37:00 -0700
commitb212ab9ea21a093ba8fa9895e723bc76b84cf284 (patch)
treea866d7d2ddd2daed908d46a813ea67e5fe82c744
parent807d3b64cac2793ce678acb3fc4d4191b2252875 (diff)
Add a note about clearing complex_hilbert's imaginary input
-rw-r--r--common/alcomplex.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/common/alcomplex.h b/common/alcomplex.h
index f224cce2..12b86436 100644
--- a/common/alcomplex.h
+++ b/common/alcomplex.h
@@ -17,7 +17,8 @@ void complex_fft(const al::span<std::complex<double>> buffer, const double sign)
* Calculate the complex helical sequence (discrete-time analytical signal) of
* the given input using the discrete Hilbert transform (In-place algorithm).
* Fills the buffer with the discrete-time analytical signal stored in the
- * buffer. The buffer is an array of complex numbers and MUST BE power of two.
+ * buffer. The buffer is an array of complex numbers and MUST BE power of two,
+ * and the imaginary components should be cleared to 0.
*/
void complex_hilbert(const al::span<std::complex<double>> buffer);