Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 10/31/2024
Public
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.

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 (oneMKL) routines other than the Summary Statistics routines.