NAG Library ManualKeyword Search:

NAG Library Function Document

nag_opt_sparse_nlp_option_set_integer (e04vmc)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

1 Purpose

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

2 Specification

#include <nag.h>

#include <nage04.h>

void	nag_opt_sparse_nlp_option_set_integer (const char string, Integer ivalue, Nag_E04State state, NagError *fail)

3 Description

nag_opt_sparse_nlp_option_set_integer (e04vmc) may be used to supply values for Integer optional parameters to nag_opt_sparse_nlp_solve (e04vhc). It is only necessary to call nag_opt_sparse_nlp_option_set_integer (e04vmc) for those arguments whose values are to be different from their default values. One call to nag_opt_sparse_nlp_option_set_integer (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 nag_opt_sparse_nlp_solve (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 nag_opt_sparse_nlp_solve (e04vhc).

A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in nag_opt_sparse_nlp_solve (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 nag_opt_sparse_nlp_solve (e04vhc)).
2: $ivalue$ – IntegerInput: 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 2.7 in How to Use the NAG Library and its Documentation).

6 Error Indicators and Warnings

NE_ALLOC_FAIL: Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation 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 nag_opt_sparse_nlp_init (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.

An unexpected error has been triggered by this function. Please contact NAG.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
NE_NO_LICENCE: Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.