Developer Reference for Intel® oneAPI Math Kernel Library - C

Developer Reference

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

?jacobi_init

Initializes the solver for Jacobian calculations.

Syntax

MKL_INT
sjacobi_init
(
_JACOBIMATRIX_HANDLE_t
*
handle
,
const
MKL_INT
*
n
,
const
MKL_INT
*
m
,
const
float
*
x
,
const
float
*
fjac
,
const
float
*
eps
);
MKL_INT
djacobi_init
(
_JACOBIMATRIX_HANDLE_t
*
handle
,
const
MKL_INT
*
n
,
const
MKL_INT
*
m
,
const
double
*
x
,
const
double
*
fjac
,
const
double
*
eps
);
Include Files
  • mkl.h
Description
The routine initializes the solver.
Input Parameters
n
Length of
x
.
m
Length of
F
.
x
Array of size
n
. Vector, at which the function is evaluated.
A reference to this array is stored in
handle
 for later use and modification by
?jacobi_solve
.
eps
Precision of the Jacobian matrix calculation.
fjac
Array of size
m
 by
n
. Contains the Jacobian matrix of the function.
A reference to this array is stored in
handle
 for later use and modification by
?jacobi_solve
.
Output Parameters
handle
Data object of the
_JACOBIMATRIX_HANDLE_t
 type
. Stores internal data, including pointers to the user-provided arrays
x
 and
fjac
. It is important that the user does not move or deallocate these arrays until after calling the
?jacobi_delete
 routine.
res
Indicates task completion status.
  • res
     =
    TR_SUCCESS
     - the routine completed the task normally.
  • res
     =
    TR_INVALID_OPTION
     - there was an error in the input parameters.
  • res
     =
    TR_OUT_OF_MEMORY
     - there was a memory error.
TR_SUCCESS
,
TR_INVALID_OPTION
, and
TR_OUT_OF_MEMORY
 are 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