Skip to content

Commit 9c8a885

Browse files
committed
modify relevant documentation
1 parent 88407ea commit 9c8a885

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

doc/specs/fftpack.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -809,13 +809,16 @@ end program demo_dzfftb
809809

810810
## DCT type-1 (DCT-1)
811811

812-
### Initialize DCT-1: `dcosti`
812+
### Initialize DCT-1: `dcosti` or `dct_t1i`
813813

814814
#### Description
815815

816816
Initializes the array `wsave` which is used in subroutine `dcost`.
817817
The prime factorization of `n` together with a tabulation of the trigonometric functions are computed and stored in `wsave`.
818818

819+
The two procedures are completely equivalent and expect the same arguments.
820+
It is a matter of personal preference which one you choose to use.
821+
819822
#### Status
820823

821824
Experimental
@@ -851,18 +854,21 @@ program demo_dcosti
851854
end program demo_dcosti
852855
```
853856

854-
### Compute DCT-1: `dcost`
857+
### Compute DCT-1: `dcost` or `dct_t1`
855858

856859
#### Description
857860

858861
Computes the DCT-1 of the input real data.
859862
The transform is defined below at output parameter `x`.
860863

864+
The two procedures are completely equivalent and expect the same arguments.
865+
It is a matter of personal preference which one you choose to use.
866+
861867
For real input data `x` of length `n`, the DCT-1 of `x` is equivalent, up to a
862868
scaling factor, to the DFT of the even extension of `x` with length `2*(n-1)`,
863869
where the first and last entries of the original data are not repeated in the
864-
extension. For example, the DCT-1 of input data *abcde* (size \[5\]) is
865-
equivalent to the DFT of data *abcdedcb* (size \[2*4=8\]).
870+
extension. For example, the DCT-1 of input data *abcde* (size \(5\)) is
871+
equivalent to the DFT of data *abcdedcb* (size \(2*4=8\)).
866872

867873
Also, `dcost` is the unnormalized inverse of itself. This means that a call of
868874
`dcost` followed by another call of `dcost` will multiply the input sequence `x`
@@ -932,7 +938,7 @@ end program demo_dcost
932938

933939
## DCT of types 2, 3 (DCT-2, 3), a.k.a "Quarter" cosine transforms
934940

935-
### Initialize DCT-2, 3: `dcosqi`
941+
### Initialize DCT-2, 3: `dcosqi` or `dct_t23i`
936942

937943
#### Description
938944

@@ -941,6 +947,9 @@ The prime factorization of `n` together with
941947
a tabulation of the trigonometric functions are computed and
942948
stored in `wsave`.
943949

950+
The two procedures are completely equivalent and expect the same arguments.
951+
It is a matter of personal preference which one you choose to use.
952+
944953
#### Status
945954

946955
Experimental
@@ -978,13 +987,16 @@ program demo_dcosqi
978987
end program demo_dcosqi
979988
```
980989

981-
### Compute DCT-3: `dcosqf`
990+
### Compute DCT-3: `dcosqf` or `dct_t3`
982991

983992
#### Description
984993

985994
Computes the DCT-3 of the input real data.
986995
The transform is defined below at output parameter `x`.
987996

997+
The two procedures are completely equivalent and expect the same arguments.
998+
It is a matter of personal preference which one you choose to use.
999+
9881000
Also, `dcosqf` (DCT-3) is the unnormalized inverse of `dcosqb` (DCT-2), since a
9891001
call of `dcosqf` followed by a call of `dcosqb` will multiply the input sequence
9901002
`x` by `4*n`.
@@ -1049,13 +1061,16 @@ program demo_dcosqf
10491061
end program demo_dcosqf
10501062
```
10511063

1052-
### Compute DCT-2: `dcosqb`
1064+
### Compute DCT-2: `dcosqb` or `dct_t2`
10531065

10541066
#### Description
10551067

10561068
Computes the DCT-2 of the input real data.
10571069
The transform is defined below at output parameter `x`.
10581070

1071+
The two procedures are completely equivalent and expect the same arguments.
1072+
It is a matter of personal preference which one you choose to use.
1073+
10591074
For real input data `x` of length `n`, the DCT-2 of `x` is equivalent, up to a
10601075
scaling factor, to the DFT of the even extension of `x` with length `4*n`,
10611076
where all the even-frequency entries are zero.

0 commit comments

Comments
 (0)