Retrieves the number of iterations, stop criterion, initial residual, and final residual.
Fortran:
res = strnlspbc_get(handle, iter, st_cr, r1, r2)
res = dtrnlspbc_get(handle, iter, st_cr, r1, r2)
C:
res = strnlspbc_get(&handle, &iter, &st_cr, &r1, &r2);
res = dtrnlspbc_get(&handle, &iter, &st_cr, &r1, &r2);
The Fortran interfaces are specified in the mkl_rci.fi include file and the C interfaces are specified in the mkl_rci.h include file.
The routine retrieves the current number of iterations, the stop criterion, the initial residual, and final residual.
The st_cr parameter contains the stop criterion:
st_cr Value |
Description |
|---|---|
1 |
The algorithm has exceeded the maximum number of iterations |
2 |
Δ < eps(1) |
3 |
||F(x)||2 < eps(2) |
4 |
The Jacobian matrix is singular. ||J(x)(1:m,j)||2 < eps(3), j = 1, ..., n |
5 |
||s||2 < eps(4) |
6 |
||F(x)||2 - ||F(x) - J(x)s||2 < eps(5) |
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 _TRNSPBC_HANDLE_t in C/C++ and INTEGER*8 in FORTRAN.
INTEGER. Contains the current number of iterations.
INTEGER. Contains the stop criterion.
See the Description section for the parameter values and their meanings.
REAL for strnlspbc_get
DOUBLE PRECISION for dtrnlspbc_get
Contains the residual, (||y - f(x)||) given the initial x.
REAL for strnlspbc_get
DOUBLE PRECISION for dtrnlspbc_get
Contains the final residual, that is, the value of the function (||y - f(x)||) of the final x resulting from the algorithm operation.
INTEGER. Informs about the task completion.
res = TR_SUCCESS - the routine completed the task normally.
TR_SUCCESS is defined in the mkl_rci.h and mkl_rci.fi include files.
Copyright © 1994 - 2011, Intel Corporation. All rights reserved.