# NAG FL Interfacee05saf (bnd_​pso)

Note: this routine uses optional parameters to define choices in the problem specification and in the details of the algorithm. If you wish to use default settings for all of the optional parameters, you need only read Sections 1 to 10 of this document. If, however, you wish to reset some or all of the settings please refer to Section 11 for a detailed description of the algorithm and to Section 12 for a detailed description of the specification of the optional parameters.

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

e05saf is designed to search for the global minimum or maximum of an arbitrary function, using Particle Swarm Optimization (PSO). Derivatives are not required, although these may be used by an accompanying local minimization routine if desired. e05saf is essentially identical to e05sbf, but with a simpler interface and with various optional parameters removed; otherwise most arguments are identical. In particular, e05saf does not handle general constraints.

## 2Specification

Fortran Interface
 Subroutine e05saf ( ndim, npar, xb, fb, bl, bu, opts, itt,
 Integer, Intent (In) :: ndim, npar Integer, Intent (Inout) :: iopts(*), iuser(*), ifail Integer, Intent (Out) :: itt(6), inform Real (Kind=nag_wp), Intent (In) :: bl(ndim), bu(ndim) Real (Kind=nag_wp), Intent (Inout) :: opts(*), ruser(*) Real (Kind=nag_wp), Intent (Out) :: xb(ndim), fb External :: objfun, monmod
#include <nag.h>
 void e05saf_ (const Integer *ndim, const Integer *npar, double xb[], double *fb, const double bl[], const double bu[], void (NAG_CALL *objfun)(Integer *mode, const Integer *ndim, const double x[], double *objf, double vecout[], const Integer *nstate, Integer iuser[], double ruser[]),void (NAG_CALL *monmod)(const Integer *ndim, const Integer *npar, double x[], const double xb[], const double *fb, const double xbest[], const double fbest[], const Integer itt[], Integer iuser[], double ruser[], Integer *inform),Integer iopts[], double opts[], Integer iuser[], double ruser[], Integer itt[], Integer *inform, Integer *ifail)
The routine may be called by the names e05saf or nagf_glopt_bnd_pso.
Before calling e05saf, e05zkf must be called with optstr set to ‘Initialize = e05saf’. Optional parameters may also be specified by calling e05zkf before the call to e05saf.

## 3Description

e05saf uses a stochastic method based on Particle Swarm Optimization (PSO) to search for the global optimum of a nonlinear function $F$, subject to a set of bound constraints on the variables. In the PSO algorithm (see Section 11), a set of particles is generated in the search space, and advances each iteration to (hopefully) better positions using a heuristic velocity based upon inertia, cognitive memory and global memory. The inertia is provided by a decreasingly weighted contribution from a particles current velocity, the cognitive memory refers to the best candidate found by an individual particle and the global memory refers to the best candidate found by all the particles. This allows for a global search of the domain in question.
Further, this may be coupled with a selection of local minimization routines, which may be called during the iterations of the heuristic algorithm, the interior phase, to hasten the discovery of locally optimal points, and after the heuristic phase has completed to attempt to refine the final solution, the exterior phase. Different options may be set for the local optimizer in each phase.
Without loss of generality, the problem is assumed to be stated in the following form:
 $minimize x∈Rndim F(x) subject to ℓ ≤ x ≤ u ,$
where the objective $F\left(\mathbf{x}\right)$ is a scalar function, $\mathbf{x}$ is a vector in ${R}^{\mathit{ndim}}$ and the vectors $\mathbf{\ell }\le \mathbf{u}$ are lower and upper bounds respectively for the $\mathit{ndim}$ variables. The objective function may be nonlinear. Continuity of $F$ is not essential. For functions which are smooth and primarily unimodal, faster solutions will almost certainly be achieved by using Chapter E04 routines directly.
For functions which are smooth and multi-modal, gradient dependent local minimization routines may be coupled with e05saf.
For multi-modal functions for which derivatives cannot be provided, particularly functions with a significant level of noise in their evaluation, e05saf should be used either alone, or coupled with e04cbf.
The $\mathit{ndim}$ lower and upper box bounds on the variable $\mathbf{x}$ are included to initialize the particle swarm into a finite hypervolume, although their subsequent influence on the algorithm is user determinable (see the option Boundary in Section 12). It is strongly recommended that sensible bounds are provided for all variables.
e05saf may also be used to maximize the objective function (see the option Optimize).
Due to the nature of global optimization, unless a predefined target is provided, there is no definitive way of knowing when to end a computation. As such several stopping heuristics have been implemented into the algorithm. If any of these is achieved, e05saf will exit with ${\mathbf{ifail}}={\mathbf{1}}$, and the parameter inform will indicate which criteria was reached. See inform for more information.
In addition, you may provide your own stopping criteria through monmod and objfun.
e05sbf provides a comprehensive interface, allowing for the inclusion of general nonlinear constraints.

## 4References

Gill P E, Murray W and Wright M H (1981) Practical Optimization Academic Press
Kennedy J and Eberhart R C (1995) Particle Swarm Optimization Proceedings of the 1995 IEEE International Conference on Neural Networks 1942–1948
Koh B, George A D, Haftka R T and Fregly B J (2006) Parallel Asynchronous Particle Swarm Optimization International Journal for Numerical Methods in Engineering 67(4) 578–595
Vaz A I and Vicente L N (2007) A Particle Swarm Pattern Search Method for Bound Constrained Global Optimization Journal of Global Optimization 39(2) 197–219 Kluwer Academic Publishers

## 5Arguments

Note: for descriptions of the symbolic variables, see Section 11.
1: $\mathbf{ndim}$Integer Input
On entry: $\mathit{ndim}$, the number of dimensions.
Constraint: ${\mathbf{ndim}}\ge 1$.
2: $\mathbf{npar}$Integer Input
On entry: $\mathit{npar}$, the number of particles to be used in the swarm. Assuming all particles remain within bounds, each complete iteration will perform at least npar function evaluations. Otherwise, significantly fewer objective function evaluations may be performed.
Suggested value: ${\mathbf{npar}}=10×{\mathbf{ndim}}$.
Constraint: ${\mathbf{npar}}\ge 5×\mathbf{num_threads}$, where num_threads is the value returned by the OpenMP environment variable OMP_NUM_THREADS, or num_threads is $1$ for a serial version of this routine.
3: $\mathbf{xb}\left({\mathbf{ndim}}\right)$Real (Kind=nag_wp) array Output
On exit: the location of the best solution found, $\stackrel{~}{\mathbf{x}}$, in ${R}^{\mathit{ndim}}$.
4: $\mathbf{fb}$Real (Kind=nag_wp) Output
On exit: the objective value of the best solution, $\stackrel{~}{f}=F\left(\stackrel{~}{\mathbf{x}}\right)$.
5: $\mathbf{bl}\left({\mathbf{ndim}}\right)$Real (Kind=nag_wp) array Input
6: $\mathbf{bu}\left({\mathbf{ndim}}\right)$Real (Kind=nag_wp) array Input
On entry: ${\mathbf{bl}}$ is $\mathbf{\ell }$, the array of lower bounds, bu is $\mathbf{u}$, the array of upper bounds. The ndim entries in bl and bu must contain the lower and upper simple (box) bounds of the variables respectively. These must be provided to initialize the sample population into a finite hypervolume, although their subsequent influence on the algorithm is user determinable (see the option Boundary in Section 12).
If ${\mathbf{bl}}\left(i\right)={\mathbf{bu}}\left(i\right)$ for any $i\in \left\{1,\dots ,{\mathbf{ndim}}\right\}$, variable $i$ will remain locked to ${\mathbf{bl}}\left(i\right)$ regardless of the Boundary option selected.
It is strongly advised that you place sensible lower and upper bounds on all variables, even if your model allows for variables to be unbounded (using the option ${\mathbf{Boundary}}=\mathrm{ignore}$) since these define the initial search space.
Constraints:
• ${\mathbf{bl}}\left(\mathit{i}\right)\le {\mathbf{bu}}\left(\mathit{i}\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{ndim}}$;
• ${\mathbf{bl}}\left(i\right)\ne {\mathbf{bu}}\left(i\right)$ for at least one $i\in \left\{1,\dots ,{\mathbf{ndim}}\right\}$.
7: $\mathbf{objfun}$Subroutine, supplied by the user. External Procedure
objfun must, depending on the value of mode, calculate the objective function and/or calculate the gradient of the objective function for a $\mathit{ndim}$-variable vector $\mathbf{x}$. Gradients are only required if a local minimizer has been chosen which requires gradients. See the option Local Minimizer for more information.
The specification of objfun is:
Fortran Interface
 Subroutine objfun ( mode, ndim, x, objf,
 Integer, Intent (In) :: ndim, nstate Integer, Intent (Inout) :: mode, iuser(*) Real (Kind=nag_wp), Intent (In) :: x(ndim) Real (Kind=nag_wp), Intent (Inout) :: objf, vecout(ndim), ruser(*)
 void objfun (Integer *mode, const Integer *ndim, const double x[], double *objf, double vecout[], const Integer *nstate, Integer iuser[], double ruser[])
1: $\mathbf{mode}$Integer Input/Output
On entry: indicates which functionality is required.
${\mathbf{mode}}=0$
$F\left(\mathbf{x}\right)$ should be returned in objf. The value of objf on entry may be used as an upper bound for the calculation. Any expected value of $F\left(\mathbf{x}\right)$ that is greater than objf may be approximated by this upper bound; that is objf can remain unaltered.
${\mathbf{mode}}=1$
${\mathbf{Local Minimizer}}=\mathrm{e04ucf}$ only
First derivatives can be evaluated and returned in vecout. Any unaltered elements of vecout will be approximated using finite differences.
${\mathbf{mode}}=2$
${\mathbf{Local Minimizer}}=\mathrm{e04ucf}$ only
$F\left(\mathbf{x}\right)$ must be calculated and returned in objf, and available first derivatives can be evaluated and returned in vecout. Any unaltered elements of vecout will be approximated using finite differences.
${\mathbf{mode}}=5$
$F\left(\mathbf{x}\right)$ must be calculated and returned in objf. The value of objf on entry may not be used as an upper bound.
${\mathbf{mode}}=6$
${\mathbf{Local Minimizer}}=\mathrm{e04dgf}$ or $\mathrm{e04kzf}$ only
All first derivatives must be evaluated and returned in vecout.
${\mathbf{mode}}=7$
${\mathbf{Local Minimizer}}=\mathrm{e04dgf}$ or $\mathrm{e04kzf}$ only
$F\left(\mathbf{x}\right)$ must be calculated and returned in objf, and all first derivatives must be evaluated and returned in vecout.
On exit: if the value of mode is set to be negative, e05saf will exit as soon as possible with ${\mathbf{ifail}}={\mathbf{3}}$ and ${\mathbf{inform}}={\mathbf{mode}}$.
2: $\mathbf{ndim}$Integer Input
On entry: the number of dimensions.
3: $\mathbf{x}\left({\mathbf{ndim}}\right)$Real (Kind=nag_wp) array Input
On entry: $\mathbf{x}$, the point at which the objective function and/or its gradient are to be evaluated.
4: $\mathbf{objf}$Real (Kind=nag_wp) Input/Output
On entry: the value of objf passed to objfun varies with the argument mode.
${\mathbf{mode}}=0$
objf is an upper bound for the value of $F\left(\mathbf{x}\right)$, often equal to the best value of $F\left(\mathbf{x}\right)$ found so far by a given particle. Only objective function values less than the value of objf on entry will be used further. As such this upper bound may be used to stop further evaluation when this will only increase the objective function value above the upper bound.
${\mathbf{mode}}=1$, $2$, $5$, $6$ or $7$
objf is meaningless on entry.
On exit: the value of objf returned varies with the argument mode.
${\mathbf{mode}}=0$
objf must be the value of $F\left(\mathbf{x}\right)$. Only values of $F\left(\mathbf{x}\right)$ strictly less than objf on entry need be accurate.
${\mathbf{mode}}=1$ or $6$
Need not be set.
${\mathbf{mode}}=2$, $5$ or $7$
$F\left(\mathbf{x}\right)$ must be calculated and returned in objf. The entry value of objf may not be used as an upper bound.
5: $\mathbf{vecout}\left({\mathbf{ndim}}\right)$Real (Kind=nag_wp) array Input/Output
On entry: if ${\mathbf{Local Minimizer}}=\mathrm{e04ucf}$ or $\mathrm{}$, the values of vecout are used internally to indicate whether a finite difference approximation is required. See e04ucf/​e04uca.
On exit: the required values of vecout returned to the calling routine depend on the value of mode.
${\mathbf{mode}}=0$ or $5$
The value of vecout need not be set.
${\mathbf{mode}}=1$ or $2$
vecout can contain components of the gradient of the objective function $\frac{\partial F}{\partial {x}_{i}}$ for some $i=1,2,\dots {\mathbf{ndim}}$, or acceptable approximations. Any unaltered elements of vecout will be approximated using finite differences.
${\mathbf{mode}}=6$ or $7$
vecout must contain the gradient of the objective function $\frac{\partial F}{\partial {x}_{i}}$ for all $i=1,2,\dots {\mathbf{ndim}}$. Approximation of the gradient is strongly discouraged, and no finite difference approximations will be performed internally (see e04dgf/​e04dga and e04kzf).
6: $\mathbf{nstate}$Integer Input
On entry: nstate indicates various stages of initialization throughout the routine. This allows for permanent global arguments to be initialized the least number of times. For example, you may initialize a random number generator seed.
${\mathbf{nstate}}=3$
SMP users only. objfun is called for the first time in a parallel region on a new thread other than the master thread. You may use this opportunity to set up any thread-dependent information in iuser and ruser.
${\mathbf{nstate}}=2$
objfun is called for the very first time. You may save computational time if certain data must be read or calculated only once.
${\mathbf{nstate}}=1$
objfun is called for the first time by a NAG local minimization routine. You may save computational time if certain data required for the local minimizer need only be calculated at the initial point of the local minimization.
${\mathbf{nstate}}=0$
Used in all other cases.
7: $\mathbf{iuser}\left(*\right)$Integer array User Workspace
8: $\mathbf{ruser}\left(*\right)$Real (Kind=nag_wp) array User Workspace
objfun is called with the arguments iuser and ruser as supplied to e05saf. You should use the arrays iuser and ruser to supply information to objfun.
objfun must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which e05saf is called. Arguments denoted as Input must not be changed by this procedure.
Note: objfun should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by e05saf. If your code inadvertently does return any NaNs or infinities, e05saf is likely to produce unexpected results.
8: $\mathbf{monmod}$Subroutine, supplied by the NAG Library or the user. External Procedure
A user-specified monitoring and modification function. monmod is called once every complete iteration after a finalization check. It may be used to modify the particle locations that will be evaluated at the next iteration. This permits the incorporation of algorithmic modifications such as including additional advection heuristics and genetic mutations. monmod is only called during the main loop of the algorithm, and as such will be unaware of any further improvement from the final local minimization. If no monitoring and/or modification is required, monmod may be the dummy monitoring routine e05sxm. (e05sxm is included in the NAG Library).
The specification of monmod is:
Fortran Interface
 Subroutine monmod ( ndim, npar, x, xb, fb, itt,
 Integer, Intent (In) :: ndim, npar, itt(6) Integer, Intent (Inout) :: iuser(*), inform Real (Kind=nag_wp), Intent (In) :: xb(ndim), fb, xbest(ndim,npar), fbest(npar) Real (Kind=nag_wp), Intent (Inout) :: x(ndim,npar), ruser(*)
 void monmod (const Integer *ndim, const Integer *npar, double x[], const double xb[], const double *fb, const double xbest[], const double fbest[], const Integer itt[], Integer iuser[], double ruser[], Integer *inform)
1: $\mathbf{ndim}$Integer Input
On entry: the number of dimensions.
2: $\mathbf{npar}$Integer Input
On entry: the number of particles.
3: $\mathbf{x}\left({\mathbf{ndim}},{\mathbf{npar}}\right)$Real (Kind=nag_wp) array Input/Output
Note: the $i$th component of the $j$th particle, ${x}_{j}\left(i\right)$, is stored in ${\mathbf{x}}\left(i,j\right)$.
On entry: the npar particle locations, ${\mathbf{x}}_{j}$, which will currently be used during the next iteration unless altered in monmod.
On exit: the particle locations to be used during the next iteration.
4: $\mathbf{xb}\left({\mathbf{ndim}}\right)$Real (Kind=nag_wp) array Input
On entry: the location, $\stackrel{~}{\mathbf{x}}$, of the best solution yet found.
5: $\mathbf{fb}$Real (Kind=nag_wp) Input
On entry: the objective value, $\stackrel{~}{f}=F\left(\stackrel{~}{\mathbf{x}}\right)$, of the best solution yet found.
6: $\mathbf{xbest}\left({\mathbf{ndim}},{\mathbf{npar}}\right)$Real (Kind=nag_wp) array Input
Note: the $i$th component of the position of the $j$th particle's cognitive memory, ${\stackrel{^}{x}}_{j}\left(i\right)$, is stored in ${\mathbf{xbest}}\left(i,j\right)$.
On entry: the locations currently in the cognitive memory, ${\stackrel{^}{\mathbf{x}}}_{\mathit{j}}$, for $\mathit{j}=1,2,\dots ,{\mathbf{npar}}$ (see Section 11).
7: $\mathbf{fbest}\left({\mathbf{npar}}\right)$Real (Kind=nag_wp) array Input
On entry: the objective values currently in the cognitive memory, $F\left({\stackrel{^}{\mathbf{x}}}_{\mathit{j}}\right)$, for $\mathit{j}=1,2,\dots ,{\mathbf{npar}}$.
8: $\mathbf{itt}\left(6\right)$Integer array Input
On entry: iteration and function evaluation counters (see description of itt below).
9: $\mathbf{iuser}\left(*\right)$Integer array User Workspace
10: $\mathbf{ruser}\left(*\right)$Real (Kind=nag_wp) array User Workspace
monmod is called with the arguments iuser and ruser as supplied to e05saf. You should use the arrays iuser and ruser to supply information to monmod.
11: $\mathbf{inform}$Integer Input/Output
On entry: ${\mathbf{inform}}=\mathbf{thread_num}$, where thread_num is the value returned by a call of x06adf. If running in serial this will always be zero.
On exit: setting ${\mathbf{inform}}<0$ will cause near immediate exit from e05saf. This value will be returned as inform with ${\mathbf{ifail}}={\mathbf{3}}$. You need not set inform unless you wish to force an exit.
monmod must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which e05saf is called. Arguments denoted as Input must not be changed by this procedure.
Note: monmod should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by e05saf. If your code inadvertently does return any NaNs or infinities, e05saf is likely to produce unexpected results.
9: $\mathbf{iopts}\left(*\right)$Integer array Communication Array
Note: the dimension of this array is dictated by the requirements of associated functions that must have been previously called. This array must be the same array passed as argument iopts in the previous call to e05zkf.
On entry: optional parameter array as generated and possibly modified by calls to e05zkf. The contents of iopts must not be modified directly between calls to e05saf, e05zkf or e05zlf.
10: $\mathbf{opts}\left(*\right)$Real (Kind=nag_wp) array Communication Array
Note: the dimension of this array is dictated by the requirements of associated functions that must have been previously called. This array must be the same array passed as argument opts in the previous call to e05zkf.
On entry: optional parameter array as generated and possibly modified by calls to e05zkf. The contents of opts must not be modified directly between calls to e05saf, e05zkf or e05zlf.
11: $\mathbf{iuser}\left(*\right)$Integer array User Workspace
iuser is not used by e05saf, but is passed directly to objfun and monmod and may be used to pass information to these routines.
With care, you may also write information back into iuser. This might be useful, for example, should there be a need to preserve the state of a random number generator.
With SMP-enabled versions of e05saf the array iuser provided are classified as OpenMP shared memory. Use of iuser has to take account of this in order to preserve thread safety whenever information is written back to either of these arrays.
12: $\mathbf{ruser}\left(*\right)$Real (Kind=nag_wp) array User Workspace
ruser is not used by e05saf, but is passed directly to objfun and monmod and may be used to pass information to these routines.
With care, you may also write information back into ruser. This might be useful, for example, should there be a need to preserve the state of a random number generator.
With SMP-enabled versions of e05saf the array ruser provided are classified as OpenMP shared memory. Use of ruser has to take account of this in order to preserve thread safety whenever information is written back to either of these arrays.
13: $\mathbf{itt}\left(6\right)$Integer array Output
On exit: integer iteration counters for e05saf.
${\mathbf{itt}}\left(1\right)$
Number of complete iterations.
${\mathbf{itt}}\left(2\right)$
Number of complete iterations without improvement to the current optimum.
${\mathbf{itt}}\left(3\right)$
Number of particles converged to the current optimum.
${\mathbf{itt}}\left(4\right)$
Number of improvements to the optimum.
${\mathbf{itt}}\left(5\right)$
Number of function evaluations performed.
${\mathbf{itt}}\left(6\right)$
Number of particles reset.
14: $\mathbf{inform}$Integer Output
On exit: indicates which finalization criterion was reached. The possible values of inform are:
inform Meaning
$<0$ Exit from a user-supplied subroutine.
0 e05saf has detected an error and terminated.
1 The provided objective target has been achieved. (Target Objective Value).
2 The standard deviation of the location of all the particles is below the set threshold (Swarm Standard Deviation). If the solution returned is not satisfactory, you may try setting a smaller value of Swarm Standard Deviation, or try adjusting the options governing the repulsive phase (Repulsion Initialize, Repulsion Finalize).
3 The total number of particles converged (Maximum Particles Converged) to the current global optimum has reached the set limit. This is the number of particles which have moved to a distance less than Distance Tolerance from the optimum with regard to the ${L}^{2}$ norm. If the solution is not satisfactory, you may consider lowering the Distance Tolerance. However, this may hinder the global search capability of the algorithm.
4 The maximum number of iterations without improvement (Maximum Iterations Static) has been reached, and the required number of particles (Maximum Iterations Static Particles) have converged to the current optimum. Increasing either of these options will allow the algorithm to continue searching for longer. Alternatively if the solution is not satisfactory, re-starting the application several times with ${\mathbf{Repeatability}}=\mathrm{OFF}$ may lead to an improved solution.
5 The maximum number of iterations (Maximum Iterations Completed) has been reached. If the number of iterations since improvement is small, then a better solution may be found by increasing this limit, or by using the option Local Minimizer with corresponding exterior options. Otherwise if the solution is not satisfactory, you may try re-running the application several times with ${\mathbf{Repeatability}}=\mathrm{OFF}$ and a lower iteration limit, or adjusting the options governing the repulsive phase (Repulsion Initialize, Repulsion Finalize).
6 The maximum allowed number of function evaluations (Maximum Function Evaluations) has been reached. As with ${\mathbf{inform}}=5$, increasing this limit if the number of iterations without improvement is small, or decreasing this limit and running the algorithm multiple times with ${\mathbf{Repeatability}}=\mathrm{OFF}$, may provide a superior result.
15: $\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.
On exit: the most common exit will be ${\mathbf{ifail}}={\mathbf{1}}$.
For this reason, the value $-1$ or $1$ is recommended. If the output of error messages is undesirable, the value $1$ is recommended; otherwise, the recommended value is $-1$. When the value $-\mathbf{1}$ or $1$ is used it is essential to test the value of ifail on exit.
e05saf will return ${\mathbf{ifail}}={\mathbf{0}}$ if and only if a finalization criterion has been reached which can guarantee success. This may only happen if the option Target Objective Value has been set and reached at a point within the search domain. The finalization criterion Target Objective Value is not activated using default option settings, and must be explicitly set using e05zkf if required.
e05saf will return ${\mathbf{ifail}}={\mathbf{1}}$ if no error has been detected, and a finalization criterion has been achieved which cannot guarantee success. This does not indicate that the routine has failed, merely that the returned solution cannot be guaranteed to be the true global optimum.
The value of inform should be examined to determine which finalization criterion was reached.
Other positive values of ifail indicate that either an error or a warning has been triggered. See Sections 6, 7 and 11 for more information.

## 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$
A finalization criterion was reached that cannot guarantee success.
On exit, ${\mathbf{inform}}=⟨\mathit{\text{value}}⟩$.
${\mathbf{ifail}}=2$
If the option Target Warning has been activated, this indicates that the Target Objective Value has been achieved to specified tolerances at a sufficiently constrained point, either during the initialization phase, or during the first two iterations of the algorithm. While this is not necessarily an error, it may occur if:
1. (i)The target was achieved at the first point sampled by the routine. This will be the mean of the lower and upper bounds.
2. (ii)The target may have been achieved at a randomly generated sample point. This will always be a possibility provided that the domain under investigation contains a point with a target objective value.
3. (iii)If the Local Minimizer has been set, then a sample point may have been inside the basin of attraction of a satisfactory point. If this occurs repeatedly when the routine is called, it may imply that the objective is largely unimodal, and that it may be more efficient to use the routine selected as the Local Minimizer directly.
Assuming that objfun is correct, you may wish to set a better Target Objective Value, or a stricter Target Objective Tolerance.
${\mathbf{ifail}}=3$
User requested exit $⟨\mathit{\text{value}}⟩$ during call to monmod.
User requested exit $⟨\mathit{\text{value}}⟩$ during call to objfun.
${\mathbf{ifail}}=11$
On entry, ${\mathbf{ndim}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ndim}}\ge 1$.
${\mathbf{ifail}}=12$
On entry, ${\mathbf{npar}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{npar}}\ge 5×\mathbf{num_threads}$, where num_threads is the value returned by the OpenMP environment variable OMP_NUM_THREADS, or num_threads is $1$ for a serial version of this routine.
${\mathbf{ifail}}=14$
On entry, ${\mathbf{bl}}\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$ and ${\mathbf{bu}}\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{bu}}\left(i\right)\ge {\mathbf{bl}}\left(i\right)$ for all $i$.
On entry, ${\mathbf{bl}}\left(i\right)={\mathbf{bu}}\left(i\right)$ for all $i$.
Constraint: ${\mathbf{bu}}\left(i\right)>{\mathbf{bl}}\left(i\right)$ for at least one $i$.
${\mathbf{ifail}}=19$
Error $⟨\mathit{\text{value}}⟩$ occurred whilst adjusting to exterior local minimizer options.
Error $⟨\mathit{\text{value}}⟩$ occurred whilst adjusting to interior local minimizer options.
${\mathbf{ifail}}=21$
Either the option arrays have not been initialized for e05saf, or they have become corrupted.
${\mathbf{ifail}}=32$
Derivative checks indicate possible errors in the supplied derivatives. Gradient checks may be disabled by setting ${\mathbf{Verify Gradients}}=\mathrm{OFF}$.
${\mathbf{ifail}}=51$
Multiple SMP threads have been detected; however, the option SMP Callback Thread Safe has not been set.
Set ${\mathbf{SMP Callback Thread Safe}}=\mathrm{YES}$ if the provided callbacks are thread safe.
Set ${\mathbf{SMP Callback Thread Safe}}=\mathrm{NO}$ if the provided callbacks are not thread safe, to force serial execution.
${\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.

## 7Accuracy

If ${\mathbf{ifail}}={\mathbf{0}}$ (or ${\mathbf{ifail}}={\mathbf{2}}$) or ${\mathbf{ifail}}={\mathbf{1}}$ on exit, either a Target Objective Value or finalization criterion has been reached, depending on user selected options. As with all global optimization software, the solution achieved may not be the true global optimum. Various options allow for either greater search diversity or faster convergence to a (local) optimum (See Sections 11 and 12).
Provided the objective function and constraints are sufficiently well behaved, if a local minimizer is used in conjunction with e05saf, then it is more likely that the final result will at least be in the near vicinity of a local optimum, and due to the global search characteristics of the particle swarm, this solution should be superior to many other local optima.
Caution should be used in accelerating the rate of convergence, as with faster convergence, less of the domain will remain searchable by the swarm, making it increasingly difficult for the algorithm to detect the basin of attraction of superior local optima. Using the options Repulsion Initialize and Repulsion Finalize described in Section 12 will help to overcome this, by causing the swarm to diverge away from the current optimum once no more local improvement is likely.
On successful exit with guaranteed success, ${\mathbf{ifail}}={\mathbf{0}}$. This may only happen if a Target Objective Value is assigned and is reached by the algorithm.
On successful exit without guaranteed success, ${\mathbf{ifail}}={\mathbf{1}}$ is returned. This will happen if another finalization criterion is achieved without the detection of an error.
In both cases, the value of inform provides further information as to the cause of the exit.

## 8Parallelism and Performance

e05saf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
e05saf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
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.
The algorithm has been parallelized to allow for a high degree of asynchronicity between threads. Each thread is assigned a static number of the npar particles requested, and performs a sub-iteration using these particles and a private copy of $\stackrel{~}{\mathbf{x}}$. The thread only updates this private copy if a superior solution is found. In these implementations, this routine may make calls to the user-supplied functions from within an OpenMP parallel region. Thus OpenMP directives within the user functions can only be used if you are compiling the user-supplied function and linking the executable in accordance with the instructions in the Users' Note for your implementation.
Once a thread has completed a sub-iteration, it enters a brief critical section where it compares this private $\stackrel{~}{\mathbf{x}}$ to a globally accessible version. If either is superior, the inferior version is updated and the thread continues into a new sub-iteration.
Parallelizing the algorithm in this way allows for individual threads to continue searching even if other threads are completing sub-iterations in inferior times. The optional parameter SMP Thread Overrun allows you to force a synchronization across the team of threads once one thread completes sufficiently more sub-iterations than the slowest thread. In particular, this may be used to force synchronization after every sub-iteration if so desired.
When using an SMP parallel version of this routine, you must indicate that the callback routines are thread safe by setting the optional parameter SMP Callback Thread Safe before calling e05saf in a multithreaded environment. See Section 12.2 for more information on this and other SMP options.
Note:  the stochastic method used in e05saf will not produce repeatable answers when run on multiple threads.

The memory used by e05saf is relatively static throughout. As such, e05saf may be used in problems with high dimension number (${\mathbf{ndim}}>100$) without the concern of computational resource exhaustion, although the probability of successfully locating the global optimum will decrease dramatically with the increase in dimensionality.
Due to the stochastic nature of the algorithm, the result will vary over multiple runs. This is particularly true if arguments and options are chosen to accelerate convergence at the expense of the global search. However, the option ${\mathbf{Repeatability}}=\mathrm{ON}$ may be set to initialize the internal random number generator using a preset seed, which will result in identical solutions being obtained.
(For SMP users only) The option ${\mathbf{Repeatability}}=\mathrm{ON}$ will use preset seeds to initialize the random number generator on each thread, however due to the unpredictable nature of parallel communication, this cannot ensure repeatable results when running on multiple threads, even with SMP Thread Overrun set to force synchronization every iteration.

## 10Example

This example uses a particle swarm to find the global minimum of the Schwefel function:
 $minimize x∈Rndim f = ∑ i=1 ndim xi sin(|xi|)$
 $xi ∈ (−500,500) , for ​ i=1,2,…,ndim .$
In two dimensions the optimum is ${f}_{\mathrm{min}}=-837.966$, located at $\mathbf{x}=\left(-420.97,-420.97\right)$.
The example demonstrates how to initialize and set the options arrays using e05zkf, how to query options using e05zlf, and finally how to search for the global optimum using e05saf. The function is minimized several times to demonstrate using e05saf alone, and coupled with local minimizers. This program uses the non-default option ${\mathbf{Repeatability}}=\mathrm{ON}$ to produce repeatable solutions.
Note: for users of multithreaded implementations of the NAG Library an additional example program, e05safe_smp.f90, is included with the distribution materials to illustrate how to safely access independent subsections of the provided iuser and ruser arrays from multiple threads and how to use e05zkf to set additional SMP threading related options.

### 10.1Program Text

Program Text (e05safe.f90)
Program Text (e05safe_smp.f90)

None.

### 10.3Program Results

Program Results (e05safe.r)
Program Results (e05safe_smp.r)

## 11Algorithmic Details

The following pseudo-code describes the algorithm used with the repulsion mechanism.
 $INITIALIZE for ​ j=1, ​ np xj = R ∈ U(ℓbox,ubox) x^ j = R∈ U(ℓbox,ubox) vj = R ∈ U( -V max ,Vmax) f^j = F ( x^ j ) initialize ​wj wj = { Wmax Weight Initialize=MAXIMUM Wini Weight Initialize=INITIAL R ∈ U ( W min , W max ) Weight Initialize=RANDOMIZED end for x~ = 12 (ℓbox+ubox) f~ = F (x~) Ic = Is = 0 SWARM while (not finalized), Ic = Ic + 1 for ​ j = 1 , np xj = BOUNDARY(xj,ℓbox,ubox) fj = F (xj) if ​ (fj
The definition of terms used in the above pseudo-code are as follows.
 ${n}_{p}$ the number of particles, npar ${\mathbf{\ell }}_{\mathrm{box}}$ array of ndim lower box bounds ${\mathbf{u}}_{\mathrm{box}}$ array of ndim upper box bounds ${\mathbf{x}}_{j}$ position of particle $j$ ${\stackrel{^}{\mathbf{x}}}_{j}$ best position found by particle $j$ $\stackrel{~}{\mathbf{x}}$ best position found by any particle ${f}_{j}$ $F\left({\mathbf{x}}_{j}\right)$ ${\stackrel{^}{f}}_{j}$ $F\left({\stackrel{^}{\mathbf{x}}}_{j}\right)$, best value found by particle $j$ $\stackrel{~}{f}$ $F\left(\stackrel{~}{\mathbf{x}}\right)$, best value found by any particle ${\mathbf{v}}_{j}$ velocity of particle $j$ ${w}_{j}$ weight on ${\mathbf{v}}_{j}$ for velocity update, decreasing according to Weight Decrease ${V}_{\mathrm{max}}$ maximum absolute velocity, dependent upon Maximum Variable Velocity ${I}_{c}$ swarm iteration counter ${I}_{s}$ iterations since $\stackrel{~}{\mathbf{x}}$ was updated ${\mathbf{D}}_{1},{\mathbf{D}}_{2}$ diagonal matrices with random elements in range $\left(0,1\right)$ ${C}_{s}$ the cognitive advance coefficient which weights velocity towards ${\stackrel{^}{\mathbf{x}}}_{j}$, adjusted using Advance Cognitive ${C}_{g}$ the global advance coefficient which weights velocity towards $\stackrel{~}{\mathbf{x}}$, adjusted using Advance Global $\mathit{dtol}$ the Distance Tolerance for resetting a converged particle $\mathbf{R}\in U\left({\mathbf{\ell }}_{\mathrm{box}},{\mathbf{u}}_{\mathrm{box}}\right)$ an array of random numbers whose $i$th element is drawn from a uniform distribution in the range $\left({{\mathbf{\ell }}_{\mathrm{box}}}_{\mathit{i}},{{\mathbf{u}}_{\mathrm{box}}}_{\mathit{i}}\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{ndim}}$ ${O}_{i}$ local optimizer interior options ${O}_{e}$ local optimizer exterior options $\mathrm{LOCMIN}\left(\mathbf{x},f,O\right)$ apply local optimizer using the set of options $O$ using the solution $\left(\mathbf{x},f\right)$ as the starting point, if used (not default) monmod monitor progress and possibly modify ${\mathbf{x}}_{j}$ BOUNDARY apply required behaviour for ${\mathbf{x}}_{j}$ outside bounding box, (see Boundary) new ($\stackrel{~}{f}$) true if $\stackrel{~}{\mathbf{x}}$, $\stackrel{~}{\mathbf{c}}$, $\stackrel{~}{f}$ were updated at this iteration
Additionally a repulsion phase can be introduced by changing from the default values of options Repulsion Finalize (${r}_{f}$), Repulsion Initialize (${r}_{i}$) and Repulsion Particles (${r}_{p}$). If the number of static particles is denoted ${n}_{s}$ then the following can be inserted after the new($\stackrel{~}{f}$) check in the pseudo-code above.
 $else ​ if ​ ( ns ≥ rp ​ and ​ ri ≤ Is ≤ ri + rf ) LOCMIN(x~,f~,Oi) use ​ -Cg ​ instead of ​ Cg ​ in velocity updates if ​ (Is=ri+rf) Is = 0$

## 12Optional Parameters

This section can be skipped if you wish to use the default values for all optional parameters, otherwise, the following is a list of the optional parameters available and a full description of each optional parameter is provided in Section 12.1.

### 12.1Description of the Optional Parameters

For each option, we give a summary line, a description of the optional parameter and details of constraints.
The summary line contains:
• the keywords;
• a parameter value, where the letters $a$, $i$ and $r$ denote options that take character, integer and real values respectively;
• the default value, where the symbol $\epsilon$ is a generic notation for machine precision (see x02ajf), and $\mathit{Imax}$ represents the largest representable integer value (see x02bbf).
All options accept the value ‘DEFAULT’ in order to return single options to their default states.
Keywords and character values are case insensitive, however they must be separated by at least one space.
For e05saf the maximum length of the argument cvalue used by e05zlf is $15$.
 Advance Cognitive $r$ Default $\text{}=2.0$
The cognitive advance coefficient, ${C}_{s}$. When larger than the global advance coefficient, this will cause particles to be attracted toward their previous best positions. Setting $r=0.0$ will cause e05saf to act predominantly as a local optimizer. Setting $r>2.0$ may cause the swarm to diverge, and is generally inadvisable. At least one of the global and cognitive coefficients must be nonzero.
 Advance Global $r$ Default $\text{}=2.0$
The global advance coefficient, ${C}_{g}$. When larger than the cognitive coefficient this will encourage convergence toward the best solution yet found. Values $r\in \left(0,1\right)$ will inhibit particles overshooting the optimum. Values $r\in \left[1,2\right)$ cause particles to fly over the optimum some of the time. Larger values can prohibit convergence. Setting $r=0.0$ will remove any attraction to the current optimum, effectively generating a Monte Carlo multi-start optimization algorithm. At least one of the global and cognitive coefficients must be nonzero.
 Boundary $a$ Default $\text{}=\mathrm{FLOATING}$
Determines the behaviour if particles leave the domain described by the box bounds. This only affects the general PSO algorithm, and will not pass down to any NAG local minimizers chosen.
This option is only effective in those dimensions for which ${\mathbf{bl}}\left(i\right)\ne {\mathbf{bu}}\left(i\right)$, $i=1,2,\dots ,{\mathbf{ndim}}$.
IGNORE
The box bounds are ignored. The objective function is still evaluated at the new particle position.
RESET
The particle is re-initialized inside the domain. ${\stackrel{^}{\mathbf{x}}}_{j}$ and ${\stackrel{^}{f}}_{j}$ are not affected.
FLOATING
The particle position remains the same, however the objective function will not be evaluated at the next iteration. The particle will probably be advected back into the domain at the next advance due to attraction by the cognitive and global memory.
HYPERSPHERICAL
The box bounds are wrapped around an $\mathit{ndim}$-dimensional hypersphere. As such a particle leaving through a lower bound will immediately re-enter through the corresponding upper bound and vice versa. The standard distance between particles is also modified accordingly.
FIXED
The particle rests on the boundary, with the corresponding dimensional velocity set to $0.0$.
 Distance Scaling $a$ Default $\text{}=\mathrm{ON}$
Determines whether distances should be scaled by box widths.
ON
When a distance is calculated between $\mathbf{x}$ and $\mathbf{y}$, a scaled ${L}^{2}$ norm is used.
 $L2 (x,y) = ( ∑ {i|ui≠ℓi,i≤ndim} ( xi - yi ui - ℓi ) 2 ) 1 2 .$
OFF
Distances are calculated as the standard ${L}^{2}$ norm without any rescaling.
 $L2 (x,y) = ( ∑ i=1 ndim (xi-yi) 2 ) 1 2 .$
 Distance Tolerance $r$ Default $\text{}={10}^{-4}$
This is the distance, $\mathit{dtol}$ between particles and the global optimum which must be reached for the particle to be considered converged, i.e., that any subsequent movement of such a particle cannot significantly alter the global optimum. Once achieved the particle is reset into the box bounds to continue searching.
Constraint: $r>0.0$.
 Function Precision $r$ Default $\text{}={\epsilon }^{0.9}$
The parameter defines ${\epsilon }_{r}$, which is intended to be a measure of the accuracy with which the problem function $F\left(\mathbf{x}\right)$ can be computed. If $r<\epsilon$ or $r\ge 1$, the default value is used.
The value of ${\epsilon }_{r}$ should reflect the relative precision of $1+|F\left(\mathbf{x}\right)|$; i.e., ${\epsilon }_{r}$ acts as a relative precision when $|F|$ is large, and as an absolute precision when $|F|$ is small. For example, if $F\left(\mathbf{x}\right)$ is typically of order $1000$ and the first six significant digits are known to be correct, an appropriate value for ${\epsilon }_{r}$ would be ${10}^{-6}$. In contrast, if $F\left(\mathbf{x}\right)$ is typically of order ${10}^{-4}$ and the first six significant digits are known to be correct, an appropriate value for ${\epsilon }_{r}$ would be ${10}^{-10}$. The choice of ${\epsilon }_{r}$ can be quite complicated for badly scaled problems; see Chapter 8 of Gill et al. (1981) for a discussion of scaling techniques. The default value is appropriate for most simple functions that are computed with full accuracy. However when the accuracy of the computed function values is known to be significantly worse than full precision, the value of ${\epsilon }_{r}$ should be large enough so that no attempt will be made to distinguish between function values that differ by less than the error inherent in the calculation.
 Local Boundary Restriction $r$ Default $\text{}=0.5$
Contracts the box boundaries used by a box constrained local minimizer to, $\left[{\beta }_{l},{\beta }_{u}\right]$, containing the start point $x$, where
 $∂i = r × (ui-ℓi) βli = max(ℓi, xi - ∂i2 ) βui = min(ui, xi + ∂i2 ) , i=1,…,ndim .$
Smaller values of $r$ thereby restrict the size of the domain exposed to the local minimizer, possibly reducing the amount of work done by the local minimizer.
Constraint: $0.0\le r\le 1.0$.
 Local Interior Iterations ${i}_{1}$
 Local Interior Major Iterations ${i}_{1}$
 Local Exterior Iterations ${i}_{2}$
 Local Exterior Major Iterations ${i}_{2}$
The maximum number of iterations or function evaluations the chosen local minimizer will perform inside (outside) the main loop if applicable. For the NAG minimizers these correspond to:
Minimizer Parameter/option Default Interior Default Exterior
e04cbf maxcal ${\mathbf{ndim}}+10$ $2×{\mathbf{ndim}}+15$
e04dgf/​e04dga Iteration Limit $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(30,3×{\mathbf{ndim}}\right)$ $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(50,5×{\mathbf{ndim}}\right)$
e04ucf/​e04uca Major Iteration Limit $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(10,2×{\mathbf{ndim}}\right)$ $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(30,3×{\mathbf{ndim}}\right)$
Unless set, these are functions of the parameters passed to e05saf.
Setting $i=0$ will disable the local minimizer in the corresponding algorithmic region. For example, setting ${\mathbf{Local Interior Iterations}}=0$ and ${\mathbf{Local Exterior Iterations}}=30$ will cause the algorithm to perform no local minimizations inside the main loop of the algorithm, and a local minimization with upto $30$ iterations after the main loop has been exited.
Note: currently e04jyf or e04kzf are restricted to using $400×{\mathbf{ndim}}$ and $50×{\mathbf{ndim}}$ as function evaluation limits respectively. This applies to both local minimizations inside and outside the main loop. They may still be deactivated in either phase by setting $i=0$, and may subsequently be reactivated in either phase by setting $i>0$.
Constraint: ${i}_{1}\ge 0$${i}_{2}\ge 0$.
 Local Interior Tolerance ${r}_{1}$ Default $\text{}={10}^{-4}$
 Local Exterior Tolerance ${r}_{2}$ Default $\text{}={10}^{-4}$
This is the tolerance provided to a local minimizer in the interior (exterior) of the main loop of the algorithm.
Constraint: ${r}_{1}>0.0$,${r}_{2}>0.0$.
 Local Interior Minor Iterations ${i}_{1}$
 Local Exterior Minor Iterations ${i}_{2}$
Where applicable, the secondary number of iterations the chosen local minimizer will use inside (outside) the main loop. Currently the relevant default values are:
Minimizer Parameter/option Default Interior Default Exterior
e04ucf/​e04uca Minor Iteration Limit $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(10,2×{\mathbf{ndim}}\right)$ $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(30,3×{\mathbf{ndim}}\right)$
Constraint: ${i}_{1}\ge 0$${i}_{2}\ge 0$.
 Local Minimizer $a$ Default $\text{}=\mathrm{OFF}$
Allows for a choice of Chapter E04 routines to be used as a coupled, dedicated local minimizer.
${\mathbf{Local Minimizer}}=\mathrm{OFF}$
No local minimization will be performed in either the INTERIOR or EXTERIOR sections of the algorithm.
${\mathbf{Local Minimizer}}=\mathrm{e04cbf}$
Use e04cbf as the local minimizer. This does not require the calculation of derivatives.
On a call to objfun during a local minimization, ${\mathbf{mode}}=5$.
${\mathbf{Local Minimizer}}=\mathrm{e04kzf}$
Use e04kzf as the local minimizer. This requires the calculation of derivatives in objfun, as indicated by mode.
The box bounds forwarded to this routine from e05saf will have been acted upon by Local Boundary Restriction. As such, the domain exposed may be greatly smaller than that provided to e05saf.
Accurate derivatives must be provided to this routine, and will not be approximated internally. Each iteration of this local minimizer also requires the calculation of both the objective function and its derivative. Hence on a call to objfun during a local minimization, ${\mathbf{mode}}=7$.
${\mathbf{Local Minimizer}}=\mathrm{e04jyf}$
Use e04jyf as the local minimizer. This does not require the calculation of derivatives.
On a call to objfun during a local minimization, ${\mathbf{mode}}=5$.
The box bounds forwarded to this routine from e05saf will have been acted upon by Local Boundary Restriction. As such, the domain exposed may be greatly smaller than that provided to e05saf.
${\mathbf{Local Minimizer}}=\mathrm{e04dgf}$
Use e04dgf/​e04dga as the local minimizer.
Accurate derivatives must be provided, and will not be approximated internally. Additionally, each call to objfun during a local minimization will require either the objective to be evaluated alone, or both the objective and its gradient to be evaluated. Hence on a call to objfun, ${\mathbf{mode}}=5$ or $7$.
${\mathbf{Local Minimizer}}=\mathrm{e04ucf}$
Use e04ucf/​e04uca as the local minimizer. This operates such that any derivatives of the objective function that you cannot supply, will be approximated internally using finite differences.
Either, the objective, objective gradient, or both may be requested during a local minimization, and as such on a call to objfun, ${\mathbf{mode}}=1$, $2$ or $5$.
The box bounds forwarded to this routine from e05saf will have been acted upon by Local Boundary Restriction. As such, the domain exposed may be greatly smaller than that provided to e05saf.
 Maximum Function Evaluations $i$ Default $=\mathit{Imax}$
The maximum number of evaluations of the objective function. When reached this will return ${\mathbf{ifail}}={\mathbf{1}}$ and ${\mathbf{inform}}=6$.
Constraint: $i>0$.
 Maximum Iterations Completed $i$ Default $\text{}=1000×{\mathbf{ndim}}$
The maximum number of complete iterations that may be performed. Once exceeded e05saf will exit with ${\mathbf{ifail}}={\mathbf{1}}$ and ${\mathbf{inform}}=5$.
Unless set, this adapts to the parameters passed to e05saf.
Constraint: $i\ge 1$.
 Maximum Iterations Static $i$ Default $\text{}=100$
The maximum number of iterations without any improvement to the current global optimum. If exceeded e05saf will exit with ${\mathbf{ifail}}={\mathbf{1}}$ and ${\mathbf{inform}}=4$. This exit will be hindered by setting Maximum Iterations Static Particles to larger values.
Constraint: $i\ge 1$.
 Maximum Iterations Static Particles $i$ Default $\text{}=0$
The minimum number of particles that must have converged to the current optimum before the routine may exit due to Maximum Iterations Static with ${\mathbf{ifail}}={\mathbf{1}}$ and ${\mathbf{inform}}=4$.
Constraint: $i\ge 0$.
 Maximum Particles Converged $i$ Default $=\mathit{Imax}$
The maximum number of particles that may converge to the current optimum. When achieved, e05saf will exit with ${\mathbf{ifail}}={\mathbf{1}}$ and ${\mathbf{inform}}=3$. This exit will be hindered by setting ‘Repulsion’ options, as these cause the swarm to re-expand.
Constraint: $i>0$.
 Maximum Particles Reset $i$ Default $=\mathit{Imax}$
The maximum number of particles that may be reset after converging to the current optimum. Once achieved no further particles will be reset, and any particles within Distance Tolerance of the global optimum will continue to evolve as normal.
Constraint: $i>0$.
 Maximum Variable Velocity $r$ Default $\text{}=0.25$
Along any dimension $j$, the absolute velocity is bounded above by $|{\mathbf{v}}_{j}|\le r×\left({\mathbf{u}}_{j}-{\mathbf{\ell }}_{j}\right)={\mathbf{V}}_{\mathrm{max}}$. Very low values will greatly increase convergence time. There is no upper limit, although larger values will allow more particles to be advected out of the box bounds, and values greater than $4.0$ may cause significant and potentially unrecoverable swarm divergence.
Constraint: $r>0.0$.
 Optimize $a$ Default $\text{}=\mathrm{MINIMIZE}$
Determines whether to maximize or minimize the objective function.
MINIMIZE
The objective function will be minimized.
MAXIMIZE
The objective function will be maximized. This is accomplished by minimizing the negative of the objective.
 Repeatability $a$ Default $\text{}=\mathrm{OFF}$
Allows for the same random number generator seed to be used for every call to e05saf. ${\mathbf{Repeatability}}=\mathrm{OFF}$ is recommended in general.
OFF
The internal generation of random numbers will be nonrepeatable.
ON
The same seed will be used.
 Repulsion Finalize $i$ Default $=\mathit{Imax}$
The number of iterations performed in a repulsive phase before re-contraction. This allows a re-diversified swarm to contract back toward the current optimum, allowing for a finer search of the near optimum space.
Constraint: $i\ge 2$.
 Repulsion Initialize $i$ Default $=\mathit{Imax}$
The number of iterations without any improvement to the global optimum before the algorithm begins a repulsive phase. This phase allows the particle swarm to re-expand away from the current optimum, allowing more of the domain to be investigated. The repulsive phase is automatically ended if a superior optimum is found.
Constraint: $i\ge 2$.
 Repulsion Particles $i$ Default $\text{}=0$
The number of particles required to have converged to the current optimum before any repulsive phase may be initialized. This will prevent repulsion before a satisfactory search of the near optimum area has been performed, which may happen for large dimensional problems.
Constraint: $i\ge 0$.
 Seed $i$ Default $\text{}=0$
Sets the random number generator seed to be used when ${\mathbf{Repeatability}}=\mathrm{ON}$. If set to 0, the default seed will be used. If not, the absolute value of Seed will be used to generate the random number generator seed.
 Swarm Standard Deviation $r$ Default $\text{}=0.1$
The target standard deviation of the particle distances from the current optimum. Once the standard deviation is below this level, e05saf will exit with ${\mathbf{ifail}}={\mathbf{1}}$ and ${\mathbf{inform}}=2$. This criterion will be penalized by the use of ‘Repulsion’ options, as these cause the swarm to re-expand, increasing the standard deviation of the particle distances from the best point.
In SMP parallel implementations of e05saf, the standard deviation will be calculated based only on the particles local to the particular thread that checks for finalization. Considerably fewer particles may be used in this calculation than when the algorithm is run in serial. It is, therefore, recommended that you provide a smaller value of Swarm Standard Deviation when running in parallel than when running in serial.
Constraint: $r\ge 0.0$.
 Target Objective $a$ Default $\text{}=\mathrm{OFF}$
 Target Objective Value $r$ Default $\text{}=0.0$
Activate or deactivate the use of a target value as a finalization criterion. If active, then once the supplied target value for the objective function is found (beyond the first iteration if Target Warning is active) e05saf will exit with ${\mathbf{ifail}}={\mathbf{0}}$ and ${\mathbf{inform}}=1$. Other than checking for feasibility only (${\mathbf{Optimize}}=\mathrm{CONSTRAINTS}$), this is the only finalization criterion that guarantees that the algorithm has been successful. If the target value was achieved at the initialization phase or first iteration and Target Warning is active, e05saf will exit with ${\mathbf{ifail}}={\mathbf{2}}$. This option may take any real value $r$, or the character ON/OFF as well as DEFAULT. If this option is queried using e05zlf, the current value of $r$ will be returned in rvalue, and cvalue will indicate whether this option is ON or OFF. The behaviour of the option is as follows:
$r$
Once a point is found with an objective value within the Target Objective Tolerance of $r$, e05saf will exit successfully with ${\mathbf{ifail}}={\mathbf{0}}$ and ${\mathbf{inform}}=1$.
OFF
The current value of $r$ will remain stored, however it will not be used as a finalization criterion.
ON
The current value of $r$ stored will be used as a finalization criterion.
DEFAULT
The stored value of $r$ will be reset to its default value ($0.0$), and this finalization criterion will be deactivated.
 Target Objective Safeguard $r$ Default $\text{}=100.0\epsilon$
If you have given a target objective value to reach in $\mathit{objval}$ (the value of the optional parameter Target Objective Value), $\mathit{objsfg}$ sets your desired safeguarded termination tolerance, for when $\mathit{objval}$ is close to zero.
Constraint: $\mathit{objsfg}\ge 2\epsilon$.
 Target Objective Tolerance $r$ Default $\text{}=0.0$
The optional tolerance to a user-specified target value.
Constraint: $r\ge 0.0$.
 Target Warning $a$ Default $\text{}=\mathrm{OFF}$
Activates or deactivates the error exit associated with the target value being achieved before entry into the main loop of the algorithm, ${\mathbf{ifail}}={\mathbf{2}}$.
OFF
No error will be returned, and the routine will exit normally.
ON
An error will be returned if the target objective is reached prematurely, and the routine will exit with ${\mathbf{ifail}}={\mathbf{2}}$.
 Verify Gradients $a$ Default $\text{}=\mathrm{ON}$
Adjusts the level of gradient checking performed when gradients are required. Gradient checks are only performed on the first call to the chosen local minimizer if it requires gradients. There is no guarantee that the gradient check will be correct, as the finite differences used in the gradient check are themselves subject to inaccuracies.
OFF
No gradient checking will be performed.
ON
A cheap gradient check will be performed on both the gradients corresponding to the objective through objfun.
OBJECTIVE
FULL
A more expensive gradient check will be performed on the gradients corresponding to the objective objfun.
 Weight Decrease $a$ Default $\text{}=\mathrm{INTEREST}$
Determines how particle weights decrease.
OFF
Weights do not decrease.
INTEREST
Weights decrease through compound interest as ${w}_{\mathit{IT}+1}={w}_{\mathit{IT}}\left(1-{W}_{\mathit{val}}\right)$, where ${W}_{\mathit{val}}$ is the Weight Value and $\mathit{IT}$ is the current number of iterations.
LINEAR
Weights decrease linearly following ${w}_{\mathit{IT}+1}={w}_{\mathit{IT}}-\mathit{IT}×\left({W}_{\mathit{max}}-{W}_{\mathit{min}}\right)/{\mathit{IT}}_{\mathit{max}}$, where $\mathit{IT}$ is the iteration number and ${\mathit{IT}}_{\mathit{max}}$ is the maximum number of iterations as set by Maximum Iterations Completed.
 Weight Initial $r$ Default $\text{}={W}_{\mathit{max}}$
The initial value of any particle's inertial weight, ${W}_{\mathit{ini}}$, or the minimum possible initial value if initial weights are randomized. When set, this will override ${\mathbf{Weight Initialize}}=\mathrm{RANDOMIZED}$ or $\mathrm{MAXIMUM}$, and as such these must be set afterwards if so desired.
Constraint: ${W}_{\mathit{min}}\le r\le {W}_{\mathit{max}}$.
 Weight Initialize $a$ Default $\text{}=\mathrm{MAXIMUM}$
Determines how the initial weights are distributed.
INITIAL
All weights are initialized at the initial weight, ${W}_{\mathit{ini}}$, if set. If Weight Initial has not been set, this will be the maximum weight, ${W}_{\mathit{max}}$.
MAXIMUM
All weights are initialized at the maximum weight, ${W}_{\mathit{max}}$.
RANDOMIZED
Weights are uniformly distributed in $\left({W}_{\mathit{min}},{W}_{\mathit{max}}\right)$ or $\left({W}_{\mathit{ini}},{W}_{\mathit{max}}\right)$ if Weight Initial has been set.
 Weight Maximum $r$ Default $\text{}=1.0$
The maximum particle weight, ${W}_{\mathit{max}}$.
Constraint: $1.0\ge r\ge {W}_{\mathit{min}}$ (If ${W}_{\mathit{ini}}$ has been set then $1.0\ge r\ge {W}_{\mathit{ini}}$.)
 Weight Minimum $r$ Default $\text{}=0.1$
The minimum achievable weight of any particle, ${W}_{\mathit{min}}$. Once achieved, no further weight reduction is possible.
Constraint: $0.0\le r\le {W}_{\mathit{max}}$ (If ${W}_{\mathit{ini}}$ has been set then $0.0\le r\le {W}_{\mathit{ini}}$.)
 Weight Reset $a$ Default $\text{}=\mathrm{MAXIMUM}$
Determines how particle weights are re-initialized.
INITIAL
Weights are re-initialized at the initial weight if set. If Weight Initial has not been set, this will be the maximum weight.
MAXIMUM
Weights are re-initialized at the maximum weight.
RANDOMIZED
Weights are uniformly distributed in $\left({W}_{\mathit{min}},{W}_{\mathit{max}}\right)$ or $\left({W}_{\mathit{ini}},{W}_{\mathit{max}}\right)$ if Weight Initial has been set.
 Weight Value $r$ Default $\text{}=0.01$
The constant ${W}_{\mathit{val}}$ used with ${\mathbf{Weight Decrease}}=\mathrm{INTEREST}$.
Constraint: $0.0\le r\le \frac{1}{3}$.

### 12.2Description of the SMP optional parameters

This section details additional options available to users of multithreaded implementations of the NAG Library. In particular it includes the option SMP Callback Thread Safe, which must be set before calling e05saf with multiple threads.
 SMP Callback Thread Safe $a$ Default $\text{}=\mathrm{WARNING}$
Declare that the callback routines you provide are or are not thread safe. In particular, this indicates that access to the shared memory arrays iuser and ruser from within your provided callbacks is done in a thread safe manner. If these arrays are just used to pass constant data, then you may assume they are thread safe. If these are also used for workspace, or passing variable data such as random number generator seeds, then you must ensure these are accessed and updated safely. Whilst this can be done using OpenMP critical sections, we suggest their use is minimized to prevent unnecessary bottlenecks, and that instead individual threads have access to independent subsections of the provided arrays where possible.
YES
The callback routines have been programmed in a thread safe way. The algorithm will use OMP_NUM_THREADS threads.
NO
The callback routines are not thread safe. Setting this option will force the algorithm to run on a single thread only, and is advisable only for debugging purposes, or if you wish to parallelize your callback functions.
WARNING
This will cause an immediate exit from e05saf with ${\mathbf{ifail}}={\mathbf{51}}$ if multiple threads are detected. This is to inform you that you have not declared the callback functions either to be thread safe, or that they are thread unsafe and you wish the algorithm to run in serial.
An additional example program, e05safe_smp.f90, is included with the distribution material of multithreaded implementations of the NAG Library to illustrate how to safely access independent subsections of the provided iuser and ruser arrays from multiple threads.
 SMP Local Minimizer External $a$ Default $\text{}=\mathrm{ALL}$
Determines how many threads will attempt to locally minimize the best found solution after the routine has exited the main loop.
MASTER
Only the master thread will attempt to find any improvement. The local minimization will be launched from the best known solution. All other threads will remain effectively idle.
ALL
The master thread will perform a local minimization from the best known solution, while all other threads will perform a local minimization from randomly generated perturbations of the best known solution, increasing the chance of an improvement. Assuming all local minimizations will take approximately the same amount of computation, this will be effectively free in terms of real time. It will however increase the number of function evaluations performed.
 SMP Monitor $a$ Default $\text{}=\mathrm{SINGLE}$
 SMP Monmod $a$
Determines whether the user-supplied function monmod is invoked once every sub-iteration each thread performs, or only once by a single thread after all threads have completed at least one sub-iteration.
SINGLE
Only one thread will invoke monmod, after all threads have performed at least one sub-iteration.
ALL
Each thread will invoke monmod each time it completes a sub-iteration. If you wish to alter x using monmod you should use this option, as monmod will only receive the arrays x, xbest and fbest private to the calling thread.
 SMP Subswarm $i$ Default $\text{}=1$
Determines how many threads support a particle subswarm. This is an extra collection of particles constrained to search only within a hypercube of edge length $10.0×{\mathbf{Distance Tolerance}}$ of the best point known to an individual thread. This may improve the number of iterations required to find a provided target, particularly if no local minimizer is in use.
If $i\le 0$, then this will be disabled on all the threads.
If $i\ge \mathtt{OMP_NUM_THREADS}$, then all the threads will support a particle subswarm.
 SMP Thread Overrun $i$ Default $\text{}=\mathit{Imax}$
This option provides control over the level of asynchronicity present in a simulation. In particular, a barrier synchronization between all threads is performed if any thread completes $i$ sub-iterations more than the slowest thread, causing all threads to be exposed to the current best solution. Allowing asynchronous behaviour does however allow individual threads to focus on different global optimum candidates some of the time, which can inhibit convergence to unwanted sub-optima. It also allows for threads to continue searching when other threads are completing sub-iterations at a slower rate.
If $i<1$, the algorithm will force a synchronization between threads at the end of each iteration.