vslConvExecX/vslCorrExecX

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 3/22/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-0507F1A6-57D2-4900-A48E-65A07181573C

View Details

vslConvExecX/vslCorrExecX

Computes convolution or correlation for multidimensional case with the fixed first operand vector.

Syntax

status = vslsConvExecX(task, y, ystride, z, zstride);

status = vsldConvExecX(task, y, ystride, z, zstride);

status = vslcConvExecX(task, y, ystride, z, zstride);

status = vslzConvExecX(task, y, ystride, z, zstride);

status = vslsCorrExecX(task, y, ystride, z, zstride);

status = vslcCorrExecX(task, y, ystride, z, zstride);

status = vslzCorrExecX(task, y, ystride, z, zstride);

status = vsldCorrExecX(task, y, ystride, z, zstride);

Include Files

mkl.h

Input Parameters

Name	Type	Description
task	VSLConvTaskPtr for vslsConvExecX, vsldConvExecX, vslcConvExecX, vslzConvExecX VSLCorrTaskPtr for vslsCorrExecX, vsldCorrExecX, vslcCorrExecX, vslzCorrExecX	Pointer to the task descriptor.
x ,y	const float[] for vslsConvExecX and vslsCorrExecX, const double[] for vsldConvExecX and vsldCorrExecX, const MKL_Complex8[] for vslcConvExecX and vslcCorrExecX, const MKL_Complex16[] for vslzConvExecX and vslzCorrExecX	Pointer to array containing input data (for the second operand vector). See Data Allocation for more information.
ystride ,zstride	const int[]	Strides for input and output data. For more information, see stride parameters.

Name

Type

Description

task

VSLConvTaskPtr for vslsConvExecX, vsldConvExecX, vslcConvExecX, vslzConvExecX

VSLCorrTaskPtr for vslsCorrExecX, vsldCorrExecX, vslcCorrExecX, vslzCorrExecX

Pointer to the task descriptor.

x ,y

const float[] for vslsConvExecX and vslsCorrExecX,

const double[] for vsldConvExecX and vsldCorrExecX,

const MKL_Complex8[] for vslcConvExecX and vslcCorrExecX,

const MKL_Complex16[] for vslzConvExecX and vslzCorrExecX

Pointer to array containing input data (for the second operand vector). See Data Allocation for more information.

ystride ,zstride

const int[]

Strides for input and output data. For more information, see stride parameters.

Output Parameters

Name	Type	Description
z	const float[] for vslsConvExecX and vslsCorrExecX, const double[] for vsldConvExecX and vsldCorrExecX, const MKL_Complex8[] for vslcConvExecX and vslcCorrExecX, const MKL_Complex16[] for vslzConvExecX and vslzCorrExecX	Pointer to the array that stores output data. See Data Allocation for more information.
status	int	Set to VSL_STATUS_OK if the task is executed successfully or set to non-zero error code otherwise.

Name

Type

Description

const float[] for vslsConvExecX and vslsCorrExecX,

const double[] for vsldConvExecX and vsldCorrExecX,

const MKL_Complex8[] for vslcConvExecX and vslcCorrExecX,

const MKL_Complex16[] for vslzConvExecX and vslzCorrExecX

Pointer to the array that stores output data. See Data Allocation for more information.

status

int

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

Description

Each of the vslConvExecX/vslCorrExecX routines computes convolution or correlation of the data provided by the arrays x and y and then stores the results in the array z. These routines represent a special version of the operation, which assumes that the first operand vector was set on the task construction stage and the task object keeps the pointer to the array x.

Parameters of the operation are read from the task descriptor created previously by a corresponding vslConvNewTaskX/vslCorrNewTaskX constructor and pointed to by task. If task is NULL, no operation is done.

Using this form of execution routines is recommended when you need to compute multiple convolutions or correlations with the same data vector in array x against different vectors in array y. This helps improve performance by eliminating unnecessary overhead in repeated computation of intermediate data required for the operation.

Parent topic: Task Execution Routines

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

vslConvExecX/vslCorrExecX

Syntax

Include Files

Input Parameters

Output Parameters

Description