Integer, Intent (Inout)	::	iw(*), ifail
Integer, Intent (Out)	::	ivalue
Real (Kind=nag_wp), Intent (Inout)	::	rw(*)
Character (*), Intent (In)	::	string
Character (8), Intent (InOut)	::	cw(*)

C Header Interface

#include <nag.h>

void	e04nxf_ (const char st, Integer ivalue, char cw[], Integer iw[], double rw[], Integer *ifail, const Charlen length_st, const Charlen length_cw)

The routine may be called by the names e04nxf or nagf_opt_qpconvex2_sparse_option_integer_get.

3 Description

e04nxf obtains the current value of an integer option. For example:

Call e04nxf ('Iterations', itnlim, cw, iw, rw, ifail)

will result in the value of the optional parameter Iterations Limit being output in ITNLIM.

A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in e04nqf.

4 References

None.

5 Arguments

1: $string$ – Character(*) Input: On entry: a single valid keyword of an integer optional parameter (as described in Section 12 in e04nqf).
2: $ivalue$ – Integer Output: On exit: the integer value associated with the keyword in string.
3: $cw (*)$ – Character(8) array Communication Array: Note: the actual argument supplied must be the array cw supplied to the initialization routine e04npf.
4: $iw (*)$ – Integer array Communication Array: Note: the actual argument supplied must be the array iw supplied to the initialization routine e04npf.
5: $rw (*)$ – Real (Kind=nag_wp) array Communication Array: Note: the actual argument supplied must be the array rw supplied to the initialization routine e04npf.
6: $ifail$ – Integer Input/Output: On entry: ifail must be set to $0$ , $−1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $−1$ means that an error message is printed while a value of $1$ means that it is not.

If halting is not appropriate, the value $−1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $- 1$ or $1$ is used it is essential to test the value of ifail on exit.

On exit: $ifail = 0$ unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

ifail = 0

−1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: The initialization routine e04npf has not been called.

$ifail = 2$: The supplied option string is invalid. Check that the keywords are neither ambiguous nor misspelt. The option string is ‘ $⟨ value ⟩$ ’.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.