?trnlsp_get
?trnlsp_get
Retrieves the number of iterations, stop criterion, initial residual, and final residual.
Syntax
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
);
Include Files
- mkl.h
Description
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
(||
of the initial y
- f
(x
)||)x
values provided by the user.The final residual is the value of the functional
(||
of the final y
- f
(x
)||)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:
- is the Jacobian matrix.J(x)
- Δis the trust-region area.
- is the value of the functional.F(x)
- sis the trial step.
Input Parameters
- handle
- Type._TRNSP_HANDLE_t
Output Parameters
- iter
- Contains the current number of iterations.
- st_cr
- Contains the stop criterion.See the Description section for the parameter values and their meanings.
- r1
- Contains the residual,(||given the initialy-f(x)||)x.
- r2
- Contains the final residual, that is, the value of the functional(||of the finaly-f(x)||)xresulting from the algorithm operation.
- res
- Indicates the task completion.res=TR_SUCCESS- the routine completed the task normally.TR_SUCCESSis defined in themkl_rci.hinclude file.