NAG Library Function Document

nag_opt_handle_set_nlnls (e04rmc)


    1  Purpose
    7  Accuracy


nag_opt_handle_set_nlnls (e04rmc) is a part of the NAG optimization modelling suite and defines the number of residuals in a sum of squares objective function (nonlinear least squares problems) and, optionally, the sparsity structure of their first derivatives.


#include <nag.h>
#include <nage04.h>
void  nag_opt_handle_set_nlnls (void *handle, Integer nres, Integer isparse, Integer nnzrd, const Integer irowrd[], const Integer icolrd[], NagError *fail)


After the initialization function nag_opt_handle_init (e04rac) has been called and unless the objective function has already been defined, nag_opt_handle_set_nlnls (e04rmc) may be used to declare the objective function of the optimization problem as a sum of squares. It will typically be used in data fitting or calibration problems of the form
minimize xn fx= j=1 mr rj x 2    subject to lxxux ,     
where x is an n-dimensional variable vector and rix are nonlinear residuals (see Section 2.2.3 in the e04 Chapter Introduction). The values of the residuals, and possibly their derivatives, will be communicated to the solver by a user-supplied function. nag_opt_handle_set_nlnls (e04rmc) also allows the user to declare the structured first derivative matrix
rjx xi i=1,,n , ​ j=1,,mr  
as being dense or sparse. If declared as sparse, its sparsity structure must be specified here.
See nag_opt_handle_init (e04rac) for more details.




1:     handle void *Input
On entry: the handle to the problem. It needs to be initialized by nag_opt_handle_init (e04rac) and must not be changed.
2:     nres IntegerInput
On entry: mr, the number of residuals in the objective function.
If nres=0, no objective function will be defined and irowrd and icolrd will not be referenced and may be NULL.
Constraint: nres0.
3:     isparse IntegerInput
On entry: is a flag indicating if the nonzero structure of the first derivative matrix is dense or sparse.
The first derivative matrix is considered dense and irowrd and icolrd will not be referenced and may be specified as NULL. The ordering is assumed to be column-wise, namely the function will behave as if nnzrd=n×mr and the vectors irowrd and icolrd filled as:
  • irowrd=1,2,,n,1,2,,n,,1,2,,n;
  • icolrd=1,1,,1,2,2,,2,,mr,mr,,mr.
The sparsity structure of the first derivative matrix will be supplied by nnzrd, irowrd and icolrd.
Constraint: isparse=0 or 1.
4:     nnzrd IntegerInput
On entry: the number of nonzeros in the first derivative matrix.
Constraint: if nres>0, nnzrd>0.
5:     irowrd[nnzrd] const IntegerInput
6:     icolrd[nnzrd] const IntegerInput
On entry: arrays irowrd and icolrd store the sparsity structure (pattern) of the first derivative matrix as nnzrd nonzeros in coordinate storage (CS) format (see Section 2.1.1 in the f11 Chapter Introduction). The matrix has dimensions n×mr. irowrd specifies one-based row indices and icolrd specifies one-based column indices. No particular order of elements is expected, but elements should not repeat and the same order should be used when the first derivative matrix is evaluated for the solver.
  • 1irowrd[l-1]n, for l=1,2,,nnzrd;
  • 1icolrd[l-1]nres, for l=1,2,,nnzrd.
7:     fail NagError *Input/Output
The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

Error Indicators and Warnings

Dynamic memory allocation failed.
See Section in How to Use the NAG Library and its Documentation for further information.
The objective function has already been defined.
On entry, argument value had an illegal value.
The supplied handle does not define a valid handle to the data structure for the NAG optimization modelling suite. It has not been initialized by nag_opt_handle_init (e04rac) or it has been corrupted.
On entry, isparse=value.
Constraint: isparse=0 or 1.
On entry, nnzrd=value.
Constraint: nnzrd>0.
On entry, nres=value.
Constraint: nres0.
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
On entry, i=value, icolrd[i-1]=value and nres=value.
Constraint: 1icolrd[i-1]nres.
On entry, i=value, irowrd[i-1]=value and n=value.
Constraint: 1irowrd[i-1]n.
On entry, more than one element of first derivative matrix has row index value and column index value.
Constraint: each element of first derivative matrix must have a unique row and column index.
Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.
The Hessians of nonlinear functions have already been defined, a nonlinear objective cannot be added.
The problem cannot be modified in this phase any more, the solver has already been called.


Not applicable.

Parallelism and Performance

nag_opt_handle_set_nlnls (e04rmc) is not threaded in any implementation.

Further Comments



In this example, we demonstrate how to declare a least squares problem through nag_opt_handle_set_nlnls (e04rmc) and solve it with nag_opt_handle_solve_dfls (e04ffc) on a very simple example. Here n=2, mr=3 and the residuals are computed by:
r1x = x1+ x2- 0.9 r2x = 2x1+ x2- 1.9 r3x = 3x1+ x2- 3.0  
The expected result is:
with an objective value of 0.015.

Program Text

Program Text (e04rmce.c)

Program Data


Program Results

Program Results (e04rmce.r)

© The Numerical Algorithms Group Ltd, Oxford, UK. 2017