Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

vslConvSetMode/vslCorrSetMode

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

Syntax

status = vslConvSetMode(task, newmode);

status = vslCorrSetMode(task, newmode);

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

task

VSLConvTaskPtr for vslConvSetMode

VSLCorrTaskPtr for vslCorrSetMode

Pointer to the task descriptor.

newmode

const MKL_INT

New value of the parameter mode.

Output Parameters

Name

Type

Description

status

int

Current status of the task.

Description

This function is declared in mkl_vsl_functions.h.

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.