E04ZPF (PDF version)
E04 Chapter Contents
E04 Chapter Introduction
NAG Library Manual

NAG Library Routine Document

E04ZPF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

 Contents

    1  Purpose
    7  Accuracy
    10  Example

1  Purpose

E04ZPF is an option setting routine for solvers from the NAG optimization modelling suite, namely E04STF and E04SVF. It can set one or more optional parameters from an external file.

2  Specification

SUBROUTINE E04ZPF ( HANDLE, INFILE, IFAIL)
INTEGER  INFILE, IFAIL
TYPE (C_PTR)  HANDLE

3  Description

E04ZPF may be used to supply values for optional parameters to the solver from an external file. It can only be called on handles which have been initialized by E04RAF and before the call to the solver. E04ZPF looks in the file for a specific section containing the optional parameters. The section must start with a line Begin and must finish with a line End. Anything outside the section is ignored. If there is more than one section like this, only the first one is processed. Any line within the section is either blank or a comment which is ignored or defines a single optional parameter as if it had been set by E04ZMF. The implied data type (character, integer or real) of each value to be set must match that expected by the corresponding optional parameter. It is only necessary to supply values for those arguments whose values are to be different from their default values. A comment begins with an asterisk (*) and all subsequent characters to the end of the line are ignored. Comments can also be placed after the optional parameter. The file is case insensitive.
Note that the optional parameters printed by the solver or by E04RYF are in the compatible format. An example of a valid options file is:
Begin * Example options file
   Print Level = 3 
   Monitoring Level = 5 * output all details
   Monitoring File = 42 * to this file
End

4  References

None.

5  Arguments

1:     HANDLE – TYPE (C_PTR)Input
On entry: the handle to the problem. It needs to be initialized by E04RAF and must not be changed.
2:     INFILE – INTEGERInput
On entry: the file identifier associated with the argument data file. Note:  that the file needs to be opened in read mode by X04ACF with MODE=0.
Constraint: INFILE0.
3:     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 or -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 supplied HANDLE does not define a valid handle to the data structure for the NAG optimization modelling suite. It has not been initialized by E04RAF or it has been corrupted.
IFAIL=2
The options cannot be modified in this phase.
IFAIL=3
On entry, INFILE=value.
Constraint: INFILE0.
IFAIL=4
BEGIN found, but end-of-file found before END. All optional parameters that were set from the file before this error was encountered will remain set on exit.
End-of-file or read error detected before BEGIN was found.
IFAIL=11
The option provided on line value was not recognized.
IFAIL=12
The expected delimiter ‘=’ was not found on line value.
IFAIL=13
The optval provided on line value could not be converted to the expected numerical type.
IFAIL=15
The optval provided on line value for the integer optional parameter is out of bounds.
IFAIL=16
The optval provided on line value for the real optional parameter is out of bounds.
IFAIL=17
The optval provided on line value for the character optional parameter is not valid.
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

E04ZPF is not threaded in any implementation.

9  Further Comments

None.

10  Example

See Section 10 in E04RAF for links to all examples in the suite.

E04ZPF (PDF version)
E04 Chapter Contents
E04 Chapter Introduction
NAG Library Manual

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