Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 12/16/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

?jacobi_init

Initializes the solver for Jacobian calculations.

Syntax

res = sjacobi_init(handle, n, m, x, fjac, eps)

res = djacobi_init(handle, n, m, x, fjac, eps)

Include Files
  • Fortran: mkl_rci.fi, mkl_rci.f90
Description

The routine initializes the solver.

Input Parameters
n
INTEGER. Length of x.
m

INTEGER. Length of F.

x

REAL for sjacobi_init

DOUBLE PRECISION for djacobi_init

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

REAL for sjacobi_init

DOUBLE PRECISION for djacobi_init

Precision of the Jacobian matrix calculation.

fjac

REAL for sjacobi_init

DOUBLE PRECISION for djacobi_init

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 INTEGER*8. 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

INTEGER. 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.fi include file.