NAG Library Function Document

nag_opt_handle_opt_set (e04zmc)

 Contents

    1  Purpose
    7  Accuracy
    10  Example

1
Purpose

nag_opt_handle_opt_set (e04zmc) is an option setting function for all solvers from the NAG optimization modelling suite. It can set a single optional parameter or reset all of them to their default.

2
Specification

#include <nag.h>
#include <nage04.h>
void  nag_opt_handle_opt_set (void *handle, const char *optstr, NagError *fail)

3
Description

nag_opt_handle_opt_set (e04zmc) can only be called on handles which have been initialized by nag_opt_handle_init (e04rac) and not during the call to the solver. It has two purposes: to reset all optional parameters to their default values; or to set a single optional parameter to a user-supplied value.
Optional parameters and their values are, in general, presented as a character string, optstr, of the form ‘option=optval’; alphabetic characters can be supplied in either upper or lower case. Both option and optval may consist of one or more tokens separated by white space. The tokens that comprise optval will normally be either an integer, real or character value as defined in the description of the specific optional argument. In addition all optional parameters can take an optval DEFAULT which resets the optional parameter 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 nag_opt_handle_init (e04rac) for a generic description of the suite.

4
References

None.

5
Arguments

1:     handle void *Input
On entry: the handle to the problem. It needs to be initialized by nag_opt_handle_init (e04rac) and must not be changed.
2:     optstr const char *Input
On entry: a string identifying the option and its value to be set.
Defaults
Resets all options to their default values.
Option=optval
See the documentation of the particular solver for details of valid values for option and optval. The equals sign (=) delimiter must be used to separate the option from its optval value.
Option=Default
Resets the given option back to its default value.
optstr is case insensitive. Each token in the option and optval component must be separated by at least one space.
3:     fail NagError *Input/Output
The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6
Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_HANDLE
The supplied handle does not define a valid handle to the data structure for the NAG optimization modelling suite. It has not been initialized by nag_opt_handle_init (e04rac) or it has been corrupted.
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
NE_INVALID_FORMAT
On entry, could not convert the specified optval to an integer: optval=value.
On entry, could not convert the specified optval to a real: optval=value.
On entry, the expected delimiter ‘=’ was not found in optstr: optstr=value.
NE_INVALID_OPTION
On entry, the option supplied in optstr was not recognized: optstr=value.
NE_INVALID_VALUE
On entry, the optval supplied for the character optional parameter is not valid.
option=value, optval=value.
On entry, the optval supplied for the integer optional parameter is not valid.
option=value, optval=value.
Constraint: optval<value.
On entry, the optval supplied for the integer optional parameter is not valid.
option=value, optval=value.
Constraint: optval>value.
On entry, the optval supplied for the integer optional parameter is not valid.
option=value, optval=value.
Constraint: optvalvalue.
On entry, the optval supplied for the integer optional parameter is not valid.
option=value, optval=value.
Constraint: optvalvalue.
On entry, the optval supplied for the real optional parameter is not valid.
option=value, optval=value.
Constraint: optval<value.
On entry, the optval supplied for the real optional parameter is not valid.
option=value, optval=value.
Constraint: optval>value.
On entry, the optval supplied for the real optional parameter is not valid.
option=value, optval=value.
Constraint: optvalvalue.
On entry, the optval supplied for the real optional parameter is not valid.
option=value, optval=value.
Constraint: optvalvalue.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.
NE_PHASE
The options cannot be modified in this phase.

7
Accuracy

Not applicable.

8
Parallelism and Performance

nag_opt_handle_opt_set (e04zmc) is not threaded in any implementation.

9
Further Comments

None.

10
Example

See the example programs associated with the solvers nag_opt_handle_solve_dfls (e04ffc), nag_opt_handle_solve_lp_ipm (e04mtc), nag_opt_handle_solve_ipopt (e04stc) and nag_opt_handle_solve_pennon (e04svc) for a demonstration of how to use nag_opt_handle_opt_set (e04zmc). See also Section 10 in nag_opt_handle_init (e04rac) for links to all the examples in this suite.
© The Numerical Algorithms Group Ltd, Oxford, UK. 2017