nag_opt_sparse_convex_qp_option_get_integer (e04nxc) (PDF version)
e04 Chapter Contents
e04 Chapter Introduction
NAG C Library Manual

NAG Library Function Document

nag_opt_sparse_convex_qp_option_get_integer (e04nxc)

+ Contents

    1  Purpose
    7  Accuracy
    9  Example

1  Purpose

nag_opt_sparse_convex_qp_option_get_integer (e04nxc) is used to get the value of an Integer optional argument. nag_opt_sparse_convex_qp_option_get_integer (e04nxc) can be used before or after calling nag_opt_sparse_convex_qp_solve (e04nqc).

2  Specification

#include <nag.h>
#include <nage04.h>
void  nag_opt_sparse_convex_qp_option_get_integer (const char *string, Integer *ivalue, Nag_E04State *state, NagError *fail)

3  Description

nag_opt_sparse_convex_qp_option_get_integer (e04nxc) obtains the current value of an integer option. For example:
e04nxc ("Iterations", &itnlim, &state, &fail);
will result in the value of the optional argument Iterations Limit being output in itnlim.
A complete list of optional arguments, their abbreviations, synonyms and default values is given in Section 11 in nag_opt_sparse_convex_qp_solve (e04nqc).

4  References

None.

5  Arguments

1:     stringconst char *Input
On entry: a single valid keyword of an Integer optional argument (as described in Section 11 in nag_opt_sparse_convex_qp_solve (e04nqc)).
2:     ivalueInteger *Output
On exit: the Integer value associated with the keyword in string.
3:     stateNag_E04State *Communication Structure
state contains internal information required for functions in this suite. It must not be modified in any way.
4:     failNagError *Input/Output
The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_E04_OPTION_INVALID
The supplied option string is invalid. Check that the keywords are neither ambiguous nor misspelt. The option string is ‘value’.
NE_E04NPC_NOT_INIT
Initialization function nag_opt_sparse_convex_qp_init (e04npc) has not been called.
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.

7  Accuracy

Not applicable.

8  Further Comments

None.

9  Example

See Section 9 in nag_opt_sparse_convex_qp_option_set_file (e04nrc).

nag_opt_sparse_convex_qp_option_get_integer (e04nxc) (PDF version)
e04 Chapter Contents
e04 Chapter Introduction
NAG C Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2012