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

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

bnd_mcs_optget_char is used to get the value of an ‘ON’/’OFF’-valued character bnd_mcs_solve() option. bnd_mcs_optget_char 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_char.

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

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

Parameters
optstrstr

A string defining a single ‘ON’/’OFF’-valued character 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
cvaluestr

If no exception or warning is raised on exit, contains the ‘ON’/’OFF’ value associated with the keyword 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

No equivalent traditional C interface for this routine exists in the NAG Library.

bnd_mcs_optget_char obtains the current value of an ‘ON’/’OFF’-valued character option.

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