naginterfaces.library.opt.handle_​set_​bound

naginterfaces.library.opt.handle_set_bound(handle, comp, idx, bli, bui)

handle_set_bound is a part of the NAG optimization modelling suite and sets or modifies the bounds of a single constraint, either the simple variable bounds, linear constraint or nonlinear constraint of the problem. It can be also used to fix any given variable.

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

https://support.nag.com/numeric/nl/nagdoc_30.2/flhtml/e04/e04tdf.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 whose bounds will be modified. $comp$ is case insensitive.

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

Simple bounds of a decision variable $x_i$ (see handle_set_simplebounds()).

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

Linear constraint (see handle_set_linconstr()).

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

Nonlinear constraint (see handle_set_nlnconstr()).

idxint

$i$, the index of the component $comp$ whose bounds will be changed.

blifloat

$bli$ defines the new lower bound

buifloat

$bui$ defines the new upper bound

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

On entry, $comp=⟨value⟩$.

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

(errno $8$)

On entry, $comp=⟨value⟩$, $idx=⟨value⟩$ and $M=⟨value⟩$.

Constraint: $1\le idx\le M$.

(errno $10$)

On entry, $bli=⟨value⟩$ and $bui=⟨value⟩$.

Constraint: $bli\le bui$.

(errno $10$)

On entry, $bli=⟨value⟩$ and $\text{bigbnd}=⟨value⟩$.

Constraint: $bli<\text{bigbnd}$.

(errno $10$)

On entry, $bui=⟨value⟩$ and $\text{bigbnd}=⟨value⟩$.

Constraint: $bui>-\text{bigbnd}$.

Notes

After the model has been fully or partially built by calling functions of the NAG optimization modelling suite, handle_set_bound may be used to define a new lower bound, $l_i$, and an upper bound $u_i$, of a single constraint identified by the component type $comp$ together with the appropriate component index $i$ given in $idx$. Note that both upper and lower bounds need to be specified. This form allows full generality in specifying various types of constraint. In particular, the model component may be set as an equality by setting $l_i=u_i$ (e.g., to fix a variable). If certain bounds are not present, the associated value $l_i$ or $u_i$ may be set to special values that are treated as $-\infty$ or $+\infty$. See the description of the option ‘Infinite Bound Size’ which is common among all solvers in the suite. Its value is denoted as $\text{bigbnd}$ further in this text. Note that the bounds are interpreted based on its value at the time of calling this function and any later alterations to ‘Infinite Bound Size’ will not affect these constraints.

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

See also

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

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