Developer Reference

  • 0.10
  • 10/21/2020
  • Public Content
Contents

vslConvNewTaskX
/
vslCorrNewTaskX

Creates a new convolution or correlation task descriptor for multidimensional case and assigns source data to the first operand vector.

Syntax

status
=
vslsConvNewTaskX
(
task
,
mode
,
dims
,
xshape
,
yshape
,
zshape
,
x
,
xstride
);
status
=
vsldConvNewTaskX
(
task
,
mode
,
dims
,
xshape
,
yshape
,
zshape
,
x
,
xstride
);
status
=
vslcConvNewTaskX
(
task
,
mode
,
dims
,
xshape
,
yshape
,
zshape
,
x
,
xstride
);
status
=
vslzConvNewTaskX
(
task
,
mode
,
dims
,
xshape
,
yshape
,
zshape
,
x
,
xstride
);
status
=
vslsCorrNewTaskX
(
task
,
mode
,
dims
,
xshape
,
yshape
,
zshape
,
x
,
xstride
);
status
=
vsldCorrNewTaskX
(
task
,
mode
,
dims
,
xshape
,
yshape
,
zshape
,
x
,
xstride
);
status
=
vslcCorrNewTaskX
(
task
,
mode
,
dims
,
xshape
,
yshape
,
zshape
,
x
,
xstride
);
status
=
vslzCorrNewTaskX
(
task
,
mode
,
dims
,
xshape
,
yshape
,
zshape
,
x
,
xstride
);
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.
x
const float[]
for real data in single precision flavors,
const double[]
for real data in double precision flavors,
const MKL_Complex8[]
for complex data in single precision flavors,
const MKL_Complex16[]
for complex data in double precision flavors
Pointer to the array containing input data for the first operand vector.
See Data Allocation for more information.
xstride
const int[]
Strides for input data in the array
x
.
Output Parameters
Name
Type
Description
task
VSLConvTaskPtr*
for
vslsConvNewTaskX
,
vsldConvNewTaskX
,
vslcConvNewTaskX
,
vslzConvNewTaskX
VSLCorrTaskPtr*
for
vslsCorrNewTaskX
,
vsldCorrNewTaskX
,
vslcCorrNewTaskX
,
vslzCorrNewTaskX
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
vslConvNewTaskX
/
vslCorrNewTaskX
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 the so called X-form version of the constructor, which means that in addition to creating the task descriptor they assign particular data to the first operand vector in array
x
used in convolution or correlation operation. The task descriptor created by the
vslConvNewTaskX
/
vslCorrNewTaskX
constructor keeps the pointer to the array
x
all the time, that is, until the task object is deleted by one of the destructor routines (see
vslConvDeleteTask
/
vslCorrDeleteTask
).
Using this form of constructors 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.
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
, and
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.
The stride parameter
xstride
specifies the physical location of the input data in the array
x
. In a one-dimensional case, stride is an interval between locations of consecutive elements of the array. For example, if the value of the parameter
xstride
is
s
, then only every
s
th
element of the array
x
will be used to form the input sequence. The stride value must be positive or negative but not zero.

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804