naginterfaces.library.opt.handle_​enable

naginterfaces.library.opt.handle_enable(handle, comp, idx)

handle_enable is a part of the NAG optimization modelling suite and allows you to enable various components of the existing model which were previously disabled by handle_disable().

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

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/e04/e04tbf.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.

compstr

The type of the component of the model to be enabled. $comp$ is case insensitive.

$comp=\text{'X'}$, $\text{'VAR'}$ or $\text{'VARIABLE'}$

Decision variables $x$.

$comp=\text{'LC'}$ or $\text{'LINEAR CONSTRAINT'}$

Linear constraints (see handle_set_linconstr()).

$comp=\text{'QC'}$ or $\text{'QUADRATIC CONSTRAINT'}$

Quadratic constraints (see handle_set_qconstr() and handle_set_qconstr_fac()).

$comp=\text{'NLC'}$ or $\text{'NONLINEAR CONSTRAINT'}$

Nonlinear constraints (see handle_set_nlnconstr()).

$comp=\text{'CN'}$ or $\text{'CONE'}$

Quadratic or rotated quadratic cones (see handle_set_group()).

$comp=\text{'MI'}$ or $\text{'MATRIX INEQUALITY'}$

Matrix inequality constraints (see handle_set_linmatineq()).

$comp=\text{'NLS'}$ or $\text{'RESIDUAL'}$

Nonlinear residuals $r_j\left(x\right)$ in the nonlinear least squares objective function (see handle_set_nlnls()).

idxint, array-like, shape $\left(\text{lidx}\right)$

The index set of components $comp$ to be enabled. The elements may be supplied in any order.

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 problem cannot be modified right now, the solver is running.

(errno $5$)

On entry, $\text{lidx}=⟨value⟩$.

Constraint: $\text{lidx}\ge 1$.

(errno $6$)

On entry, $comp=⟨value⟩$.

Constraint: $comp=\text{'X'}$, $\text{'LC'}$, $\text{'QC'}$, $\text{'NLC'}$, $\text{'CN'}$, $\text{'MI'}$ or $\text{'NLS'}$.

(errno $8$)

On entry, $comp=⟨value⟩$, $i=⟨value⟩$, $idx[i-1]=⟨value⟩$ and $M=⟨value⟩$.

Constraint: $1\le idx[i-1]\le M$.

(errno $9$)

On entry, $comp=⟨value⟩$ and $idx[i-1]=⟨value⟩$.

This component has been deleted.

Notes

handle_disable() and handle_enable form a pair of functions which allow you to temporarily disable and then re-enable parts of a model. This is particularly useful when a sequence of similar problems needs to be solved, to identify how a particular constraint or variable affects the solution, or to switch between previously defined constraints which are somewhat related to each other.

handle_enable may be used to re-enable a component of the model previously disabled by a call to handle_disable(). The components to be re-enabled are identified by supplying the same value of $comp$ and $idx$ as used in the call to handle_disable() when they were disabled. All newly created components of the model are enabled. Calling this function on enabled components is not an error but has no effect.

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

See also

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