e05 Chapter Contents
e05 Chapter Introduction
NAG Library Manual

# NAG Library Function Documentnag_glopt_bnd_mcs_optset_int (e05jfc)

## 1  Purpose

nag_glopt_bnd_mcs_optset_int (e05jfc) may be used to supply individual integer optional arguments to nag_glopt_bnd_mcs_solve (e05jbc). The initialization function nag_glopt_bnd_mcs_init (e05jac) must have been called before calling nag_glopt_bnd_mcs_optset_int (e05jfc).

## 2  Specification

 #include #include
 void nag_glopt_bnd_mcs_optset_int (const char *optstr, Integer ivalue, Nag_E05State *state, NagError *fail)

## 3  Description

nag_glopt_bnd_mcs_optset_int (e05jfc) may be used to supply values for integer optional arguments to nag_glopt_bnd_mcs_solve (e05jbc). It is only necessary to call nag_glopt_bnd_mcs_optset_int (e05jfc) for those arguments whose values are to be different from their default values. One call to nag_glopt_bnd_mcs_optset_int (e05jfc) sets one argument value.
Each integer optional argument is defined by a single character string in optstr and the corresponding value in ivalue. For example, the following allows the function evaluations limit to be defined:
```nf = 1000;
e05jfc ('Function Evaluations Limit', nf, &state, &fail);```
A complete list of optional arguments, their symbolic names and default values is given in Section 12 in nag_glopt_bnd_mcs_solve (e05jbc).

None.

## 5  Arguments

1:    $\mathbf{optstr}$const char *Input
On entry: a string identifying an integer-valued optional argument (as described in Section 12 in nag_glopt_bnd_mcs_solve (e05jbc)).
2:    $\mathbf{ivalue}$IntegerInput
On entry: an integer value associated with the optional argument in optstr.
3:    $\mathbf{state}$Nag_E05State *Communication Structure
state contains information required by other functions in this suite. You must not modify it directly in any way.
4:    $\mathbf{fail}$NagError *Input/Output
The NAG error argument (see Section 3.6 in the Essential Introduction).

## 6  Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.2.1.2 in the Essential Introduction for further information.
On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.
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 3.6.6 in the Essential Introduction for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 3.6.5 in the Essential Introduction for further information.
NE_NOT_INIT
Initialization function nag_glopt_bnd_mcs_init (e05jac) has not been called.
The supplied optional argument is invalid. A keyword or keyword combination was not recognized.
NE_OUT_OF_RANGE
Attempt to assign a non-positive value of ${\mathbf{Function Evaluations Limit}}$ ($\mathit{nf}$): $\mathit{nf}=〈\mathit{\text{value}}〉$.
Attempt to assign a non-positive value of ${\mathbf{Local Searches Limit}}$ ($\mathit{loclim}$): $\mathit{loclim}=〈\mathit{\text{value}}〉$.
Attempt to assign a non-positive value of ${\mathbf{Static Limit}}$ ($\mathit{stclim}$): $\mathit{stclim}=〈\mathit{\text{value}}〉$.

Not applicable.

## 8  Parallelism and Performance

nag_glopt_bnd_mcs_optset_int (e05jfc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.