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

vslConvSetDecimation/vslCorrSetDecimation

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

Syntax

status = vslConvSetDecimation(task, decimation);

status = vslCorrSetDecimation(task, decimation);

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

task

VSLConvTaskPtr for vslConvSetDecimation

VSLCorrTaskPtr for vslCorrSetDecimation

Pointer to the task descriptor.

decimation

const int[]

New value of the parameter decimation.

Output Parameters

Name

Type

Description

status

int

Current status of the task.

Description

The routine sets the value of the parameter decimation for the operation of convolution or correlation. This parameter determines how to thin out the mathematical result of convolution or correlation before writing it into the output data array. For example, in a one-dimensional case, if decimation = d > 1, only every d-th element of the mathematical result is written to the output array z. In a multidimensional case, decimation is an array of indices and its length is equal to the number of dimensions specified by the parameter dims. For more information about the definition and effect of this parameter, see Data Allocation.

During the initial task descriptor construction, the default value for decimation is undefined and this parameter is not used. Therefore the only way to set and use the decimation parameter is via assigning it some value by one of the vslSetDecimation routines.