NAG CL Interface
e05sac (bnd_​pso)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

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\times \mathbf{ndim}$.

Constraint: $\mathbf{npar}\ge 5$.

3: $\mathbf{xb}\left[\mathbf{ndim}\right]$ – double Output

On exit: the location of the best solution found, $\tilde{\mathbf{x}}$, in $R^{\mathit{ndim}}$.

4: $\mathbf{fb}$ – double * Output

On exit: the objective value of the best solution, $\tilde{f}=F\left(\tilde{\mathbf{x}}\right)$.

5: $\mathbf{bl}\left[\mathbf{ndim}\right]$ – const double Input

6: $\mathbf{bu}\left[\mathbf{ndim}\right]$ – const double 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 $\mathbf{Boundary}$ in Section 12).

If $\mathbf{bl}\left[i-1\right]=\mathbf{bu}\left[i-1\right]$ for any $i\in \{1,\dots ,\mathbf{ndim}\}$, variable $i$ will remain locked to $\mathbf{bl}\left[i-1\right]$ regardless of the $\mathbf{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}-1\right]\le \mathbf{bu}\left[\mathit{i}-1\right]$, for $\mathit{i}=1,2,\dots ,\mathbf{ndim}$;
• $\mathbf{bl}\left[i-1\right]\ne \mathbf{bu}\left[i-1\right]$ for at least one $i\in \{1,\dots ,\mathbf{ndim}\}$.

7: $\mathbf{objfun}$ – function, supplied by the user External Function

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 $\mathbf{Local\; Minimizer}$ for more information.

The specification of objfun is:

copy

void  objfun (Integer *mode, Integer ndim, const double x[], double *objf, double vecout[], Integer nstate, Nag_Comm *comm)

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{e04ucc}$ 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{e04ucc}$ 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{e04dgc}$ only
All first derivatives must be evaluated and returned in vecout.

$\mathbf{mode}=7$

$\mathbf{Local\; Minimizer}=\mathrm{e04dgc}$ 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, e05sac will exit as soon as possible with $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_USER_STOP and $\mathbf{inform}=\mathbf{mode}$.

2: $\mathbf{ndim}$ – Integer Input

On entry: the number of dimensions.

3: $\mathbf{x}\left[\mathbf{ndim}\right]$ – const double Input

On entry: $\mathbf{x}$, the point at which the objective function and/or its gradient are to be evaluated.

4: $\mathbf{objf}$ – double * 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]$ – double Input/Output

On entry: if $\mathbf{Local\; Minimizer}=\mathrm{e04ucc}$, the values of vecout are used internally to indicate whether a finite difference approximation is required. See e04ucc.

On exit: the required values of vecout returned to the calling function 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 e04dgc).

6: $\mathbf{nstate}$ – Integer Input

On entry: nstate indicates various stages of initialization throughout the function. 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}=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 function. 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{comm}$ – Nag_Comm *

Pointer to structure of type Nag_Comm; the following members are relevant to objfun.

user – double *

iuser – Integer *

p – Pointer 

The type Pointer will be void *. Before calling e05sac you may allocate memory and initialize these pointers with various quantities for use by objfun when called from e05sac (see Section 3.1.1 in the Introduction to the NAG Library CL Interface).

Note: objfun should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by e05sac. If your code inadvertently does return any NaNs or infinities, e05sac is likely to produce unexpected results.

8: $\mathbf{monmod}$ – function, supplied by the user External Function

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

The specification of monmod is:

copy

void  monmod (Integer ndim, Integer npar, double x[], const double xb[], double fb, const double xbest[], const double fbest[], const Integer itt[], Nag_Comm *comm, 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}\times \mathbf{npar}\right]$ – double Input/Output

Note: the $i$th component of the $j$th particle, $x_j\left(i\right)$, is stored in $\mathbf{x}\left[\left(j-1\right)\times \mathbf{ndim}+i-1\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]$ – const double Input

On entry: the location, $\tilde{\mathbf{x}}$, of the best solution yet found.

5: $\mathbf{fb}$ – double Input

On entry: the objective value, $\tilde{f}=F\left(\tilde{\mathbf{x}}\right)$, of the best solution yet found.

6: $\mathbf{xbest}\left[\mathbf{ndim}\times \mathbf{npar}\right]$ – const double Input

Note: the $i$th component of the position of the $j$th particle's cognitive memory, ${\hat{x}}_j\left(i\right)$, is stored in $\mathbf{xbest}\left[\left(j-1\right)\times \mathbf{ndim}+i-1\right]$.

On entry: the locations currently in the cognitive memory, ${\hat{\mathbf{x}}}_{\mathit{j}}$, for $\mathit{j}=1,2,\dots ,\mathbf{npar}$ (see Section 11).

7: $\mathbf{fbest}\left[\mathbf{npar}\right]$ – const double Input

