?jacobi_init

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.