Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 10/31/2024
Public
Document Table of Contents

vslSSEditTask

Modifies address of an input/output parameter in the task descriptor.

Syntax

status = vslsSSEditTask(task, parameter, par_addr);

status = vsldSSEditTask(task, parameter, par_addr);

status = vsliSSEditTask(task, parameter, par_addr);

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

task

VSLSSTaskPtr

Descriptor of the task

parameter

const MKL_INT

Parameter to change

par_addr

const float* for vslsSSEditTask

const double* for vsldSSEditTask

const MKL_INT* for vsliSSEditTask

Address of the new parameter

Output Parameters

Name

Type

Description

status

int

Current status of the task

Description

The vslSSEditTask routine replaces the pointer to the parameter stored in the Summary Statistics task descriptor with the par_addr pointer. If you pass the NULL pointer to the editor, no changes take place in the task and a corresponding error code is returned. See Table "Parameters of Summary Statistics Task to Be Initialized or Modified" for the predefined values of the parameter.

Use the single (vslsssedittask) or double (vsldssedittask) version of the editor, to initialize single or double precision version task parameters, respectively. Use an integer version of the editor (vslissedittask) to initialize parameters of the integer type.

Parameters of Summary Statistics Task to Be Initialized or Modified

Parameter Value

Type

Purpose

Initialization

VSL_SS_ED_DIMEN

i

Address of a variable that holds the task dimension

Required. Positive integer value.

VSL_SS_ED_OBSERV_N

i

Address of a variable that holds the number of observations

Required. Positive integer value.

VSL_SS_ED_OBSERV

d, s

Address of the observation matrix

Required. Provide the matrix containing your observations.

VSL_SS_ED_OBSERV_STORAGE

i

Address of a variable that holds the storage format for the observation matrix

Required. Provide a storage format supported by the library whenever you pass a matrix of observations.1

VSL_SS_ED_INDC

i

Address of the array of indices

Optional. Provide this array if you need to process individual components of the random vector. Set entry i of the array to one to include the ith coordinate in the analysis. Set entry i of the array to zero to exclude the ith coordinate from the analysis.

  1. See Table: "Storage format of matrix of observations and order statistics" for storage formats.

  2. See Table: "Storage formats of a variance-covariance/correlation matrix" for storage formats.