On entry: the objective values currently in the cognitive memory, $F\left({\hat{\mathbf{x}}}_{\mathit{j}}\right)$, for $\mathit{j}=1,2,\dots ,\mathbf{npar}$.

8: $\mathbf{itt}\left[6\right]$ – const Integer Input

On entry: iteration and function evaluation counters (see description of itt below).

9: $\mathbf{comm}$ – Nag_Comm *

Pointer to structure of type Nag_Comm; the following members are relevant to monmod.

user – double *

iuser – Integer *

p – Pointer 

The type Pointer will be void *. Before calling e05sac you may allocate memory and initialize these pointers with various quantities for use by monmod when called from e05sac (see Section 3.1.1 in the Introduction to the NAG Library CL Interface).

10: $\mathbf{inform}$ – Integer * Input/Output

On entry: $\mathbf{inform}=0$

On exit: setting $\mathbf{inform}<0$ will cause near immediate exit from e05sac. This value will be returned as inform with $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_USER_STOP. You need not set inform unless you wish to force an exit.

Note: monmod should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by e05sac. If your code inadvertently does return any NaNs or infinities, e05sac is likely to produce unexpected results.

9: $\mathbf{iopts}\left[\mathit{dim}\right]$ – Integer Communication Array

Note: the dimension, $\mathit{dim}$, 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 e05zkc.

On entry: optional parameter array as generated and possibly modified by calls to e05zkc. The contents of iopts MUST NOT be modified directly between calls to e05sac, e05zkc or e05zlc.

10: $\mathbf{opts}\left[\mathit{dim}\right]$ – double Communication Array

Note: the dimension, $\mathit{dim}$, 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 e05zkc.

On entry: optional parameter array as generated and possibly modified by calls to e05zkc. The contents of opts MUST NOT be modified directly between calls to e05sac, e05zkc or e05zlc.

11: $\mathbf{comm}$ – Nag_Comm *

The NAG communication argument (see Section 3.1.1 in the Introduction to the NAG Library CL Interface).

12: $\mathbf{itt}\left[6\right]$ – Integer Output

On exit: integer iteration counters for e05sac.

$\mathbf{itt}\left[0\right]$

Number of complete iterations.

$\mathbf{itt}\left[1\right]$

Number of complete iterations without improvement to the current optimum.

$\mathbf{itt}\left[2\right]$

Number of particles converged to the current optimum.

$\mathbf{itt}\left[3\right]$

Number of improvements to the optimum.

$\mathbf{itt}\left[4\right]$

Number of function evaluations performed.

$\mathbf{itt}\left[5\right]$

Number of particles reset.

