?jacobi_init

Initializes the solver for Jacobian calculations.

Syntax

Fortran:

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

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

C:

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

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

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 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.

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,n). Contains the Jacobian matrix of the function.

Output Parameters

handle

Data object of the _JACOBIMATRIX_HANDLE_t type in C/C++ and INTEGER*8 in FORTRAN.

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 mkl_rci.fi (Fortran) and mkl_rci.h (C) include files.


Submit feedback on this help topic

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