NAG FL Interface
h02cff (iqp_​sparse_​optfile)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

h02cff may be used to supply optional parameters to h02cef from an external file.

2 Specification

Fortran Interface
Subroutine h02cff ( ioptns, inform)
Integer, Intent (In) :: ioptns
Integer, Intent (Out) :: inform
C Header Interface
#include <nag.h>
void  h02cff_ (const Integer *ioptns, Integer *inform)
The routine may be called by the names h02cff or nagf_mip_iqp_sparse_optfile.

3 Description

h02cff may be used to supply values for optional parameters to h02cef. h02cff 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 equal 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:
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 = 1
Normally each line of the file is printed as it is read, on the current advisory message unit (see x04abf), but printing may be suppressed using the keyword Nolist. To suppress printing of Begin, Nolist must be the first option supplied as in the file:
Print Level = 1
Printing will automatically be turned on again after a call to h02cef and may be turned on again at any time using the keyword List.
Optional parameter settings are preserved following a call to h02cef, and so the keyword Defaults is provided to allow you to reset all the optional parameters to their default values prior to a subsequent call to h02cef.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in h02cef.

4 References


5 Arguments

1: ioptns Integer Input
On entry: the unit number of the options file to be read.
Constraint: 0ioptns2147483647.
2: inform Integer Output
On exit: contains zero if the options file has been successfully read and a value >0 otherwise, as indicated below.
ioptns is not in the range [0,2147483647].
Begin was found, but end-of-file was found before End was found.
end-of-file was found before Begin was found.

6 Error Indicators and Warnings

If a line is not recognized as a valid option, then a warning message is output on the current advisory message unit (see x04abf).

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
h02cff is not thread safe and should not be called from a multithreaded user program. Please see Section 1 in FL Interface Multithreading for more information on thread safety.
h02cff is not threaded in any implementation.

9 Further Comments

h02cgf may also be used to supply optional parameters to h02cef. Note that if e04nkf/​e04nka is used in the same program as h02cef, then in general h02cff will also affect the options used by e04nkf/​e04nka.

10 Example

This example solves the same problem as the example for h02cef, but in addition illustrates the use of h02cff and h02cgf to set optional parameters for h02cef.
In this example the options file read by h02cff is appended to the data file for the program (see Section 10.2). It would usually be more convenient in practice to keep the data file and the options file separate.

10.1 Program Text

Program Text (h02cffe.f90)

10.2 Program Data

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

10.3 Program Results

Program Results (h02cffe.r)