Merge remote-tracking branch 'origin/release-v4.6.1'
[WRF.git] / external / fftpack / fftpack5 / dcost1f.F
blobb6a61f9d36ed7c606a35c5b5c898e186994d492f
1 subroutine dcost1f ( n, inc, x, lenx, wsave, lensav, work, lenwrk, ier )
3 !*****************************************************************************80
5 !! DCOST1F: real double precision forward cosine transform, 1D.
7 !  Discussion:
9 !    DCOST1F computes the one-dimensional Fourier transform of an even
10 !    sequence within a real array.  This transform is referred to as the
11 !    forward transform or Fourier analysis, transforming the sequence
12 !    from  physical to spectral space.
14 !    This transform is normalized since a call to DCOST1F followed by a call
15 !    to DCOST1B (or vice-versa) reproduces the original array within
16 !    roundoff error.
20 !  Modified:
22 !    07 February 2006
24 !  Author:
26 !    Original real single precision by Paul Swarztrauber, Richard Valent.
27 !    Real double precision version by John Burkardt.
29 !  Reference:
31 !    Paul Swarztrauber,
32 !    Vectorizing the Fast Fourier Transforms,
33 !    in Parallel Computations,
34 !    edited by G. Rodrigue,
35 !    Academic Press, 1982.
37 !    Paul Swarztrauber,
38 !    Fast Fourier Transform Algorithms for Vector Computers,
39 !    Parallel Computing, pages 45-63, 1984.
41 !  Parameters:
43 !    Input, integer ( kind = 4 ) N, the length of the sequence to be
44 !    transformed.  The transform is most efficient when N-1 is a product of
45 !    small primes.
47 !    Input, integer ( kind = 4 ) INC, the increment between the locations,
48 !    in array R, of two consecutive elements within the sequence.
50 !    Input/output, real ( kind = 8 ) R(LENR), containing the sequence
51 !    to be transformed.
53 !    Input, integer ( kind = 4 ) LENR, the dimension of the R array.
54 !    LENR must be at least INC*(N-1)+ 1.
56 !    Input, real ( kind = 8 ) WSAVE(LENSAV).  WSAVE's contents must be
57 !    initialized with a call to DCOST1I before the first call to routine
58 !    DCOST1F or DCOST1B for a given transform length N.  WSAVE's contents
59 !    may be re-used for subsequent calls to DCOST1F and DCOST1B with the same N.
61 !    Input, integer ( kind = 4 ) LENSAV, the dimension of the WSAVE array.
62 !    LENSAV must be at least 2*N + INT(LOG(REAL(N))) + 4.
64 !    Workspace, real ( kind = 8 ) WORK(LENWRK).
66 !    Input, integer ( kind = 4 ) LENWRK, the dimension of the WORK array.
67 !    LENWRK must be at least N-1.
69 !    Output, integer ( kind = 4 ) IER, error flag.
70 !    0, successful exit;
71 !    1, input parameter LENR   not big enough;
72 !    2, input parameter LENSAV not big enough;
73 !    3, input parameter LENWRK not big enough;
74 !    20, input error returned by lower level routine.
76   implicit none
78   integer ( kind = 4 ) inc
79   integer ( kind = 4 ) lensav
80   integer ( kind = 4 ) lenwrk
82   integer ( kind = 4 ) ier
83   integer ( kind = 4 ) ier1
84   integer ( kind = 4 ) lenx
85   integer ( kind = 4 ) n
86   real ( kind = 8 ) work(lenwrk)
87   real ( kind = 8 ) wsave(lensav)
88   real ( kind = 8 ) x(inc,*)
90   ier = 0
92   if ( lenx < inc * ( n - 1 ) + 1 ) then
93     ier = 1
94     call xerfft ( 'DCOST1F', 6 )
95     return
96   end if
98   if ( lensav < 2 * n + int ( log ( real ( n, kind = 8 ) ) ) + 4 ) then
99     ier = 2
100     call xerfft ( 'DCOST1F', 8 )
101     return
102   end if
104   if ( lenwrk < n - 1 ) then
105     ier = 3
106     call xerfft ( 'DCOST1F', 10 )
107     return
108   end if
110   call dcostf1 ( n, inc, x, wsave, work, ier1 )
112   if ( ier1 /= 0 ) then
113     ier = 20
114     call xerfft ( 'DCOST1F', -5 )
115     return
116   end if
118   return