13: $\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 function.
0	e05sac has detected an error and terminated.
1	The provided objective target has been achieved. ($\mathbf{Target\; Objective\; Value}$).
2	The standard deviation of the location of all the particles is below the set threshold ($\mathbf{Swarm\; Standard\; Deviation}$). If the solution returned is not satisfactory, you may try setting a smaller value of $\mathbf{Swarm\; Standard\; Deviation}$, or try adjusting the options governing the repulsive phase ($\mathbf{Repulsion\; Initialize}$, $\mathbf{Repulsion\; Finalize}$).
3	The total number of particles converged ($\mathbf{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 $\mathbf{Distance\; Tolerance}$ from the optimum with regard to the $L^2$ norm. If the solution is not satisfactory, you may consider lowering the $\mathbf{Distance\; Tolerance}$. However, this may hinder the global search capability of the algorithm.
4	The maximum number of iterations without improvement ($\mathbf{Maximum\; Iterations\; Static}$) has been reached, and the required number of particles ($\mathbf{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 ($\mathbf{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 $\mathbf{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 ($\mathbf{Repulsion\; Initialize}$, $\mathbf{Repulsion\; Finalize}$).
6	The maximum allowed number of function evaluations ($\mathbf{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.

14: $\mathbf{fail}$ – NagError * Input/Output

The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

e05sac will return $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_NOERROR if and only if a finalization criterion has been reached which can guarantee success. This may only happen if the option $\mathbf{Target\; Objective\; Value}$ has been set and reached at a point within the search domain. The finalization criterion $\mathbf{Target\; Objective\; Value}$ is not activated using default option settings, and must be explicitly set using e05zkc if required.

e05sac will return $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NW_SOLUTION_NOT_GUARANTEED if no error has been detected, and a finalization criterion has been achieved which cannot guarantee success. This does not indicate that the function 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.

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 $⟨\mathit{\text{value}}⟩$ had an illegal value.

NE_BOUND

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

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

NE_DERIV_ERRORS

Derivative checks indicate possible errors in the supplied derivatives. Gradient checks may be disabled by setting $\mathbf{Verify\; Gradients}=\mathrm{OFF}$.

NE_INT

On entry, $\mathbf{ndim}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{ndim}\ge 1$.

On entry, $\mathbf{npar}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{npar}\ge 5\times \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 function.

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_INVALID_OPTION

Either the option arrays have not been initialized for e05sac, or they have become corrupted.

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_USER_STOP

User requested exit $⟨\mathit{\text{value}}⟩$ during call to monmod.

User requested exit $⟨\mathit{\text{value}}⟩$ during call to objfun.

NW_FAST_SOLUTION

If the option $\mathbf{Target\; Warning}$ has been activated, this indicates that the $\mathbf{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 function. 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 $\mathbf{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 function is called, it may imply that the objective is largely unimodal, and that it may be more efficient to use the function selected as the $\mathbf{Local\; Minimizer}$ directly.

Assuming that objfun is correct, you may wish to set a better $\mathbf{Target\; Objective\; Value}$, or a stricter $\mathbf{Target\; Objective\; Tolerance}$.

NW_SOLUTION_NOT_GUARANTEED

A finalization criterion was reached that cannot guarantee success.
On exit, $\mathbf{inform}=⟨\mathit{\text{value}}⟩$.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

11 Algorithmic Details

12 Optional Parameters

• Advance Cognitive
• Advance Global
• Boundary
• Distance Scaling
• Distance Tolerance
• Function Precision
• Local Boundary Restriction
• Local Exterior Iterations
• Local Exterior Major Iterations
• Local Exterior Minor Iterations
• Local Exterior Tolerance
• Local Interior Iterations
• Local Interior Major Iterations
• Local Interior Minor Iterations
• Local Interior Tolerance
• Local Minimizer
• Maximum Function Evaluations
• Maximum Iterations Completed
• Maximum Iterations Static
• Maximum Iterations Static Particles
• Maximum Particles Converged
• Maximum Particles Reset
• Maximum Variable Velocity
• Optimize
• Repeatability
• Repulsion Finalize
• Repulsion Initialize
• Repulsion Particles
• Seed
• Swarm Standard Deviation
• Target Objective
• Target Objective Safeguard
• Target Objective Tolerance
• Target Objective Value
• Target Warning
• Verify Gradients
• Weight Decrease
• Weight Initial
• Weight Initialize
• Weight Maximum
• Weight Minimum
• Weight Reset
• Weight Value

12.1 Description of the Optional Parameters

• 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 X02AJC), and $\mathit{Imax}$ represents the largest representable integer value (see X02BBC).

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. ${\hat{\mathbf{x}}}_j$ and ${\hat{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$.

ON

When a distance is calculated between $\mathbf{x}$ and $\mathbf{y}$, a scaled $L^2$ norm is used.

$$L^2(\mathbf{x},\mathbf{y})={\left(\sum _{\left\{i\right|{\mathbf{u}}_i\ne {\mathbf{\ell }}_i,i\le \mathit{ndim}\}}{\left(\frac{x_i-y_i}{{\mathbf{u}}_i-{\mathbf{\ell }}_i}\right)}^2\right)}^{\frac{1}{2}}\text{.}$$

OFF

Distances are calculated as the standard $L^2$ norm without any rescaling.

$$L^2(\mathbf{x},\mathbf{y})={\left(\sum _{i=1}^{\mathit{ndim}}{(x_i-y_i)}^2\right)}^{\frac{1}{2}}\text{.}$$

$\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{e04cbc}$

Use e04cbc 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{e04dgc}$

Use e04dgc 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{e04ucc}$

Use e04ucc 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 function from e05sac will have been acted upon by $\mathbf{Local\; Boundary\; Restriction}$. As such, the domain exposed may be greatly smaller than that provided to e05sac.

MINIMIZE

The objective function will be minimized.

MAXIMIZE

The objective function will be maximized. This is accomplished by minimizing the negative of the objective.

$r$

Once a point is found with an objective value within the $\mathbf{Target\; Objective\; Tolerance}$ of $r$, e05sac will exit successfully with $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_NOERROR 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.

OFF

No error will be returned, and the function will exit normally.

ON

An error will be returned if the target objective is reached prematurely, and the function will exit with $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NW_FAST_SOLUTION.

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.

OFF

Weights do not decrease.

INTEREST

Weights decrease through compound interest as $w_{\mathit{IT}+1}=w_{\mathit{IT}}(1-W_{\mathit{val}})$, where $W_{\mathit{val}}$ is the $\mathbf{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}\times (W_{\mathit{max}}-W_{\mathit{min}})/{\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 $\mathbf{Maximum\; Iterations\; Completed}$.

INITIAL

Weights are re-initialized at the initial weight if set. If $\mathbf{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 $(W_{\mathit{min}},W_{\mathit{max}})$ or $(W_{\mathit{ini}},W_{\mathit{max}})$ if $\mathbf{Weight\; Initial}$ has been set.