nag_glopt_bnd_mcs_option_check (e05jhc) (PDF version)
e05 Chapter Contents
e05 Chapter Introduction
NAG C Library Manual

NAG Library Function Document

nag_glopt_bnd_mcs_option_check (e05jhc)

+ Contents

    1  Purpose
    7  Accuracy
    9  Example

1  Purpose

nag_glopt_bnd_mcs_option_check (e05jhc) is used to check if you have set an optional argument of nag_glopt_bnd_mcs_solve (e05jbc). The initialization function nag_glopt_bnd_mcs_init (e05jac) must have been called before calling nag_glopt_bnd_mcs_option_check (e05jhc).

2  Specification

#include <nag.h>
#include <nage05.h>
Integer  nag_glopt_bnd_mcs_option_check (const char *optstr, Nag_E05State *state, NagError *fail)

3  Description

nag_glopt_bnd_mcs_option_check (e05jhc) returns 1 if you have previously set the optional argument contained in optstr, otherwise it returns 0.
A complete list of optional arguments, their symbolic names and default values is given in Section 11 in nag_glopt_bnd_mcs_solve (e05jbc).

4  References

None.

5  Arguments

1:     optstrconst char *Input
On entry: a string identifying an optional argument (as described in Section 11 in nag_glopt_bnd_mcs_solve (e05jbc)).
2:     stateNag_E05State *Communication Structure
state contains information required by other functions in this suite. You must not modify it directly in any way.
3:     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_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.
NE_NOT_INIT
Initialization function nag_glopt_bnd_mcs_init (e05jac) has not been called.
NE_OPT_NOT_READ
The supplied optional argument is invalid. A keyword or keyword combination was not recognized.

7  Accuracy

Not applicable.

8  Further Comments

None.

9  Example

See Section 9 in nag_glopt_bnd_mcs_optset_file (e05jcc).

nag_glopt_bnd_mcs_option_check (e05jhc) (PDF version)
e05 Chapter Contents
e05 Chapter Introduction
NAG C Library Manual

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