diff options
author | avinashlalotra | 2025-04-26 20:09:12 +0530 |
---|---|---|
committer | avinashlalotra | 2025-04-26 20:09:12 +0530 |
commit | ea7dcdba3b83696b97cc431ee050b58f9a0f3507 (patch) | |
tree | 49ea8ba898b88535c261546f4e3accbdf4c83bdf /macros/fht.sci | |
parent | 725d9ee2ddb254f57a896bb47e0e727759eb5901 (diff) | |
download | FOSSEE-Signal-Processing-Toolbox-ea7dcdba3b83696b97cc431ee050b58f9a0f3507.tar.gz FOSSEE-Signal-Processing-Toolbox-ea7dcdba3b83696b97cc431ee050b58f9a0f3507.tar.bz2 FOSSEE-Signal-Processing-Toolbox-ea7dcdba3b83696b97cc431ee050b58f9a0f3507.zip |
formated source documentation pattern for generating docs
Diffstat (limited to 'macros/fht.sci')
-rw-r--r-- | macros/fht.sci | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/macros/fht.sci b/macros/fht.sci index 9bd6b38..2a23c91 100644 --- a/macros/fht.sci +++ b/macros/fht.sci @@ -1,22 +1,22 @@ -/* Description
- This function calculates the Fast Hartley transform of real input D.
- If D is a matrix, the Hartley transform is calculated along the columns by default.
- If N is specified, the first N elements along the specified dimension are used for the transform.
- If DIM is specified, the transform is calculated along the specified dimension.
- Calling Sequence
- M = fht (D)
- M = fht (D, N)
- M = fht (D, N, DIM)
- Parameters
- D: Input data (real matrix or vector).
- N: Number of elements of D to be used for the transform (optional).
- DIM: Dimension along which the transform is to be computed (optional).
- Examples
- fht(1:4)
- ans =
- 10 -4 -2 0
-*/
function M = fht(D, N, DIM)
+// Description
+// This function calculates the Fast Hartley transform of real input D.
+// If D is a matrix, the Hartley transform is calculated along the columns by default.
+// If N is specified, the first N elements along the specified dimension are used for the transform.
+// If DIM is specified, the transform is calculated along the specified dimension.
+// Calling Sequence
+// M = fht (D)
+// M = fht (D, N)
+// M = fht (D, N, DIM)
+// Parameters
+// D: Input data (real matrix or vector).
+// N: Number of elements of D to be used for the transform (optional).
+// DIM: Dimension along which the transform is to be computed (optional).
+// Examples
+// fht(1:4)
+// ans =
+// 10 -4 -2 0
+
funcprot(0);
rhs = argn(2);
if rhs < 1 | rhs > 3 then
|