summaryrefslogtreecommitdiff
path: root/gr-blocks/include/gnuradio
diff options
context:
space:
mode:
authorMarcus Müller <mmueller@gnuradio.org>2021-12-31 20:37:36 +0100
committermormj <34754695+mormj@users.noreply.github.com>2022-01-03 06:53:28 -0500
commit09e1a31cd69d50cc44c878628d1213824df2b65e (patch)
treefb9a692d4675dc57d0d3f20b134bb5a8f40604a0 /gr-blocks/include/gnuradio
parent2e77edb7136a3be73f7a7e8b047813494daa6bc9 (diff)
blocks: document the supported operations in transcendental
Signed-off-by: Marcus Müller <mmueller@gnuradio.org>
Diffstat (limited to 'gr-blocks/include/gnuradio')
-rw-r--r--gr-blocks/include/gnuradio/blocks/transcendental.h19
1 files changed, 19 insertions, 0 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/transcendental.h b/gr-blocks/include/gnuradio/blocks/transcendental.h
index 421aa3d7a8..0ab0710a8f 100644
--- a/gr-blocks/include/gnuradio/blocks/transcendental.h
+++ b/gr-blocks/include/gnuradio/blocks/transcendental.h
@@ -28,6 +28,25 @@ namespace blocks {
*
* Possible type strings: float, double, complex_float, complex_double
*
+ * Available functions for real and complex input:
+ *
+ * - cos
+ * - sin
+ * - tan
+ * - cosh
+ * - sinh
+ * - tanh
+ * - exp
+ * - log
+ * - log10
+ * - sqrt
+ *
+ * Available functions for real input only:
+ *
+ * - acos
+ * - asin
+ * - atan
+ *
* output[i] = trans_fcn(input[i])
*/
class BLOCKS_API transcendental : virtual public sync_block