Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/31/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

Summary Statistics Task Status and Error Reporting

The task status is an integer value, which is zero if no error is detected, or a specific non-zero error code otherwise. Negative status values indicate errors, and positive values indicate warnings. An error can be caused by invalid parameter values or a memory allocation failure.

The header files define symbolic names for the status codes. These names are defined as macros via #define statements.

The header files define the following status codes for the Summary Statistics error codes:

Summary Statistics Status Codes

Status Code

Description

VSL_STATUS_OK

Operation is successfully completed.

VSL_SS_ERROR_ALLOCATION_FAILURE

Memory allocation has failed.

VSL_SS_ERROR_BAD_DIMEN

Dimension value is invalid.

VSL_SS_ERROR_BAD_OBSERV_N

Invalid number (zero or negative) of observations was obtained.

VSL_SS_ERROR_STORAGE_NOT_SUPPORTED

Storage format is not supported.

VSL_SS_ERROR_BAD_INDC_ADDR

Array of indices is not defined.

VSL_SS_ERROR_BAD_WEIGHTS

Array of weights contains negative values.

VSL_SS_ERROR_BAD_MEAN_ADDR

Array of means is not defined.

VSL_SS_ERROR_BAD_2R_MOM_ADDR

Array of the second order raw moments is not defined.

VSL_SS_ERROR_BAD_3R_MOM_ADDR

Array of the third order raw moments is not defined.

VSL_SS_ERROR_BAD_4R_MOM_ADDR

Array of the fourth order raw moments is not defined.

VSL_SS_ERROR_BAD_2C_MOM_ADDR

Array of the second order central moments is not defined.

VSL_SS_ERROR_BAD_3C_MOM_ADDR

Array of the third order central moments is not defined.

VSL_SS_ERROR_BAD_4C_MOM_ADDR

Array of the fourth order central moments is not defined.

VSL_SS_ERROR_BAD_KURTOSIS_ADDR

Array of kurtosis values is not defined.

VSL_SS_ERROR_BAD_SKEWNESS_ADDR

Array of skewness values is not defined.

VSL_SS_ERROR_BAD_MIN_ADDR

Array of minimum values is not defined.

VSL_SS_ERROR_BAD_MAX_ADDR

Array of maximum values is not defined.

VSL_SS_ERROR_BAD_VARIATION_ADDR

Array of variation coefficients is not defined.

VSL_SS_ERROR_BAD_COV_ADDR

Covariance matrix is not defined.

VSL_SS_ERROR_BAD_COR_ADDR

Correlation matrix is not defined.

VSL_SS_ERROR_BAD_QUANT_ORDER_ADDR

Array of quantile orders is not defined.

VSL_SS_ERROR_BAD_QUANT_ORDER

Quantile order value is invalid.

VSL_SS_ERROR_BAD_QUANT_ADDR

Array of quantiles is not defined.

VSL_SS_ERROR_BAD_ORDER_STATS_ADDR

Array of order statistics is not defined.

VSL_SS_ERROR_MOMORDER_NOT_SUPPORTED

Moment of requested order is not supported.

VSL_SS_NOT_FULL_RANK_MATRIX

Correlation matrix is not of full rank.

VSL_SS_ERROR_ALL_OBSERVS_OUTLIERS

All observations are outliers. (At least one observation must not be an outlier.)

VSL_SS_ERROR_BAD_ROBUST_COV_ADDR

Robust covariance matrix is not defined.

VSL_SS_ERROR_BAD_ROBUST_MEAN_ADDR

Array of robust means is not defined.

VSL_SS_ERROR_METHOD_NOT_SUPPORTED

Requested method is not supported.

VSL_SS_ERROR_NULL_TASK_DESCRIPTOR

Task descriptor is null.

VSL_SS_ERROR_BAD_OBSERV_ADDR

Dataset matrix is not defined.

VSL_SS_ERROR_BAD_ACCUM_WEIGHT_ADDR

Pointer to the variable that holds the value of accumulated weight is not defined.

VSL_SS_ERROR_SINGULAR_COV

Covariance matrix is singular.

VSL_SS_ERROR_BAD_POOLED_COV_ADDR

Pooled covariance matrix is not defined.

VSL_SS_ERROR_BAD_POOLED_MEAN_ADDR

Array of pooled means is not defined.

VSL_SS_ERROR_BAD_GROUP_COV_ADDR

Group covariance matrix is not defined.

VSL_SS_ERROR_BAD_GROUP_MEAN_ADDR

Array of group means is not defined.

VSL_SS_ERROR_BAD_GROUP_INDC_ADDR

Array of group indices is not defined.

VSL_SS_ERROR_BAD_GROUP_INDC

Group indices have improper values.

VSL_SS_ERROR_BAD_OUTLIERS_PARAMS_ADDR

Array of parameters for the outlier detection algorithm is not defined.

VSL_SS_ERROR_BAD_OUTLIERS_PARAMS_N_ADDR

Pointer to size of the parameter array for the outlier detection algorithm is not defined.

VSL_SS_ERROR_BAD_OUTLIERS_WEIGHTS_ADDR

Output of the outlier detection algorithm is not defined.

VSL_SS_ERROR_BAD_ROBUST_COV_PARAMS_ADDR

Array of parameters of the robust covariance estimation algorithm is not defined.

VSL_SS_ERROR_BAD_ROBUST_COV_PARAMS_N_ADDR

Pointer to the number of parameters of the algorithm for robust covariance is not defined.

VSL_SS_ERROR_BAD_STORAGE_ADDR

Pointer to the variable that holds the storage format is not defined.

VSL_SS_ERROR_BAD_PARTIAL_COV_IDX_ADDR

Array that encodes sub-components of a random vector for the partial covariance algorithm is not defined.

