Error Handling

On success, S3L_fft_detailed returns S3L_SUCCESS.

S3L_fft_detailed performs generic checking of the validity of the arrays it accepts as arguments. If an array argument contains an invalid or corrupted value, the function terminates and returns an error code indicating which value was invalid. See Appendix A of this manual for a detailed list of these error codes.

The following conditions will cause the function to terminate and return the associated error code.

• S3L_ERR_ARG_NCOMPLEX - Array a is not complex.

• S3L_ERR_FFT_EXTSQPROCS - Array a is 1D but its extent is not divisible by the square of the number of processes.

• S3L_ERR_ARG_SETUP - The setup_id supplied is not valid.

• S3L_ERR_FFT_INVIFLAG - The iflag argument is invalid.