vslSSNewTask

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 3/31/2023

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-49A28D42-1C6D-439F-A9BB-A9DA7EF4BB86

View Details

vslSSNewTask

Creates and initializes a new summary statistics task descriptor.

Syntax

status = vslsSSNewTask(&task, p, n, xstorage, x, w, indices);

status = vsldSSNewTask(&task, p, n, xstorage, x, w, indices);

Include Files

mkl.h

Input Parameters

Name	Type	Description
p	const MKL_INT*	Dimension of the task, number of variables
n	const MKL_INT*	Number of observations
xstorage	const MKL_INT*	Storage format of matrix of observations
x	const float* for vslsSSNewTask const double* for vsldSSNewTask	Matrix of observations
w	const float* for vslsSSNewTask const double* for vsldSSNewTask	Array of weights of size n. Elements of the arrays are non-negative numbers. If a NULL pointer is passed, each observation is assigned weight equal to 1.
indices	const MKL_INT*	Array of vector components that will be processed. Size of array is p. If a NULL pointer is passed, all components of random vector are processed.

Output Parameters

Name	Type	Description
task	VSLSSTaskPtr*	Descriptor of the task
status	int	Set to VSL_STATUS_OK if the task is created successfully, otherwise a non-zero error code is returned.

Description

Each vslSSNewTask constructor routine creates a new summary statistics task descriptor with the user-specified value for a required parameter, dimension of the task. The optional parameters (matrix of observations, its storage format, number of observations, weights of observations, and indices of the random vector components) are set to their default values.

The observations of random p-dimensional vector ξ = (ξ₁, ..., ξ_i, ..., ξ_p), which are n vectors of dimension p, are passed as a one-dimensional array x. The parameter xstorage defines the storage format of the observations and takes one of the possible values listed in Table "Storage format of matrix of observations and order statistics".

Storage format of matrix of observations, order statistics, and matrix of sorted observations
Parameter	Description
VSL_SS_MATRIX_STORAGE_ROWS	The observations of random vector ξ are packed by rows: n data points for the vector component ξ₁ come first, n data points for the vector component ξ₂ come second, and so forth.
VSL_SS_MATRIX_STORAGE_COLS	The observations of random vector ξ are packed by columns: the first p-dimensional observation of the vector ξ comes first, the second p-dimensional observation of the vector comes second, and so forth.

A one-dimensional array w of size n contains non-negative weights assigned to the observations. You can pass a NULL array into the constructor. In this case, each observation is assigned the default value of the weight.

You can choose vector components for which you wish to compute statistical estimates. If an element of the vector indices of size p contains 0, the observations that correspond to this component are excluded from the calculations. If you pass the NULL value of the parameter into the constructor, statistical estimates for all random variables are computed.

If the constructor fails to create a task descriptor, it returns the NULL task pointer.

Parent topic: Summary Statistics Task Constructors

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

vslSSNewTask