naginterfaces.library.opt.handle_​set_​get_​integer

naginterfaces.library.opt.handle_set_get_integer(handle, cmdstr, iarr=None)

handle_set_get_integer is a part of the NAG optimization modelling suite. It allows an Integer piece of information to be read from or written to the problem stored in the handle. For example, it may be used to extract the current problem sizes and statistics.

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

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

Parameters

handleHandle

The handle to the problem. It needs to be initialized by handle_init() and must not be changed between calls to the NAG optimization modelling suite.

cmdstrstr

A string which identifies the item within the handle to be read or written. The string is case insensitive and space tolerant.

iarrNone or int, array-like, shape $\left(\text{liarr}\right)$, optional

If $iarr$ is not None (write mode), $iarr$ must contain the information to be written to the handle.

Returns

liarrint

In write mode and when the size of the input $iarr$ does not match the item identified by $cmdstr$, $liarr$ is the correct expected size. Otherwise, it is merely the actual size of the relevant $iarr$.

iarrNone or int, ndarray, shape $\left(\text{liarr}\right)$

If $iarr$ was None on entry (read mode), $iarr$ contains the information requested by $cmdstr$.

Raises

NagValueError

(errno $1$)

$handle$ has not been initialized.

(errno $1$)

$handle$ does not belong to the NAG optimization modelling suite, has not been initialized properly or is corrupted.

(errno $1$)

$handle$ has not been initialized properly or is corrupted.

(errno $3$)

The provided $cmdstr$ is not recognised.

(errno $4$)

Reading mode is not supported for the given $cmdstr$.

(errno $5$)

Writing mode is not supported for the given $cmdstr$.

(errno $6$)

The requested information is not available.

(errno $6$)

The request cannot be processed at this phase.

Notes

handle_set_get_integer adds an additional means of communication to functions within the NAG optimization modelling suite. It allows you to either read or write a piece of information in the handle in the form of an integer array. The item is identified by $cmdstr$ and the direction of the communication is set by the presence or absence of $iarr$. The functionality is limited in this release of the NAG Library to the retrieval of the problem size and statistics.

General information on available $cmdstr$ is as follows.

$cmdstr$	Description	Direction of communication	$\text{liarr}$
BASIS	The current state of the variables and slacks of the problem. It can also be referred as WARM START BASIS.	Read and write	$\ast$
PINFO	The current problem sizes and statistics as $\text{pinfo}$ defined in handle_read_file()	Read	$100$
MCS Number Points	Used to provide a custom initialization list for the solver glopt.handle_solve_mcs.	Write	$\text{nvar}$
MCS Initial Points	Used to provide a custom initialization list for the solver glopt.handle_solve_mcs.	Write	$\text{nvar}$

See the E04 Introduction for more details about the NAG optimization modelling suite.