NAG CL Interface
e05jgc (bnd_mcs_optset_real)

e05jgc may be used to supply individual real optional parameters to e05jbc. The initialization function e05jac must have been called before calling e05jgc.

2 Specification

#include <nag.h>

void	e05jgc (const char optstr, double rvalue, Nag_E05State state, NagError *fail)

The function may be called by the names: e05jgc or nag_glopt_bnd_mcs_optset_real.

3 Description

e05jgc may be used to supply values for real optional parameters to e05jbc. It is only necessary to call e05jgc for those arguments whose values are to be different from their default values. One call to e05jgc sets one argument value.

Each real optional parameter is defined by a single character string in optstr and the corresponding value in rvalue. For example the following illustrates how the local searches tolerance could be defined:

loctol = 1.0e-10;
e05jgc ('Local Searches Tolerance', loctol, &state, &fail);

A complete list of optional parameters, their symbolic names and default values is given in Section 12 in e05jbc.

4 References

None.

5 Arguments

1: $optstr$ – const char * Input: On entry: a string identifying a real-valued optional parameter (as described in Section 12 in e05jbc).
2: $rvalue$ – double Input: On entry: the value associated with the optional parameter in optstr.
3: $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: $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_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.
NE_NOT_INIT: Initialization function e05jac has not been called.
NE_OPT_NOT_READ: The supplied optional parameter is invalid. A keyword or keyword combination was not recognized.
NE_OUT_OF_RANGE: Attempt to assign an out-of-bounds value of $Infinite Bound Size$ ( $infbnd$ ): $infbnd = ⟨ value ⟩$ .

Attempt to assign too small a value of $Local Searches Tolerance$ ( $loctol$ ): $loctol = ⟨ value ⟩$ .

Attempt to assign too small a value of $Target Objective Error$ ( $objerr$ ): $objerr = ⟨ value ⟩$ .

Attempt to assign too small a value of $Target Objective Safeguard$ ( $objsfg$ ): $objsfg = ⟨ value ⟩$ .

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

e05jgc 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.