Developer Reference for Intel® oneAPI Math Kernel Library - C

Developer Reference

Contents

?trnlspbc_check

Checks the correctness of handle and arrays containing Jacobian matrix, objective function, lower and upper bounds, and stopping criteria.

Syntax

MKL_INT
strnlspbc_check
(
_TRNSPBC_HANDLE_t
*
handle
,
const
MKL_INT
*
n
,
const
MKL_INT
*
m
,
const
float
*
fjac
,
const
float
*
fvec
,
const
float
*
LW
,
const
float
*
UP
,
const
float
*
eps
,
MKL_INT
*
info
);
MKL_INT
dtrnlspbc_check
(
_TRNSPBC_HANDLE_t
*
handle
,
const
MKL_INT
*
n
,
const
MKL_INT
*
m
,
const
double
*
fjac
,
const
double
*
fvec
,
const
double
*
LW
,
const
double
*
UP
,
const
double
*
eps
,
MKL_INT
*
info
);
Include Files
  • mkl.h
Description
The
?trnlspbc_check
 routine checks the arrays passed into the solver as input parameters. If an array contains any
INF
 or
NaN
 values, the routine sets the flag in output array
info
(see the description of the values returned in the Output Parameters section for the
info
 array)
.
Input Parameters
handle
Type
_TRNSPBC_HANDLE_t
.
n
Length of
x
.
m
Length of
F
(
x
).
fjac
Array of size
m
 by
n
. Contains the Jacobian matrix of the function.
fvec
Array of size
m
. Contains the function values at
X
, where
fvec
[
i
]
= (
y
i
 –
f
i
(
x
))
.
LW
Array of size
n
.
Contains low bounds for
x
 (
lw
i
 <
x
i
 ).
UP
Array of size
n
.
Contains upper bounds for
x
 (
up
i
 >
x
i
 ).
eps
Array of size 6; contains stopping criteria.
See the values in the Description section of the
?trnlspbc_init
.
Output Parameters
info
Array of size 6.
Results of input parameter checking:
Parameter
Used for
Value
Description
info
[0]
Flags for
handle
0
The handle is valid.
1
The handle is not allocated.
info
[1]
Flags for
fjac
0
The
fjac
 array is valid.
1
The
fjac
 array is not allocated
2
The
fjac
 array contains
NaN
.
3
The
fjac
 array contains
Inf
.
info
[2]
Flags for
fvec
0
The
fvec
 array is valid.
1
The
fvec
 array is not allocated
2
The
fvec
 array contains
NaN
.
3
The
fvec
 array contains
Inf
.
info
[3]
Flags for
LW
0
The
LW
 array is valid.
1
The
LW
 array is not allocated
2
The
LW
 array contains
NaN
.
3
The
LW
 array contains
Inf
.
4
The lower bound is greater than the upper bound.
info
[4]
Flags for
up
0
The
up
 array is valid.
1
The
up
 array is not allocated
2
The
up
 array contains
NaN
.
3
The
up
 array contains
Inf
.
4
The upper bound is less than the lower bound.
info
[5]
Flags for
eps
0
The
eps
 array is valid.
1
The
eps
 array is not allocated
2
The
eps
 array contains
NaN
.
3
The
eps
 array contains
Inf
.
4
The
eps
 array contains a value less than or equal to zero.
res
Information about completion of the task.
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

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.