# NAG FL Interfacee05jgf (bnd_​mcs_​optset_​real)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

e05jgf may be used to supply individual real optional parameters to e05jbf. The initialization routine e05jaf must have been called before calling e05jgf.

## 2Specification

Fortran Interface
 Subroutine e05jgf ( comm,
 Integer, Intent (In) :: lcomm Integer, Intent (Inout) :: ifail Real (Kind=nag_wp), Intent (In) :: rvalue Real (Kind=nag_wp), Intent (Inout) :: comm(lcomm) Character (*), Intent (In) :: optstr
#include <nag.h>
 void e05jgf_ (const char *optstr, const double *rvalue, double comm[], const Integer *lcomm, Integer *ifail, const Charlen length_optstr)
The routine may be called by the names e05jgf or nagf_glopt_bnd_mcs_optset_real.

## 3Description

e05jgf may be used to supply values for real optional parameters to e05jbf. It is only necessary to call e05jgf for those arguments whose values are to be different from their default values. One call to e05jgf 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
Call e05jgf ('Local Searches Tolerance', Loctol, comm, lcomm, ifail)```
A complete list of optional parameters, their symbolic names and default values is given in Section 12 in e05jbf.

None.

## 5Arguments

1: $\mathbf{optstr}$Character(*) Input
On entry: a string identifying a real-valued optional parameter (as described in Section 12 in e05jbf).
2: $\mathbf{rvalue}$Real (Kind=nag_wp) Input
On entry: the value associated with the optional parameter in optstr.
3: $\mathbf{comm}\left({\mathbf{lcomm}}\right)$Real (Kind=nag_wp) array Communication Array
On exit: comm must not be altered between calls to any of the routines e05jbf, e05jcf, e05jdf, e05jef, e05jff, e05jgf, e05jhf, e05jjf, e05jkf and e05jlf.
4: $\mathbf{lcomm}$Integer Input
On entry: the dimension of the array comm as declared in the (sub)program from which e05jgf is called.
Constraint: ${\mathbf{lcomm}}\ge 100$.
5: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, $-1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $-1$ means that an error message is printed while a value of $1$ means that it is not.
If halting is not appropriate, the value $-1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-1$, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
${\mathbf{ifail}}=1$
Initialization routine e05jaf has not been called.
On entry, ${\mathbf{lcomm}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{lcomm}}\ge 100$.
${\mathbf{ifail}}=2$
The supplied optional parameter is invalid. A keyword or keyword combination was not recognized.
${\mathbf{ifail}}=3$
Attempt to assign an out-of-bounds value of Infinite Bound Size ($\mathit{infbnd}$): $\mathit{infbnd}=⟨\mathit{\text{value}}⟩$.
Attempt to assign too small a value of Local Searches Tolerance ($\mathit{loctol}$): $\mathit{loctol}=⟨\mathit{\text{value}}⟩$.
Attempt to assign too small a value of Target Objective Error ($\mathit{objerr}$): $\mathit{objerr}=⟨\mathit{\text{value}}⟩$.
Attempt to assign too small a value of Target Objective Safeguard ($\mathit{objsfg}$): $\mathit{objsfg}=⟨\mathit{\text{value}}⟩$.
${\mathbf{ifail}}=-99$
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

Not applicable.

## 8Parallelism and Performance

e05jgf 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 routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.