naginterfaces.library.glopt.bnd_​mcs_​optset_​char

naginterfaces.library.glopt.bnd_mcs_optset_char(optstr, cvalue, comm, io_manager=None)

bnd_mcs_optset_char may be used to supply individual ‘ON’/’OFF’-valued character options to bnd_mcs_solve(). The initialization function bnd_mcs_init() must have been called before calling bnd_mcs_optset_char.

Deprecated since version 28.3.0.0: bnd_mcs_optset_char is deprecated. There is no suggested replacement for this routine.

For full information please refer to the NAG Library document for e05je

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/e05/e05jef.html

Parameters

optstrstr

A string defining a single ‘ON’/’OFF’-valued character option (as described in Other Parameters for bnd_mcs_solve).

cvaluestr

The ‘ON’/’OFF’ value associated with the keyword in $optstr$.

commdict, communication object, modified in place

Communication structure.

This argument must have been initialized by a prior call to bnd_mcs_init().

io_managerFileObjManager, optional

Manager for I/O in this routine.

Raises

NagValueError

(errno $1$)

Initialization function bnd_mcs_init() has not been called.

(errno $2$)

The supplied option is invalid. A keyword or keyword combination was not recognized.

(errno $3$)

Attempt to assign an illegal value of ‘Local Searches’ ($\text{lcsrch}$): $\text{lcsrch}=⟨value⟩$.

(errno $3$)

Attempt to assign an illegal value of ‘Repeatability’ ($\text{repeat}$): $\text{repeat}=⟨value⟩$.

Notes

bnd_mcs_optset_char may be used to supply values for ‘ON’/’OFF’-valued character options to bnd_mcs_solve(). It is only necessary to call bnd_mcs_optset_char for those arguments whose values are to be different from their default values. One call to bnd_mcs_optset_char sets one argument value.

Each ‘ON’/’OFF’-valued character option is defined by a single character string in $optstr$ and the corresponding value in $cvalue$.

A complete list of options, their symbolic names and default values is given in Other Parameters for bnd_mcs_solve.