NAG Library Manual, Mark 27
Interfaces:  FL   CL   CPP   AD 
NAG CL Interface Introduction
E04 (Opt) Chapter Contents
E04 (Opt) Chapter Introduction
e04vm:  FL   CL   CPP   AD 

NAG CL Interface
e04vmc (nlp2_​sparse_​option_​integer_​set)

NAG Library Manual, Mark 27
Interfaces:  FL   CL   CPP   AD 
NAG CL Interface Introduction
E04 (Opt) Chapter Contents
E04 (Opt) Chapter Introduction
e04vm:  FL   CL   CPP   AD 

▸▿ Contents

© The Numerical Algorithms Group Ltd. 2019

1 Purpose

e04vmc may be used to supply individual Integer optional parameters to e04vhc. The initialization function e04vgc must have been called before calling e04vmc.

2 Specification

#include <nag.h>
void  e04vmc (const char *string, Integer ivalue, Nag_E04State *state, NagError *fail)
The function may be called by the names: e04vmc, nag_opt_nlp2_sparse_option_integer_set or nag_opt_sparse_nlp_option_set_integer.

3 Description

e04vmc may be used to supply values for Integer optional parameters to e04vhc. It is only necessary to call e04vmc for those arguments whose values are to be different from their default values. One call to e04vmc sets one argument value.
Each Integer optional parameter is defined by a single character string in string and the corresponding value in ivalue. For example, the following allows the iteration limit to be defined: 
itnlim = 1000;
if (m > 500) itnlim = 500;
e04vmc ("Major Iterations", itnlim, &state, &fail);
Optional parameter settings are preserved following a call to e04vhc 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 e04vhc.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in e04vhc.

4 References

None.

5 Arguments

1: string – const char * Input
On entry: a single valid keyword of an Integer optional parameter (as described in Section 12 in e04vhc).
2: ivalue – Integer Input
On entry: an Integer value associated with the keyword in string.
3: state – Nag_E04State * Communication Structure
state contains internal information required for functions in this suite. It must not be modified in any way.
4: 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

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_E04_OPTION_INVALID
The supplied option is invalid. Check that the keywords are neither ambiguous nor misspelt. The option string is ‘value’ and ivalue=value.
NE_E04VGC_NOT_INIT
The initialization function e04vgc has not been called.
NE_INTERNAL_ERROR
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.
NE_NO_LICENCE
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

e04vmc is not threaded in any implementation.

9 Further Comments

e04vkc or e04vlc may also be used to supply Integer optional parameters to e04vhc.

10 Example

See Section 10 in e04vhc and e04vkc.
NAG Library Manual, Mark 27
Interfaces:  FL   CL   CPP   AD 
NAG CL Interface Introduction
E04 (Opt) Chapter Contents
E04 (Opt) Chapter Introduction
e04vm:  FL   CL   CPP   AD 
© The Numerical Algorithms Group Ltd. 2019