naginterfaces.library.glopt.bnd_​mcs_​optget_​int

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

bnd_mcs_optget_int is used to get the value of an integer bnd_mcs_solve() option. bnd_mcs_optget_int can be used before or after calling bnd_mcs_solve(), but the initialization function bnd_mcs_init() must have been called before calling bnd_mcs_optget_int.

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

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

Parameters
optstrstr

A string identifying an integer-valued 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
ivalueint

If no exception or warning is raised on exit, contains the integer value associated with the option in .

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_optget_int obtains the current value of an integer-valued option.

The default values of the options ‘Function Evaluations Limit’, ‘Splits Limit’, ‘Static Limit’ depend on the problem parameter (the number of non-fixed variables). A default value for each of these options will be set in the first call to the solver bnd_mcs_solve(): before that time, getting the value of any of these options using bnd_mcs_optget_int will not return a meaningful result.

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