?trnlspbc_get

Retrieves the number of iterations, stop criterion, initial residual, and final residual.

Syntax

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);

Include Files

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.

Description

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 = 1 indicates that the algorithm has exceeded the maximum number of iterations.

st_cr = 2 indicates that Δ < eps(1)

st_cr = 3 indicates that ||F(x)||2 < eps(2)

st_cr = 4 indicates that the Jacobi matrix is singular. ||J(x)(1:m,j)||2 < eps(3), j = 1, ..., n

st_cr = 5 indicates that ||s||2 < eps(4)

st_cr = 6 indicates that ||F(x)||2 - ||F(x) - J(x)s||2 < eps(5),

where J(x) is the Jacobi matrix, Δ is the trust region area, F(x) is the value of the functional, and s is the trial step.

Input Parameters

handle

Type _TRNSPBC_HANDLE_t in C/C++ and INTEGER*8 in FORTRAN.

Output Parameters

iter

INTEGER. Contains the current number of iterations.

st_cr

INTEGER. Contains the stop criterion.

See Description for the parameter values and their meanings.

r1

REAL for strnlspbc_get

DOUBLE PRECISION for dtrnlspbc_get

Contains the residual, (||y - f(x)||) given the initial x.

r2

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.

res

INTEGER. Informs about the task completion.

res = TR_SUCCESS means the routine completed the task normally.


Submit feedback on this help topic

Copyright © 1994 - 2010, Intel Corporation. All rights reserved.