NAG Library Routine Document

e05jff (bnd_mcs_optset_int)


    1  Purpose
    7  Accuracy
    10  Example


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


Fortran Interface
Subroutine e05jff ( optstr, ivalue, comm, lcomm, ifail)
Integer, Intent (In):: ivalue, lcomm
Integer, Intent (Inout):: ifail
Real (Kind=nag_wp), Intent (Inout):: comm(lcomm)
Character (*), Intent (In):: optstr
C Header Interface
#include nagmk26.h
void  e05jff_ (const char *optstr, const Integer *ivalue, double comm[], const Integer *lcomm, Integer *ifail, const Charlen length_optstr)


e05jff may be used to supply values for integer optional parameters to e05jbf. It is only necessary to call e05jff for those arguments whose values are to be different from their default values. One call to e05jff sets one argument value.
Each integer optional parameter 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
Call e05jff ('Function Evaluations Limit', nf, comm, lcomm, ifail)
A complete list of optional parameters, their symbolic names and default values is given in Section 12 in e05jbf.




1:     optstr – Character(*)Input
On entry: a string identifying an integer-valued optional parameter (as described in Section 12 in e05jbf).
2:     ivalue – IntegerInput
On entry: an integer value associated with the optional parameter in optstr.
3:     commlcomm – Real (Kind=nag_wp) arrayCommunication 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:     lcomm – IntegerInput
On entry: the dimension of the array comm as declared in the (sub)program from which e05jff is called.
Constraint: lcomm100.
5:     ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1​ or ​1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ or ​1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this argument, the recommended value is 0. When the value -1​ or ​1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

Error Indicators and Warnings

If on entry 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:
Initialization routine e05jaf has not been called.
On entry, lcomm=value.
Constraint: lcomm100.
The supplied optional parameter is invalid. A keyword or keyword combination was not recognized.
Attempt to assign a non-positive value of Function Evaluations Limit (nf): nf=value.
Attempt to assign a non-positive value of Local Searches Limit (loclim): loclim=value.
Attempt to assign a non-positive value of Static Limit (stclim): stclim=value.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.


Not applicable.

Parallelism and Performance

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

Further Comments

e05jcf or e05jdf may also be used to supply integer optional parameters to e05jbf.


See Section 10 in e05jcf.
© The Numerical Algorithms Group Ltd, Oxford, UK. 2017