Intel® oneAPI Math Kernel Library Developer Reference - C
Retrieves the number of iterations, stop criterion, initial residual, and final residual.
MKL_INT strnlsp_get(_TRNSP_HANDLE_t* handle, MKL_INT* iter, MKL_INT* st_cr, float* r1, float* r2);
MKL_INT dtrnlsp_get (_TRNSP_HANDLE_t* handle, MKL_INT* iter, MKL_INT* st_cr, double* r1, double* r2);
The routine retrieves the current number of iterations, the stop criterion, the initial residual, and final residual.
The initial residual is the value of the functional (||y - f(x)||) of the initial x values provided by the user.
The final residual is the value of the functional (||y - f(x)||) of the final x resulting from the algorithm operation.
The st_cr parameter contains a number indicating the stop criterion:
st_cr Value |
Description |
|---|---|
1 |
The algorithm has exceeded the maximum number of iterations |
2 |
Δ < eps[0] |
3 |
||F(x)||2 < eps[1] |
4 |
The Jacobian matrix is singular. ||J(x)[m*(j-1)...m*j-1]||2 < eps[2], j = 1, ..., n |
5 |
||s||2 < eps[3] |
6 |
||F(x)||2 - ||F(x) - J(x)s||2 < eps[4] |
Note:
J(x) is the Jacobian matrix.
Δ is the trust-region area.
F(x) is the value of the functional.
s is the trial step.
Type _TRNSP_HANDLE_t.
Contains the current number of iterations.
Contains the stop criterion.
See the Description section for the parameter values and their meanings.
Contains the residual, (||y - f(x)||) given the initial x.
Contains the final residual, that is, the value of the functional (||y - f(x)||) of the final x resulting from the algorithm operation.
Indicates the task completion.
res = TR_SUCCESS - the routine completed the task normally.
TR_SUCCESS is defined in the mkl_rci.h include file.