Developer Reference

  • 2021.1
  • 12/04/2020
  • Public Content
Contents

free_sph_p/free_sph_np

Releases the memory allocated for the data structures used by the FFT interface.

Syntax

void free_sph_p
(
DFTI_DESCRIPTOR_HANDLE*
handle_s,
DFTI_DESCRIPTOR_HANDLE*
handle_c,
MKL_INT*
ipar,
MKL_INT*
stat
)
;
void free_sph_np
(
DFTI_DESCRIPTOR_HANDLE*
handle,
MKL_INT*
ipar,
MKL_INT*
stat
)
;
Include Files
  • mkl.h
Input Parameters
handle_s, handle_c, handle
DFTI_DESCRIPTOR_HANDLE*
. Data structures used by the
Intel® oneAPI Math Kernel Library
FFT interface (for details, refer toFFT Functions). The structures
handle_s
and
handle_c
are used only in
free_sph_p
, and
handle
is used only in
free_sph_np
.
ipar
MKL_INT
array of size 128. Contains integer data to be used by Fast Helmholtz Solver on a sphere (for details, refer to
ipar
).
Output Parameters
handle_s, handle_c, handle
Data structures used by the
Intel® oneAPI Math Kernel Library
FFT interface. Memory allocated for the structures is released on output.
ipar
Contains integer data to be used by Fast Helmholtz Solver on a sphere. On output, the status of the routine call is written to
ipar[0]
.
stat
MKL_INT*
. Routine completion status, which is also written to
ipar[0]
.
Description
The
free_sph_p/free_sph_np
routine releases the memory used by the
handle_s
,
handle_c
or
handle
structures, needed for calling the
Intel® oneAPI Math Kernel Library
FFT functions. To release memory allocated for other parameters, include memory release statements in your code.
Return Values
stat
= 0
The routine successfully completed the task.
stat
= -1000
The routine stopped because of an
Intel® oneAPI Math Kernel Library
FFT or TT interface error.
stat
= -99999
The routine failed to complete the task because of a fatal error.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.