VSL_SS_ERROR_BAD_PARTIAL_COV_IDX

Array that encodes sub-components of a random vector for partial covariance has improper values.

VSL_SS_ERROR_BAD_PARTIAL_COV_ADDR

Partial covariance matrix is not defined.

VSL_SS_ERROR_BAD_PARTIAL_COR_ADDR

Partial correlation matrix is not defined.

VSL_SS_ERROR_BAD_MI_PARAMS_ADDR

Array of parameters for the Multiple Imputation method is not defined.

VSL_SS_ERROR_BAD_MI_PARAMS_N_ADDR

Pointer to number of parameters for the Multiple Imputation method is not defined.

VSL_SS_ERROR_BAD_MI_BAD_PARAMS_N

Size of the parameter array of the Multiple Imputation method is invalid.

VSL_SS_ERROR_BAD_MI_PARAMS

Parameters of the Multiple Imputation method are invalid.

VSL_SS_ERROR_BAD_MI_INIT_ESTIMATES_N_ADDR

Pointer to the number of initial estimates in the Multiple Imputation method is not defined.

VSL_SS_ERROR_BAD_MI_INIT_ESTIMATES_ADDR

Array of initial estimates for the Multiple Imputation method is not defined.

VSL_SS_ERROR_BAD_MI_SIMUL_VALS_ADDR

Array of simulated missing values in the Multiple Imputation method is not defined.

VSL_SS_ERROR_BAD_MI_SIMUL_VALS_N_ADDR

Pointer to the size of the array of simulated missing values in the Multiple Imputation method is not defined.

VSL_SS_ERROR_BAD_MI_ESTIMATES_N_ADDR

Pointer to the number of parameter estimates in the Multiple Imputation method is not defined.

VSL_SS_ERROR_BAD_MI_ESTIMATES_ADDR

Array of parameter estimates in the Multiple Imputation method is not defined.

VSL_SS_ERROR_BAD_MI_SIMUL_VALS_N

Invalid size of the array of simulated values in the Multiple Imputation method.

VSL_SS_ERROR_BAD_MI_ESTIMATES_N

Invalid size of an array to hold parameter estimates obtained using the Multiple Imputation method.

VSL_SS_ERROR_BAD_MI_OUTPUT_PARAMS

Array of output parameters in the Multiple Imputation method is not defined.

VSL_SS_ERROR_BAD_MI_PRIOR_N_ADDR

Pointer to the number of prior parameters is not defined.

VSL_SS_ERROR_BAD_MI_PRIOR_ADDR

Array of prior parameters is not defined.

VSL_SS_ERROR_BAD_MI_MISSING_VALS_N

Invalid number of missing values was obtained.

VSL_SS_SEMIDEFINITE_COR

Correlation matrix passed into the parameterization function is semi-definite.

VSL_SS_ERROR_BAD_PARAMTR_COR_ADDR

Correlation matrix to be parameterized is not defined.

VSL_SS_ERROR_BAD_COR

All eigenvalues of the correlation matrix to be parameterized are non-positive.

VSL_SS_ERROR_BAD_STREAM_QUANT_PARAMS_N_ADDR

Pointer to the number of parameters for the quantile computation algorithm for streaming data is not defined.

VSL_SS_ERROR_BAD_STREAM_QUANT_PARAMS_ADDR

Array of parameters of the quantile computation algorithm for streaming data is not defined.

VSL_SS_ERROR_BAD_STREAM_QUANT_PARAMS_N

Invalid number of parameters of the quantile computation algorithm for streaming data has been obtained.

VSL_SS_ERROR_BAD_STREAM_QUANT_PARAMS

Invalid parameters of the quantile computation algorithm for streaming data have been passed.

VSL_SS_ERROR_BAD_STREAM_QUANT_ORDER_ADDR

Array of the quantile orders for streaming data is not defined.

VSL_SS_ERROR_BAD_STREAM_QUANT_ORDER

Invalid quantile order for streaming data is defined.

VSL_SS_ERROR_BAD_STREAM_QUANT_ADDR

Array of quantiles for streaming data is not defined.

VSL_SS_ERROR_BAD_SUM_ADDR

Array of sums is not defined.

VSL_SS_ERROR_BAD_2R_SUM_ADDR

Array of raw sums of 2nd order is not defined.

VSL_SS_ERROR_BAD_3R_SUM_ADDR

Array of raw sums of 3rd order is not defined.

VSL_SS_ERROR_BAD_4R_SUM_ADDR

Array of raw sums of 4th order is not defined.

VSL_SS_ERROR_BAD_2C_SUM_ADDR

Array of central sums of 2nd order is not defined.

VSL_SS_ERROR_BAD_3C_SUM_ADDR

Array of central sums of 3rd order is not defined.

VSL_SS_ERROR_BAD_4C_SUM_ADDR

Array of central sums of 4th order is not defined.

VSL_SS_ERROR_BAD_CP_SUM_ADDR

Cross-product matrix is not defined.

VSL_SS_ERROR_BAD_MDAD_ADDR

Array of median absolute deviations is not defined.

VSL_SS_ERROR_BAD_MNAD_ADDR

Array of mean absolute deviations is not defined.

VSL_SS_ERROR_BAD_SORTED_OBSERV_ADDR

Array for storing observation sorting results is not defined.

VSL_SS_ERROR_ERROR_INDICES_NOT_SUPPORTED

Array of indices is not supported.

Routines for robust covariance estimation, outlier detection, partial covariance estimation, multiple imputation, and parameterization of a correlation matrix can return internal error codes that are related to a specific implementation. Such error codes indicate invalid input data or other bugs in the Intel® oneAPI Math Kernel Library routines other than the Summary Statistics routines.