?trnlsp_check

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 7/13/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-4841BEA2-CB3D-4F31-BB80-3F9540B35B6C

View Details

?trnlsp_check

Checks the correctness of handle and arrays containing Jacobian matrix, objective function, and stopping criteria.

Syntax

MKL_INT strnlsp_check (_TRNSP_HANDLE_t* handle, const MKL_INT* n, const MKL_INT* m, const float* fjac, const float* fvec, const float* eps, MKL_INT* info);

MKL_INT dtrnlsp_check (_TRNSP_HANDLE_t* handle, const MKL_INT* n, const MKL_INT* m, const double* fjac, const double* fvec, const double* eps, MKL_INT* info);

Include Files

mkl.h

Description

The ?trnlsp_check routine checks the arrays passed into the solver as input parameters. If an array contains any INF or NaN values, the routine sets the flag in output array info(see the description of the values returned in the Output Parameters section for the info array).

Input Parameters

handle: Type _TRNSPBC_HANDLE_t.
n: Length of x.
m: Length of F(x).
fjac: Array of size m by n. Contains the Jacobian matrix of the function.
fvec: Array of size m. Contains the function values at X, where fvec[i] = (y_i – f_i(x)).
eps: Array of size 6; contains stopping criteria. See the values in the Description section of the ?trnlsp_init.

Output Parameters

info

Array of size 6.

Results of input parameter checking:

Parameter	Used for	Value	Description
info[0]	Flags for handle	`0`	The handle is valid.
info[0]	Flags for handle	`1`	The handle is not allocated.
info[1]	Flags for fjac	`0`	The fjac array is valid.
		`1`	The fjac array is not allocated
		`2`	The fjac array contains NaN.
		`3`	The fjac array contains Inf.
info[2]	Flags for fvec	`0`	The fvec array is valid.
		`1`	The fvec array is not allocated The fvec array contains NaN.
		`2`
		`3`	The fvec array contains Inf.
info[3]	Flags for eps	`0`	The eps array is valid.
		`1`	The eps array is not allocated
		`2`	The eps array contains NaN.
		`3`	The eps array contains Inf.
		`4`	The eps array contains a value less than or equal to zero.

res

Information about completion of the task.

res = TR_SUCCESS - the routine completed the task normally.

TR_SUCCESS is defined in the mkl_rci.h include file.

Parent topic: Nonlinear Least Squares Problem without Constraints

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

?trnlsp_check

Syntax

Include Files

Description

Input Parameters

Output Parameters