NAG Library ManualKeyword Search:

NAG Library Function Document

nag_glopt_bnd_mcs_optget_real (e05jlc)

▸▿ Contents

1 Purpose

nag_glopt_bnd_mcs_optget_real (e05jlc) is used to get the value of a real nag_glopt_bnd_mcs_solve (e05jbc) optional parameter. nag_glopt_bnd_mcs_optget_real (e05jlc) can be used before or after calling nag_glopt_bnd_mcs_solve (e05jbc), but the initialization function nag_glopt_bnd_mcs_init (e05jac) must have been called before calling nag_glopt_bnd_mcs_optget_real (e05jlc).

#include <nag.h>

#include <nage05.h>

void	nag_glopt_bnd_mcs_optget_real (const char optstr, double rvalue, Nag_E05State state, NagError fail)

nag_glopt_bnd_mcs_optget_real (e05jlc) obtains the current value of a real-valued optional parameter. For example

e05jlc ('Local Searches Tolerance', &loctol, &state, &fail);

will result in the value of the optional parameter

Local Searches Tolerance

being output in loctol.

A complete list of optional parameters, their symbolic names and default values is given in Section 12 in nag_glopt_bnd_mcs_solve (e05jbc).

None.

1: $optstr$ – const char *Input: On entry: a string identifying a real-valued optional parameter (as described in Section 12 in nag_glopt_bnd_mcs_solve (e05jbc)).
2: $rvalue$ – double *Output: On exit: if $fail . code =$ NE_NOERROR on exit, rvalue contains the real value associated with the optional parameter in optstr.
3: $state$ – Nag_E05State *Communication Structure: state contains information required by other functions in this suite. You must not modify it directly in any way.
4: $fail$ – NagError *Input/Output: The NAG error argument (see Section 2.7 in How to Use the NAG Library and its Documentation).

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_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.

An unexpected error has been triggered by this function. Please contact NAG.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
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_NOT_INIT: Initialization function nag_glopt_bnd_mcs_init (e05jac) has not been called.
NE_OPT_NOT_READ: The supplied optional parameter is invalid. A keyword or keyword combination was not recognized.