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

vslConvNewTask1D/vslCorrNewTask1D

Creates a new convolution or correlation task descriptor for one-dimensional case.

Syntax

status = vslsConvNewTask1D(task, mode, xshape, yshape, zshape);

status = vsldConvNewTask1D(task, mode, xshape, yshape, zshape);

status = vslcConvNewTask1D(task, mode, xshape, yshape, zshape);

status = vslzConvNewTask1D(task, mode, xshape, yshape, zshape);

status = vslsCorrNewTask1D(task, mode, xshape, yshape, zshape);

status = vsldCorrNewTask1D(task, mode, xshape, yshape, zshape);

status = vslcCorrNewTask1D(task, mode, xshape, yshape, zshape);

status = vslzCorrNewTask1D(task, mode, 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.

xshape

const MKL_INT

Defines the length of the input data sequence for the source array x. See Data Allocation for more information.

yshape

const MKL_INT

Defines the length of the input data sequence for the source array y. See Data Allocation for more information.

zshape

const MKL_INT

Defines the length of the output data sequence to be stored in array z. See Data Allocation for more information.

Output Parameters

Name

Type

Description

task

VSLConvTaskPtr* for vslsConvNewTask1D, vsldConvNewTask1D, vslcConvNewTask1D, vslzConvNewTask1D

VSLCorrTaskPtr* for vslsCorrNewTask1D, vsldCorrNewTask1D, vslcCorrNewTask1D, vslzCorrNewTask1D

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 vslConvNewTask1D/vslCorrNewTask1D 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"). Unlike vslConvNewTask/vslCorrNewTask, these routines represent a special one-dimensional version of the constructor which assumes that the value of the parameter dims is 1. The parameters xshape, yshape, and zshape are equal to the number of elements read from the arrays x and y or stored to the array z. You explicitly assign the shape parameters when calling the constructor.