naginterfaces.library.glopt.bnd_​mcs_​option_​check¶

naginterfaces.library.glopt.bnd_mcs_option_check(optstr, comm)[source]

bnd_mcs_option_check is used to check if you have set an option of bnd_mcs_solve(). The initialization function bnd_mcs_init() must have been called before calling bnd_mcs_option_check.

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

https://www.nag.com/numeric/nl/nagdoc_27.1/flhtml/e05/e05jhf.html

Parameters
optstrstr

A string identifying an option (as described in Other Parameters for bnd_mcs_solve).

commdict, communication object

Communication structure.

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

Returns
ichkoptbool

if and only if you have set the option of bnd_mcs_solve().

Raises
NagValueError
(errno )

Initialization function bnd_mcs_init() has not been called.

(errno )

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

Notes

bnd_mcs_option_check returns if you have previously set the option contained in , otherwise it returns .

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