# NAG FL Interfacee04wef (nlp2_​option_​file)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

e04wef may be used to supply optional parameters to e04wdf from an external file. The initialization routine e04wcf must have been called before calling e04wef.

## 2Specification

Fortran Interface
 Subroutine e04wef ( iw, rw,
 Integer, Intent (In) :: ispecs Integer, Intent (Inout) :: iw(*), ifail Real (Kind=nag_wp), Intent (Inout) :: rw(*)
#include <nag.h>
 void e04wef_ (const Integer *ispecs, Integer iw[], double rw[], Integer *ifail)
The routine may be called by the names e04wef or nagf_opt_nlp2_option_file.

## 3Description

e04wef may be used to supply values for optional parameters to e04wdf. e04wef reads an external file and each line of the file defines a single optional parameter. It is only necessary to supply values for those arguments whose values are to be different from their default values.
Each optional parameter is defined by a single character string, of up to $72$ characters, consisting of one or more items. The items associated with a given option must be separated by spaces, or equals signs $\left[=\right]$. Alphabetic characters may be upper or lower case. The string
`Print Level = 1`
is an example of a string used to set an optional parameter. For each option the string contains one or more of the following items:
• a mandatory keyword;
• a phrase that qualifies the keyword;
• a number that specifies an integer or real value. Such numbers may be up to $40$ contiguous characters in Fortran's I, F, E or D formats, terminated by a space if this is not the last item on the line.
Blank strings and comments are ignored. A comment begins with an asterisk (*) and all subsequent characters in the string are regarded as part of the comment.
The file containing the options must start with Begin and must finish with End. An example of a valid options file is:
```Begin * Example options file
Print level = 5
End```
Optional parameter settings are preserved following a call to e04wdf and so the keyword Defaults is provided to allow you to reset all the optional parameters to their default values before a subsequent call to e04wdf.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in e04wdf.

## 4References

Hock W and Schittkowski K (1981) Test Examples for Nonlinear Programming Codes. Lecture Notes in Economics and Mathematical Systems 187 Springer–Verlag

## 5Arguments

1: $\mathbf{ispecs}$Integer Input
On entry: the unit number of the option file to be read.
Constraint: ispecs is a valid unit open for reading.
2: $\mathbf{iw}\left(*\right)$Integer array Communication Array
Note: the actual argument supplied must be the array iw supplied to the initialization routine e04wcf.
3: $\mathbf{rw}\left(*\right)$Real (Kind=nag_wp) array Communication Array
Note: the actual argument supplied must be the array rw supplied to the initialization routine e04wcf.
4: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, $-1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $-1$ means that an error message is printed while a value of $1$ means that it is not.
If halting is not appropriate, the value $-1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-1$, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
${\mathbf{ifail}}=1$
The initialization routine e04wcf has not been called.
${\mathbf{ifail}}=2$
At least one line of the options file is invalid.
Could not read options file on unit ${\mathbf{ispecs}}=⟨\mathit{\text{value}}⟩$.
Could not read options file on unit ispecs. This may be due to:
1. (a)ispecs is not a valid unit number;
2. (b)a file is not associated with unit ispecs, or if it is, is unavailable for read access;
3. (c)one or more lines of the options file is invalid. Check that all keywords are neither ambiguous nor misspelt;
4. (d)Begin was found, but end-of-file was found before End was found;
5. (e)end-of-file was found before Begin was found.
${\mathbf{ifail}}=-99$
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

Not applicable.

## 8Parallelism and Performance

e04wef is not threaded in any implementation.

e04wff, e04wgf or e04whf may also be used to supply optional parameters to e04wdf.

## 10Example

This example is based on Problem 71 in Hock and Schittkowski (1981) and involves the minimization of the nonlinear function
 $F(x)=x1x4(x1+x2+x3)+x3$
subject to the bounds
 $1≤x1≤ 5 1≤x2≤ 5 1≤x3≤ 5 1≤x4≤ 5$
to the general linear constraint
 $x1+x2+x3+x4≤20,$
and to the nonlinear constraints
 $x12+x22+x32+x42≤ 40, x1x2x3x4≥ 25.$
The initial point, which is infeasible, is
 $x0=(1,5,5,1)T,$
and $F\left({x}_{0}\right)=16$.
The optimal solution (to five figures) is
 $x*=(1.0,4.7430,3.8211,1.3794)T,$
and $F\left({x}^{*}\right)=17.014$. One bound constraint and both nonlinear constraints are active at the solution.
The document for e04wef includes an example program to solve the same problem using some of the optional parameters described in Section 12 in e04wdf.

### 10.1Program Text

Program Text (e04wefe.f90)

### 10.2Program Data

Program Options (e04wefe.opt)
Program Data (e04wefe.d)

### 10.3Program Results

Program Results (e04wefe.r)