external/fftpack/fftpack5/zfftmb.F

   1 subroutine zfftmb ( lot, jump, n, inc, c, lenc, wsave, lensav, work, &
   2   lenwrk, ier )
   3
   4 !*****************************************************************************80
   5 !
   6 !! ZFFTMB: complex double precision backward FFT, 1D, multiple vectors.
   7 !
   8 !  Discussion:
   9 !
  10 !    ZFFTMB computes the one-dimensional Fourier transform of multiple
  11 !    periodic sequences within a complex array.  This transform is referred
  12 !    to as the backward transform or Fourier synthesis, transforming the
  13 !    sequences from spectral to physical space.  This transform is
  14 !    normalized since a call to ZFFTMF followed by a call to ZFFTMB (or
  15 !    vice-versa) reproduces the original array within roundoff error.
  16 !
  17 !    The parameters INC, JUMP, N and LOT are consistent if equality
  18 !    I1*INC + J1*JUMP = I2*INC + J2*JUMP for I1,I2 < N and J1,J2 < LOT
  19 !    implies I1=I2 and J1=J2.  For multiple FFTs to execute correctly,
  20 !    input variables INC, JUMP, N and LOT must be consistent, otherwise
  21 !    at least one array element mistakenly is transformed more than once.
  22 !
  23 !
  24 !
  25 !  Modified:
  26 !
  27 !    26 Ausust 2009
  28 !
  29 !  Author:
  30 !
  31 !    Original complex single precision by Paul Swarztrauber, Richard Valent.
  32 !    Complex double precision version by John Burkardt.
  33 !
  34 !  Reference:
  35 !
  36 !    Paul Swarztrauber,
  37 !    Vectorizing the Fast Fourier Transforms,
  38 !    in Parallel Computations,
  39 !    edited by G. Rodrigue,
  40 !    Academic Press, 1982.
  41 !
  42 !    Paul Swarztrauber,
  43 !    Fast Fourier Transform Algorithms for Vector Computers,
  44 !    Parallel Computing, pages 45-63, 1984.
  45 !
  46 !  Parameters:
  47 !
  48 !    Input, integer ( kind = 4 ) LOT, the number of sequences to be transformed
  49 !    within array C.
  50 !
  51 !    Input, integer ( kind = 4 ) JUMP, the increment between the locations, in
  52 !    array C, of the first elements of two consecutive sequences to
  53 !    be transformed.
  54 !
  55 !    Input, integer ( kind = 4 ) N, the length of each sequence to be
  56 !    transformed.  The transform is most efficient when N is a product of
  57 !    small primes.
  58 !
  59 !    Input, integer ( kind = 4 ) INC, the increment between the locations, in
  60 !    array C, of two consecutive elements within the same sequence to be
  61 !    transformed.
  62 !
  63 !    Input/output, complex ( kind = 8 ) C(LENC), an array containing LOT
  64 !    sequences, each having length N, to be transformed.  C can have any
  65 !    number of dimensions, but the total number of locations must be at least
  66 !    LENC.  On output, C contains the transformed sequences.
  67 !
  68 !    Input, integer ( kind = 4 ) LENC, the dimension of the C array.
  69 !    LENC must be at least (LOT-1)*JUMP + INC*(N-1) + 1.
  70 !
  71 !    Input, real ( kind = 8 ) WSAVE(LENSAV).  WSAVE's contents must be
  72 !    initialized with a call to ZFFTMI before the first call to routine ZFFTMF
  73 !    or ZFFTMB for a given transform length N.
  74 !
  75 !    Input, integer ( kind = 4 ) LENSAV, the dimension of the WSAVE array.
  76 !    LENSAV must be at least 2*N + INT(LOG(REAL(N))) + 4.
  77 !
  78 !    Workspace, real ( kind = 8 ) WORK(LENWRK).
  79 !
  80 !    Input, integer ( kind = 4 ) LENWRK, the dimension of the WORK array.
  81 !    LENWRK must be at least 2*LOT*N.
  82 !
  83 !    Output, integer ( kind = 4 ) IER, error flag.
  84 !    0, successful exit
  85 !    1, input parameter LENC not big enough;
  86 !    2, input parameter LENSAV not big enough;
  87 !    3, input parameter LENWRK not big enough;
  88 !    4, input parameters INC, JUMP, N, LOT are not consistent.
  89 !
  90   implicit none
  91
  92   integer ( kind = 4 ) lenc
  93   integer ( kind = 4 ) lensav
  94   integer ( kind = 4 ) lenwrk
  95
  96   complex ( kind = 8 ) c(lenc)
  97   integer ( kind = 4 ) ier
  98   integer ( kind = 4 ) inc
  99   integer ( kind = 4 ) iw1
 100   integer ( kind = 4 ) jump
 101   integer ( kind = 4 ) lot
 102   integer ( kind = 4 ) n
 103   real ( kind = 8 ) work(lenwrk)
 104   real ( kind = 8 ) wsave(lensav)
 105   logical              xercon
 106
 107   ier = 0
 108
 109   if ( lenc < ( lot - 1 ) * jump + inc * ( n - 1 ) + 1 ) then
 110     ier = 1
 111     call xerfft ( 'ZFFTMB', 6 )
 112     return
 113   end if
 114
 115   if ( lensav < 2 * n + int ( log ( real ( n, kind = 8 ) ) ) + 4 ) then
 116     ier = 2
 117     call xerfft ( 'ZFFTMB', 8 )
 118     return
 119   end if
 120
 121   if ( lenwrk < 2 * lot * n ) then
 122     ier = 3
 123     call xerfft ( 'ZFFTMB', 10 )
 124     return
 125   end if
 126
 127   if ( .not. xercon ( inc, jump, n, lot ) ) then
 128     ier = 4
 129     call xerfft ( 'ZFFTMB', -1 )
 130     return
 131   end if
 132
 133   if ( n == 1 ) then
 134     return
 135   end if
 136
 137   iw1 = n + n + 1
 138
 139   call zmfm1b ( lot, jump, n, inc, c, work, wsave, wsave(iw1), &
 140     wsave(iw1+1) )
 141
 142   return
 143 end