vslConvNewTask/vslCorrNewTask

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 6/24/2024

Version

Public

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

Visible to Intel only — GUID: GUID-ADB96099-29BC-4ACD-86D4-53EDF57B2EFD

View Details

vslConvNewTask/vslCorrNewTask

Creates a new convolution or correlation task descriptor for multidimensional case.

Syntax

status = vslsConvNewTask(task, mode, dims, xshape, yshape, zshape);

status = vsldConvNewTask(task, mode, dims, xshape, yshape, zshape);

status = vslcConvNewTask(task, mode, dims, xshape, yshape, zshape);

status = vslzConvNewTask(task, mode, dims, xshape, yshape, zshape);

status = vslsCorrNewTask(task, mode, dims, xshape, yshape, zshape);

status = vsldCorrNewTask(task, mode, dims, xshape, yshape, zshape);

status = vslcCorrNewTask(task, mode, dims, xshape, yshape, zshape);

status = vslzCorrNewTask(task, mode, dims, xshape, yshape, zshape);

Include Files

mkl.h

Input Parameters

Name	Type	Description
mode	const MKL_INT	Specifies whether convolution/correlation calculation must be performed by using a direct algorithm or through Fourier transform of the input data. See Table "Values of mode parameter" for a list of possible values.
dims	const MKL_INT	Rank of user data. Specifies number of dimensions for the input and output arrays `x`, `y`, and `z` used during the execution stage. Must be in the range from 1 to 7. The value is explicitly assigned by the constructor.
xshape	const int[]	Defines the shape of the input data for the source array `x`. See Data Allocation for more information.
yshape	const int[]	Defines the shape of the input data for the source array `y`. See Data Allocation for more information.
zshape	const int[]	Defines the shape of the output data to be stored in array `z`. See Data Allocation for more information.

Output Parameters

Name	Type	Description
task	VSLConvTaskPtr* for vslsConvNewTask, vsldConvNewTask, vslcConvNewTask, vslzConvNewTask VSLCorrTaskPtr* for vslsCorrNewTask, vsldCorrNewTask, vslcConvNewTask, vslzConvNewTask	Pointer to the task descriptor if created successfully or NULL pointer otherwise.
status	int	Set to VSL_STATUS_OK if the task is created successfully or set to non-zero error code otherwise.

Name

Type

Description

task

VSLConvTaskPtr* for vslsConvNewTask, vsldConvNewTask, vslcConvNewTask, vslzConvNewTask

VSLCorrTaskPtr* for vslsCorrNewTask, vsldCorrNewTask, vslcConvNewTask, vslzConvNewTask

Pointer to the task descriptor if created successfully or NULL pointer otherwise.

status

int

Set to VSL_STATUS_OK if the task is created successfully or set to non-zero error code otherwise.

Description

Each vslConvNewTask/vslCorrNewTask constructor creates a new convolution or correlation task descriptor with the user specified values for explicit parameters. The optional parameters are set to their default values (see Table "Convolution and Correlation Task Parameters").

The parameters xshape, yshape, and zshape define the shapes of the input and output data provided by the arrays x, y, and z, respectively. Each shape parameter is an array of integers with its length equal to the value of dims. You explicitly assign the shape parameters when calling the constructor. If the value of the parameter dims is 1, then xshape, yshape, zshape are equal to the number of elements read from the arrays x and y or stored to the array z. Note that values of shape parameters may differ from physical shapes of arrays x, y, and z if non-trivial strides are assigned.

If the constructor fails to create a task descriptor, it returns a NULL task pointer.

Parent topic: Convolution and Correlation Task Constructors

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for C

vslConvNewTask/vslCorrNewTask

Syntax

Include Files

Input Parameters

Output Parameters

Description