Developer Reference for Intel® oneAPI Math Kernel Library - C

Developer Reference

  • 0.9
  • 09/09/2020
  • Public Content
Contents

?trnlspbc_get

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

Syntax

MKL_INT
strnlspbc_get
(
_TRNSPBC_HANDLE_t
*
handle
,
MKL_INT
*
iter
,
MKL_INT
*
st_cr
,
float
*
r1
,
float
*
r2
);
MKL_INT
dtrnlspbc_get
(
_TRNSPBC_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
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.
Input Parameters
handle
Type
_TRNSPBC_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,
(||
y
 -
f
(
x
)||)
 given the initial
x
.
r2
Contains the final residual, that is, the value of the function
(||
y
 -
f
(
x
)||)
 of the final
x
 resulting from the algorithm operation.
res
Informs about the task completion.
res
 =
TR_SUCCESS
 - the routine completed the task normally.
TR_SUCCESS
 is defined in the
mkl_rci.h
 include file.

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804