NAG CL Interface
e04uec (nlp1_​option_​string)

Settings help

CL Name Style:

1 Purpose

To supply individual optional parameters to e04ufc.

2 Specification

#include <nag.h>
void  e04uec (const char *str, Nag_Boolean lwsav[], Integer iwsav[], double rwsav[], NagError *fail)
The function may be called by the names: e04uec, nag_opt_nlp1_option_string or nag_opt_nlp_revcomm_option_set_string.

3 Description

e04uec may be used to supply values for optional parameters to e04ufc. It is only necessary to call e04uec for those arguments whose values are to be different from their default values. One call to e04uec sets one argument value.
Each optional parameter 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 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.
Printing of user-specified options is turned off by default. It may be turned on at any time using the keyword List.
Optional parameter settings are preserved following a call to e04ufc 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 e04ufc.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in e04ufc.

4 References


5 Arguments

1: str const char * Input
On entry: a single valid option string (as described in Section 3 and in Section 12 in e04ufc).
2: lwsav[120] Nag_Boolean Communication Array
3: iwsav[610] Integer Communication Array
4: rwsav[475] double Communication Array
The arrays lwsav, iwsav and rwsav MUST NOT be altered between calls to any of the functions e04udc, e04uec, e04ufc or e04wbc.
5: fail NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
On entry, argument value 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 for assistance.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
The supplied option string is invalid. Supplied value was: value. Check that the keywords are neither ambiguous nor misspelt.
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
e04uec is not threaded in any implementation.

9 Further Comments

e04udc may also be used to supply optional parameters to e04ufc.

10 Example

See e04udc.