SetMode

Changes the value of the parameter mode in the convolution or correlation task descriptor.

Syntax

Fortran:

status = vslconvsetmode(task, newmode)

status = vslcorrsetmode(task, newmode)

status = vslConvSetMode(task, newmode);

status = vslCorrSetMode(task, newmode);

Include Files

The FORTRAN 77 interfaces are specified in the mkl_vsl.f77 include file, the Fortran 90 interfaces are specified in the mkl_vsl.f90 include file, and the C interfaces are specified in the mkl_vsl_functions.h include file.

Input Parameters

Name	Type	Description
task	FORTRAN 77: INTEGER4 task(2) for vslconvsetmode INTEGER4 task(2) for vslcorrsetmode Fortran 90: TYPE(VSL_CONV_TASK) for vslconvsetmode TYPE(VSL_CORR_TASK) for vslcorrsetmode C: VSLConvTaskPtr for vslConvSetMode VSLCorrTaskPtr for vslCorrSetMode	Pointer to the task descriptor.
newmode	FORTRAN 77: INTEGER Fortran 90: INTEGER C: const int	New value of the parameter mode.

Name

Type

Description

task

FORTRAN 77: INTEGER*4 task(2) for vslconvsetmode

INTEGER*4 task(2) for vslcorrsetmode

Fortran 90: TYPE(VSL_CONV_TASK) for vslconvsetmode

TYPE(VSL_CORR_TASK) for vslcorrsetmode

C: VSLConvTaskPtr for vslConvSetMode

VSLCorrTaskPtr for vslCorrSetMode

Pointer to the task descriptor.

newmode

FORTRAN 77: INTEGER

Fortran 90: INTEGER

C: const int

New value of the parameter mode.

Output Parameters

Name	Type	Description
status	FORTRAN 77: INTEGER Fortran 90: INTEGER C: int	Current status of the task.

Name

Type

Description

status

FORTRAN 77: INTEGER

Fortran 90: INTEGER

C: int

Current status of the task.

Description

This function is declared in mkl_vsl.f77 for FORTRAN 77 interface, in mkl_vsl.f90 for Fortran 90 interface, and in mkl_vsl_functions.h for C interface.

The function routine changes the value of the parameter mode for the operation of convolution or correlation. This parameter defines whether the computation should be done via Fourier transforms of the input/output data or using a direct algorithm. Initial value for mode is assigned by a task constructor.

Predefined values for the mode parameter are as follows:

Values of mode parameter
Value	Purpose
VSL_CONV_MODE_FFT	Compute convolution by using fast Fourier transform.
VSL_CORR_MODE_FFT	Compute correlation by using fast Fourier transform.
VSL_CONV_MODE_DIRECT	Compute convolution directly.
VSL_CORR_MODE_DIRECT	Compute correlation directly.
VSL_CONV_MODE_AUTO	Automatically choose direct or Fourier mode for convolution.
VSL_CORR_MODE_AUTO	Automatically choose direct or Fourier mode for correlation.