?trnlspbc

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 3/22/2024

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-B6BADF1C-F90C-4D30-8B84-CF9A5F970E08

View Details

?trnlspbc_init

Initializes the solver of nonlinear least squares problem with linear (boundary) constraints.

Syntax

MKL_INT strnlspbc_init (_TRNSPBC_HANDLE_t* handle, const MKL_INT* n, const MKL_INT* m, const float* x, const float* LW, const float* UP, const float* eps, const MKL_INT* iter1, const MKL_INT* iter2, const float* rs);

MKL_INT dtrnlspbc_init (_TRNSPBC_HANDLE_t* handle, const MKL_INT* n, const MKL_INT* m, const double* x, const double* LW, const double* UP, const double* eps, const MKL_INT* iter1, const MKL_INT* iter2, const double* rs);

Description

The ?trnlspbc_init routine initializes the solver.

After initialization, all subsequent invocations of the ?trnlspbc_solve routine should use the values of the handle returned by ?trnlspbc_init. This handle stores internal data, including pointers to the arrays x, LW, UP, and eps. It is important to not move or deallocate these arrays until after calling the ?trnlspbc_delete routine.

The eps array contains a number indicating the stopping criteria:

eps Value	Description
0	`Δ < eps[0]`
1	`\|\|F(x)\|\|₂ < eps[1]`
2	The Jacobian matrix is singular. `\|\|J(x)_{[m(j-1)...mj-1]}\|\|₂ < eps[2], j = 1, ..., n`
3	`\|\|s\|\|₂ < eps[3]`
4	`\|\|F(x)\|\|₂ - \|\|F(x) - J(x)s\|\|₂ < \|eps[4]`\| NOTE: If eps[4] > 0, an extra scaling is applied to ‘s’ after it has been selected, to ensure that it does not leave the specified domain, but scales it down to not cross the boundary. This preserves the solution inside the boundary, but may result in getting stuck in a local minimum on the boundary and exiting early due to this stopping criteria If eps[4] < 0, extra scaling is not applied, which may result in the solution, x, leaving the domain. If this occurs, try starting over with a different initial condition.
5	The trial step precision. If `eps[5]` = 0, then the trial step meets the required precision (≤ 1.0*10^-10).

Note:

J(x) is the Jacobian matrix.
Δ is the trust-region area.
F(x) is the value of the functional.
s is the trial step.

Input Parameters

n

Length of x.

m

Length of F(x).

x

Array of size n. Initial guess. A reference to this array is stored in handle for later use and modification by ?trnlspbc_solve.

LW

Array of size n.

Contains low bounds for x (lw_i < x_i ). A reference to this array is stored in handle for later use by ?trnlspbc_solve.

UP

Array of size n.

Contains upper bounds for x (up_i > x_i ). A reference to this array is stored in handle for later use by ?trnlspbc_solve.

eps

Array of size 6; contains stopping criteria. See the values in the Description section. A reference to this array is stored in handle for later use by ?trnlspbc_solve.

iter1

Specifies the maximum number of iterations.

iter2

Specifies the maximum number of iterations of trial step calculation.

rs

Definition of initial size of the trust region (boundary of the trial step). The recommended minimum value is 0.1, and the recommended maximum value is 100.0. Based on your knowledge of the objective function and initial guess you can increase or decrease the initial trust region. It can influence the iteration process, for example, the direction of the iteration process and the number of iterations. If you set rs to 0.0, the solver uses the default value, which is 100.0.

Output Parameters

handle

Type _TRNSPBC_HANDLE_t.

res

Informs about the task completion.

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: Nonlinear Least Squares Problem with Linear (Bound) Constraints

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in