NAG Library Function Document
To supply optional arguments to nag_opt_nlp_revcomm (e04ufc)
from an external file.
||nag_opt_nlp_revcomm_option_set_file (Nag_FileID fileid,
nag_opt_nlp_revcomm_option_set_file (e04udc) may be used to supply values for optional arguments to
nag_opt_nlp_revcomm_option_set_file (e04udc) reads an external file and each line of the file defines a single optional argument. It is only necessary to supply values for those arguments whose values are to be different from their default values.
Each optional argument is defined by a single character string,
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 argument. 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 double value. Such numbers may be up to contiguous characters
which can be read using C's d or g 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
Optional argument settings are preserved following a call to
and so the keyword
is provided to allow you to reset all the optional arguments to their default values before a subsequent call to
A complete list of optional arguments, their abbreviations, synonyms and default values is given in
in nag_opt_nlp_revcomm (e04ufc).
fileid – Nag_FileIDInput
: the ID of the option file to be read as returned by a call to nag_open_file (x04acc)
lwsav – Nag_BooleanCommunication Array
iwsav – IntegerCommunication Array
rwsav – doubleCommunication Array
The arrays lwsav
MUST NOT be altered between calls to any of the functions nag_opt_nlp_revcomm_option_set_file (e04udc), nag_opt_nlp_revcomm_option_set_string (e04uec)
, nag_opt_nlp_revcomm (e04ufc)
or nag_opt_nlp_revcomm_init (e04wbc)
fail – NagError *Input/Output
The NAG error argument (see Section 3.6
in the Essential Introduction).
6 Error Indicators and Warnings
Dynamic memory allocation failed.
On entry, argument had an illegal value.
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG
One or more lines of the options file is invalid.
End-of-file was found before Begin was found.
Begin was found, but end-of-file was found before End was found.
Could not open options file with .
This example solves the same problem as the example for
but in addition illustrates the use of nag_opt_nlp_revcomm_option_set_file (e04udc) and nag_opt_nlp_revcomm_option_set_string (e04uec)
to set optional arguments for
9.1 Program Text
Program Text (e04udce.c)
9.2 Program Data
Program Data (e04udce.d)
Program Options (e04udce.opt)
9.3 Program Results
Program Results (e04udce.r)