naginterfaces.library.opt.handle_​opt_​set

naginterfaces.library.opt.handle_opt_set(handle, optstr)

handle_opt_set is an option setting function for all solvers from the NAG optimization modelling suite. It can set a single option or reset all of them to their default.

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

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

Parameters

handleHandle

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

optstrstr

A string identifying the option and its value to be set.

Defaults

Resets all options to their default values.

$\text{Option}=\text{optval}$

See the documentation of the particular solver for details of valid values for $\text{option}$ and $\text{optval}$. The equals sign ($=$) delimiter must be used to separate the $\text{option}$ from its $\text{optval}$ value.

$\text{Option}=Default$

Resets the given option back to its default value.

$optstr$ is case insensitive.

Each token in the $\text{option}$ and $\text{optval}$ component must be separated by at least one space.

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 $2$)

The options cannot be modified while solver is running.

(errno $11$)

On entry, the $\text{option}$ supplied in $optstr$ was not recognized: $optstr=⟨value⟩$.

(errno $12$)

On entry, the expected delimiter ‘$=$’ was not found in $optstr$: $optstr=⟨value⟩$.

(errno $13$)

On entry, could not convert the specified $\text{optval}$ to an integer: $\text{optval}=⟨value⟩$.

(errno $13$)

On entry, could not convert the specified $\text{optval}$ to a real: $\text{optval}=⟨value⟩$.

(errno $15$)

On entry, the $\text{optval}$ supplied for the integer option is not valid.

$\text{option}=⟨value⟩$, $\text{optval}=⟨value⟩$.

Constraint: $\text{optval}\ge ⟨value⟩$.

(errno $15$)

On entry, the $\text{optval}$ supplied for the integer option is not valid.

$\text{option}=⟨value⟩$, $\text{optval}=⟨value⟩$.

Constraint: $\text{optval}>⟨value⟩$.

(errno $15$)

On entry, the $\text{optval}$ supplied for the integer option is not valid.

$\text{option}=⟨value⟩$, $\text{optval}=⟨value⟩$.

Constraint: $\text{optval}\le ⟨value⟩$.

(errno $15$)

On entry, the $\text{optval}$ supplied for the integer option is not valid.

$\text{option}=⟨value⟩$, $\text{optval}=⟨value⟩$.

Constraint: $\text{optval}<⟨value⟩$.

(errno $16$)

On entry, the $\text{optval}$ supplied for the real option is not valid.

$\text{option}=⟨value⟩$, $\text{optval}=⟨value⟩$.

Constraint: $\text{optval}\ge ⟨value⟩$.

(errno $16$)

On entry, the $\text{optval}$ supplied for the real option is not valid.

$\text{option}=⟨value⟩$, $\text{optval}=⟨value⟩$.

Constraint: $\text{optval}>⟨value⟩$.

(errno $16$)

On entry, the $\text{optval}$ supplied for the real option is not valid.

$\text{option}=⟨value⟩$, $\text{optval}=⟨value⟩$.

Constraint: $\text{optval}\le ⟨value⟩$.

(errno $16$)

On entry, the $\text{optval}$ supplied for the real option is not valid.

$\text{option}=⟨value⟩$, $\text{optval}=⟨value⟩$.

Constraint: $\text{optval}<⟨value⟩$.

(errno $17$)

On entry, the $\text{optval}$ supplied for the character option is not valid.

$\text{option}=⟨value⟩$, $\text{optval}=⟨value⟩$.

Notes

handle_opt_set can only be called on handles which have been correctly initialized (e.g., by handle_init()) and not during the call to the solver. It has two purposes: to reset all options to their default values; or to set a single option to a user-supplied value.

Options and their values are, in general, presented as a character string, $optstr$, of the form ‘$\text{option}=\text{optval}$’; alphabetic characters can be supplied in either upper or lower case. Both $\text{option}$ and $\text{optval}$ may consist of one or more tokens separated by white space. The tokens that comprise $\text{optval}$ will normally be either an integer, real or character value as defined in the description of the specific option. In addition all options can take an $\text{optval}$ DEFAULT which resets the option to its default value.

Information relating to available option names and their corresponding valid values is given in the documentation of the particular solver. See also the E04 Introduction for more details about the NAG optimization modelling suite.

See also

naginterfaces.library.examples.glopt.handle_solve_mcs_ex.main()

naginterfaces.library.examples.mip.handle_solve_milp_ex.main()

naginterfaces.library.examples.opt.handle_add_vars_ex.main()

naginterfaces.library.examples.opt.handle_disable_ex.main()

naginterfaces.library.examples.opt.handle_solve_bounds_foas_ex.main()

naginterfaces.library.examples.opt.handle_solve_dfls_ex.main()

naginterfaces.library.examples.opt.handle_solve_dfno_ex.main()

naginterfaces.library.examples.opt.handle_solve_ipopt_ex.main()

naginterfaces.library.examples.opt.handle_solve_lp_ipm_ex.main()

naginterfaces.library.examples.opt.handle_solve_nldf_ex.main()

(and others)