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

naginterfaces.library.glopt.bnd_mcs_optset_string(optstr, comm, io_manager=None)[source]

bnd_mcs_optset_string may be used to supply individual options to bnd_mcs_solve(). The initialization function bnd_mcs_init() must have been called before calling bnd_mcs_optset_string.

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

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

Parameters
optstrstr

A string defining a single option (as described in Notes and in Other Parameters for bnd_mcs_solve). The implied data type (character, integer or real) of each value to set must match that expected by the option.

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 )

Initialization function bnd_mcs_init() has not been called.

(errno )

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

(errno )

Attempt to assign a non-positive value of ‘Function Evaluations Limit’ (): .

(errno )

Attempt to assign an out-of-bounds value of ‘Infinite Bound Size’ (): .

(errno )

Attempt to assign a non-positive value of ‘Static Limit’ (): .

(errno )

Attempt to assign too small a value of ‘Target Objective Error’ (): .

(errno )

Attempt to assign too small a value of ‘Target Objective Safeguard’ (): .

(errno )

Attempt to assign a non-positive value of ‘Local Searches Limit’ (): .

(errno )

Attempt to assign too small a value of ‘Local Searches Tolerance’ (): .

(errno )

Attempt to assign an illegal value of ‘Local Searches’ (): .

(errno )

Attempt to assign an illegal value of ‘Repeatability’ (): .

(errno )

The value to be set could not be parsed. Check that it specifies a valid integer or real value.

Notes

bnd_mcs_optset_string may be used to supply values for options to bnd_mcs_solve(). It is only necessary to call bnd_mcs_optset_string for those arguments whose values are to be different from their default values. One call to bnd_mcs_optset_string sets one argument value.

Each option is defined by a single character string, of up to characters, consisting of one or more items. The items associated with a given option must be separated by spaces, or equals signs . Alphabetic characters may be upper or lower case. The string

Static Limit = 100

is an example of a string used to set an option. For each option the string contains one or more of the following items:

  • a mandatory keyword;

  • a phrase that qualifies the keyword;

  • a number that specifies an integer or real value. Such numbers may be up to contiguous characters.

Printing of user-specified options is turned off by default. It may be turned on at any time using the keyword ‘List’.

Option settings are preserved following a call to bnd_mcs_solve() and so the keyword ‘Defaults’ is provided to allow you to reset all the options to their default values before a subsequent call to bnd_mcs_solve().

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