NAG Library Routine Document
e04nrf (qpconvex2_sparse_option_file)
1
Purpose
e04nrf may be used to supply optional parameters to
e04nqf from an external file. The initialization routine
e04npf
must have been called before calling
e04nrf.
2
Specification
Fortran Interface
Integer, Intent (In) | :: | ispecs | Integer, Intent (Inout) | :: | iw(*), ifail | Real (Kind=nag_wp), Intent (Inout) | :: | rw(*) | Character (8), Intent (Inout) | :: | cw(*) |
|
3
Description
e04nrf may be used to supply values for optional parameters to
e04nqf.
e04nrf 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
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 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
e04nqf 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
e04nqf.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in
Section 12 in
e04nqf.
4
References
None.
5
Arguments
- 1: – IntegerInput
-
On entry: the unit number of the option file to be read.
Constraint:
ispecs is a valid unit open for reading.
- 2: – Character(8) arrayCommunication Array
-
Note: the dimension of the array
cw
must be at least
(see
e04npf).
- 3: – Integer arrayCommunication Array
-
Note: the dimension of the array
iw
must be at least
(see
e04npf).
- 4: – Real (Kind=nag_wp) arrayCommunication Array
-
Note: the dimension of the array
rw
must be at least
(see
e04npf).
- 5: – IntegerInput/Output
-
On entry:
ifail must be set to
,
. 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
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, if you are not familiar with this argument, the recommended value is
.
When the value is used it is essential to test the value of ifail on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
x04aaf).
Errors or warnings detected by the routine:
-
The initialization routine
e04npf has not been called.
-
At least one line of the options file is invalid.
Could not read options file on unit .
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. |
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.
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.
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
e04nrf is not threaded in any implementation.
e04nsf,
e04ntf or
e04nuf may also be used to supply optional parameters to
e04nqf.
10
Example
This example minimizes the quadratic function
, where
and
subject to the bounds
and to the linear constraints
The initial point, which is infeasible, is
The optimal solution (to five figures) is
One bound constraint and four linear constraints are active at the solution. Note that the Hessian matrix is positive semidefinite.
10.1
Program Text
Program Text (e04nrfe.f90)
10.2
Program Data
Program Options (e04nrfe.opt)
Program Data (e04nrfe.d)
10.3
Program Results
Program Results (e04nrfe.r)