naginterfaces.library.opt.nlp2_​option_​integer_​get

naginterfaces.library.opt.nlp2_option_integer_get(string, comm, io_manager=None)

nlp2_option_integer_get is used to get the value of an int option. nlp2_option_integer_get can be used before or after calling nlp2_solve().

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

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/e04/e04wkf.html

Parameters

stringstr

A single valid keyword of an int option (as described in Other Parameters for nlp2_solve).

commdict, communication object, modified in place

Communication structure.

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

io_managerFileObjManager, optional

Manager for I/O in this routine.

Returns

ivalueint

The int value associated with the keyword in $string$.

Raises

NagValueError

(errno $1$)

The initialization function nlp2_init() has not been called.

(errno $2$)

The supplied option string is invalid. Check that the keywords are neither ambiguous nor misspelt. The option string is $⟨value⟩$.

Notes

nlp2_option_integer_get obtains the current value of an int option.

A complete list of options, their abbreviations, synonyms and default values is given in Other Parameters for nlp2_solve.