# NAG FL Interfacee05jdf (bnd_​mcs_​optset_​string)

Note: this routine is deprecated. There is no replacement for this routine.

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

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

## 2Specification

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

## 3Description

e05jdf may be used to supply values for optional parameters to e05jbf. It is only necessary to call e05jdf for those arguments whose values are to be different from their default values. One call to e05jdf sets one argument value.
Each optional parameter is defined by a single character string, of up to $72$ characters, consisting of one or more items. The items associated with a given optional parameter must be separated by spaces, or equals signs $\left[=\right]$. Alphabetic characters may be upper or lower case. The string
Static Limit = 100
is an example of a string used to set an optional parameter. For each optional parameter the string contains one or more of the following items:
• a mandatory keyword;
• a phrase that qualifies the keyword;
• a number that specifies an integer or real value. Such numbers may be up to $40$ contiguous characters.
For e05jdf, each user-specified optional parameter is not normally printed as it is defined, but this printing may be turned on using the keyword List. Thus the statement
Call e05jdf ('List', comm, lcomm, ifail)
turns on printing of this and subsequent options. Printing may be turned off again using the keyword Nolist.
Optional parameter settings are preserved following a call to e05jbf 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 e05jbf.
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 defining a single optional parameter (as described in Section 3 and in Section 12 in e05jbf). The implied data type (character, integer or real) of each value to set must match that expected by the optional parameter.
2: $\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.
3: $\mathbf{lcomm}$Integer Input
On entry: the dimension of the array comm as declared in the (sub)program from which e05jdf is called.
Constraint: ${\mathbf{lcomm}}\ge 100$.
4: $\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 illegal value of Local Searches ($\mathit{lcsrch}$): $\mathit{lcsrch}=⟨\mathit{\text{value}}⟩$.
Attempt to assign an illegal value of Repeatability ($\mathit{repeat}$): $\mathit{repeat}=⟨\mathit{\text{value}}⟩$.
Attempt to assign a non-positive value of Function Evaluations Limit ($\mathit{nf}$): $\mathit{nf}=⟨\mathit{\text{value}}⟩$.
Attempt to assign a non-positive value of Local Searches Limit ($\mathit{loclim}$): $\mathit{loclim}=⟨\mathit{\text{value}}⟩$.
Attempt to assign a non-positive value of Static Limit ($\mathit{stclim}$): $\mathit{stclim}=⟨\mathit{\text{value}}⟩$.
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}}=5$
The value to be set could not be parsed. Check that it specifies a valid integer or real 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.