?jacobix

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 7/13/2023

Version

Public

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

Visible to Intel only — GUID: GUID-654B56A8-AC2D-416B-980E-ED6D78408D9A

View Details

?jacobix

Alternative interface for?jacobi function for passing additional data into the objective function.

Syntax

MKL_INT sjacobix (USRFCNXS fcn, const MKL_INT* n, const MKL_INT * m, float* fjac, float* x, float* eps, void* user_data);

MKL_INT djacobix (USRFCNXD fcn, const MKL_INT* n, const MKL_INT * m, double* fjac, double* x, double* eps, void* user_data);

Include Files

mkl.h

Description

The ?jacobix routine presents an alternative interface for the ?jacobi function that enables you to pass additional data into the objective function fcn.

See calling and usage examples in the examples\solverc\source folderof your Intel® oneAPI Math Kernel Library (oneMKL) directory. Specifically, see ex_nlsqp_c_x.c and ex_nlsqp_bc_c_x.c.

Input Parameters

fcn

User-supplied subroutine to evaluate the function that defines the least squares problem. Called as fcn (m, n, x, f, user_data) with the following parameters:

Parameter		Description
Input Parameters
m		Pointer to the length of f.
n		Pointer to the length of x.
x		Array of size n. Vector, at which the function is evaluated. The fcn function should not change this parameter.
user_data		Pointer to your additional data, if any. Otherwise, a dummy argument.
Output Parameters
f		Array of size m; contains the function values at x.

You need to declare fcn as extern in the calling program.

n

Length of X.

m

Length of F.

x

Array of size n. Vector at which the function is evaluated.

eps

Precision of the Jacobian matrix calculation.

user_data

Pointer to your additional data. If there is no additional data, this is a dummy argument.

Output Parameters

fjac

Array of size m by n). Contains the Jacobian matrix of the function.

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.

Parent topic: Jacobian Matrix Calculation Routines

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for C

?jacobix

Syntax

Include Files

Description

Input Parameters

Output Parameters

See Also