naginterfaces.library.opt.handle_​set_​nlnobj

naginterfaces.library.opt.handle_set_nlnobj(handle, idxfd=None)

handle_set_nlnobj is a part of the NAG optimization modelling suite and declares the objective function of the problem as a nonlinear function with a particular gradient sparsity structure.

For full information please refer to the NAG Library document for e04rg

https://support.nag.com/numeric/nl/nagdoc_30.2/flhtml/e04/e04rgf.html

Parameters

handleHandle

The handle to the problem. It needs to be initialized (e.g., by handle_init()) and must not be changed between calls to the NAG optimization modelling suite.

idxfdNone or int, array-like, shape $\left(\text{nnzfd}\right)$, optional

The one-based indices of the nonzero elements of the sparse gradient vector. The indices must be stored in ascending order. Note that $n$ is the current number of decision variables in the model.

If $\text{nnzfd}=0$, the objective is assumed to be zero and the array $idxfd$ will not be referenced.

Raises

NagValueError

(errno $1$)

$handle$ has not been initialized.

(errno $1$)

$handle$ does not belong to the NAG optimization modelling suite, has not been initialized properly or is corrupted.

(errno $1$)

$handle$ has not been initialized properly or is corrupted.

(errno $2$)

The problem cannot be modified right now, the solver is running.

(errno $6$)

On entry, $\text{nnzfd}=⟨value⟩$.

Constraint: $\text{nnzfd}\ge 0$.

(errno $7$)

On entry, $i=⟨value⟩$, $idxfd[i-1]=⟨value⟩$ and $idxfd\left[i\right]=⟨value⟩$.

Constraint: $idxfd[\text{i}-1]<idxfd\left[i\right]$ (ascending order).

(errno $7$)

On entry, $i=⟨value⟩$, $idxfd[i-1]=⟨value⟩$ and $\text{n}=⟨value⟩$.

Constraint: $1\le idxfd[i-1]\le \text{n}$.

Notes

After the $handle$ has been initialized (e.g., handle_init() has been called), handle_set_nlnobj may be used to declare the objective function of the problem as a nonlinear function and define the sparsity pattern (list of nonzero elements) of its gradient. If the objective function has already been defined, it will be overwritten and its Hessian (or the Hessian of the Lagrangian) will be removed. If handle_set_nlnobj is called with no nonzeroes in the sparsity pattern, any existing objective function is removed, no new one is added and the problem will be solved as a feasible point problem.

This objective function will typically be used for nonlinear programming problems (NLP) of the kind:

$$\begin{array}{c}\begin{array}{ccc}{minimize}_{x\in R^n}& f\left(x\right)& \text{(a)}\\ \text{subject to}& l_g\le g\left(x\right)\le u_g\text{,}& \text{(b)}\\ & l_B\le Bx\le u_B\text{.}& \text{(c)}\\ & l_x\le x\le u_x& \text{(d)}\end{array}\end{array}$$

The values of the nonlinear objective function $f\left(x\right)$ and the nonzero values of its gradient $\frac{\partial f}{\partial x_i}$ (matching the sparsity pattern) evaluated at particular points in the decision variable space will be communicated to the NLP solver by user-supplied functions (e.g., $\text{objfun}$ and $\text{objgrd}$ for handle_solve_ipopt()). See the E04 Introduction for more details about the NAG optimization modelling suite.

See also

naginterfaces.library.examples.glopt.handle_solve_mcs_ex.main()

naginterfaces.library.examples.opt.handle_solve_bounds_foas_ex.main()

naginterfaces.library.examples.opt.handle_solve_dfno_ex.main()

naginterfaces.library.examples.opt.handle_solve_ipopt_ex.main()

naginterfaces.library.examples.opt.handle_solve_ssqp_ex.main()