NAG Library ManualKeyword Search:

NAG Library Routine Document

e04wef (nlp2_option_file)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

▸▿ 10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1

Purpose

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.

2

Specification

Fortran Interface

Subroutine e04wef (

ispecs, iw, rw, ifail)

Integer, Intent (In)	::	ispecs
Integer, Intent (Inout)	::	iw(*), ifail
Real (Kind=nag_wp), Intent (Inout)	::	rw(*)

C Header Interface

#include nagmk26.h

void	e04wef_ ( const Integer ispecs, Integer iw[], double rw[], Integer ifail)

3

Description

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

[=]

. 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.

4

References

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

5

Arguments

1: $ispecs$ – IntegerInput: On entry: the unit number of the option file to be read.

Constraint: ispecs is a valid unit open for reading.
2: $iw (*)$ – Integer arrayCommunication Array: Note: the dimension of the array iw must be at least $leniw$ (see e04wcf).
3: $rw (*)$ – Real (Kind=nag_wp) arrayCommunication Array: Note: the dimension of the array rw must be at least $lenrw$ (see e04wcf).
4: $ifail$ – IntegerInput/Output: On entry: ifail must be set to $0$ , $- 1 or 1$ . If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $- 1 or 1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is $0$ . When the value $- 1 or 1$ is used it is essential to test the value of ifail on exit.

On exit: $ifail = 0$ unless the routine detects an error or a warning has been flagged (see Section 6).

6

Error Indicators and Warnings

If on entry

ifail = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: The initialization routine e04wcf has not been called.

$ifail = 2$

At least one line of the options file is invalid.

Could not read options file on unit

ispecs = 〈value〉

Could not read options file on unit ispecs. This may be due to:

(a)	ispecs is not a valid unit number;
(b)	a file is not associated with unit ispecs, or if it is, is unavailable for read access;
(c)	one or more lines of the options file is invalid. Check that all keywords are neither ambiguous nor misspelt;
(d)	Begin was found, but end-of-file was found before End was found;
(e)	end-of-file was found before Begin was found.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

Not applicable.

8

Parallelism and Performance

e04wef is not threaded in any implementation.

9

Further Comments

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

10

Example

This example is based on Problem 71 in Hock and Schittkowski (1981) and involves the minimization of the nonlinear function

F (x) = x_{1} x_{4} (x_{1} + x_{2} + x_{3}) + x_{3}

subject to the bounds

\begin{matrix} 1 \leq x_{1} \leq 5 \\ 1 \leq x_{2} \leq 5 \\ 1 \leq x_{3} \leq 5 \\ 1 \leq x_{4} \leq 5 \end{matrix}

to the general linear constraint

x_{1} + x_{2} + x_{3} + x_{4} \leq 20,

and to the nonlinear constraints

\begin{matrix} x_{1}^{2} + x_{2}^{2} + x_{3}^{2} + x_{4}^{2} \leq 40, \\ x_{1} x_{2} x_{3} x_{4} \geq 25 . \end{matrix}

The initial point, which is infeasible, is

x_{0} = {(1, 5, 5, 1)}^{T},

and

F (x_{0}) = 16

The optimal solution (to five figures) is

x^{*} = {(1.0, 4.7430, 3.8211, 1.3794)}^{T},

and

F (x^{*}) = 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.

NAG Library Routine Document

e04wef (nlp2_option_file)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results