Task Status and Error Reporting

The Data Fitting routines report a task status through integer values. Negative status values indicate errors, while positive values indicate warnings. An error can be caused by invalid parameter values or a memory allocation failure.

The status codes have symbolic names predefined in the header file: for the C/C++ interface, these names are defined as macros via the #define statements; for the Fortran interface, the names are defined as integer constants via the PARAMETER operators.

If no error occurred, the function returns the DF_STATUS_OK code defined as zero:

C/C++:
#define DF_STATUS_OK 0
F90/F95:
INTEGER, PARAMETER::DF_STATUS_OK = 0

In case of an error, the function returns a non-zero error code that specifies the origin of the failure. Header files for both C/C++ and Fortran languages define the following status codes:

Status Codes in the Data Fitting Component

Status Code

Description

Common Status Codes

DF_STATUS_OK

Operation completed successfully.

DF_ERROR_NULL_TASK

Data Fitting task is a NULL pointer.

DF_ERROR_MEM_FAILURE

Memory allocation failure.

DF_ERROR_METHOD_NOT_SUPPORTED

Requested method is not supported.

DF_ERROR_COMP_TYPE_NOT_SUPPORTED

Requested computation type is not supported.

DF_ERROR_NULL_PTR

Pointer to parameter is null.

Data Fitting Task Creation and Initialization, and Generic Editing Operations

DF_ERROR_BAD_NX

Invalid number of breakpoints.

DF_ERROR_BAD_X

Array of breakpoints is invalid.

DF_ERROR_BAD_X_HINT

Invalid hint describing the structure of the partition.

DF_ERROR_BAD_NY

Invalid dimension of vector-valued function y.

DF_ERROR_BAD_Y

Array of function values is invalid.

DF_ERROR_BAD_Y_HINT

Invalid flag describing the structure of function y

Data Fitting Task-Specific Editing Operations

DF_ERROR_BAD_SPLINE_ORDER

Invalid spline order.

DF_ERROR_BAD_SPLINE_TYPE

Invalid spline type.

DF_ERROR_BAD_IC_TYPE

Type of internal conditions used for spline construction is invalid.

DF_ERROR_BAD_IC

Array of internal conditions for spline construction is not defined.

DF_ERROR_BAD_BC_TYPE

Type of boundary conditions used in spline construction is invalid.

DF_ERROR_BAD_BC

Array of boundary conditions for spline construction is not defined.

DF_ERROR_BAD_PP_COEFF

Array of piecewise polynomial spline coefficients is not defined.

DF_ERROR_BAD_PP_COEFF_HINT

Invalid flag describing the structure of the piecewise polynomial spline coefficients.

DF_ERROR_BAD_PERIODIC_VAL

Function values at the endpoints of the interpolation interval are not equal as required in periodic boundary conditions.

DF_ERROR_BAD_DATA_ATTR

Invalid attribute of the pointer to be set or modified in Data Fitting task descriptor with the df?editidxptr task editor.

DF_ERROR_BAD_DATA_IDX

Index of the pointer to be set or modified in the Data Fitting task descriptor with the df?editidxptr task editor is out of the pre-defined range.

Data Fitting Computation Operations

DF_ERROR_BAD_NSITE

Invalid number of interpolation sites.

DF_ERROR_BAD_SITE

Array of interpolation sites is not defined.

DF_ERROR_BAD_SITE_HINT

Invalid flag describing the structure of interpolation sites.

DF_ERROR_BAD_NDORDER

Invalid size of the array defining derivative orders to be computed at interpolation sites.

DF_ERROR_BAD_DORDER

Array defining derivative orders to be computed at interpolation sites is not defined.

DF_ERROR_BAD_DATA_HINT

Invalid flag providing additional information about partition or interpolation sites.

DF_ERROR_BAD_INTERP

Array of spline-based interpolation results is not defined.

DF_ERROR_BAD_INTERP_HINT

Invalid flag defining the structure of spline-based interpolation results.

DF_ERROR_BAD_CELL_IDX

Array of indices of partition cells containing interpolation sites is not defined.

DF_ERROR_BAD_NLIM

Invalid size of arrays containing integration limits.

DF_ERROR_BAD_LLIM

Array of the left-side integration limits is not defined.

DF_ERROR_BAD_RLIM

Array of the right-side integration limits is not defined.

DF_ERROR_BAD_INTEGR

Array of spline-based integration results is not defined.

DF_ERROR_BAD_INTEGR_HINT

Invalid flag providing the structure of the array of spline-based integration results.

DF_ERROR_BAD_LOOKUP_INTERP_SITE

Bad site provided for interpolation with look-up interpolator.

Note

The routine that estimates piecewise polynomial cubic spline coefficients can return internal error codes related to the specifics of the implementation. Such error codes indicate invalid input data or other issues unrelated to Data Fitting routines.

For more complete information about compiler optimizations, see our Optimization Notice.