e04vs: FL CL CPP AD PY MB

NAG CL Interface
e04vsc (nlp2_sparse_option_double_get)

Note: this function is deprecated. Replaced by e04src.

Keyword Search:

Interfaces: FL CL CPP AD PY MB

e04vs: FL CL CPP AD PY MB

▸▿ Contents

CL Name Style:
Short (a00aac)
Long (impl_details)
Full (nag_info_impl_details)

e04vsc is used to get the value of a double optional parameter. e04vsc can be used before or after calling e04vhc.

#include <nag.h>

void	e04vsc (const char string, double rvalue, Nag_E04State state, NagError fail)

The function may be called by the names: e04vsc, nag_opt_nlp2_sparse_option_double_get or nag_opt_sparse_nlp_option_get_double.

e04vsc obtains the current value of a double option. For example

e04vsc ("Feasibility Tolerance", &featol, &state, &fail);

will result in the value of the optional parameter

Feasibility Tolerance

being output in featol.

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

None.

1: $string$ – const char * Input: On entry: a single valid keyword of a double optional parameter (as described in Section 12 in e04vhc).
2: $rvalue$ – double * Output: On exit: the double value associated with the keyword in string.
3: $state$ – Nag_E04State * Communication Structure: state contains internal information required for functions in this suite. It must not be modified in any way.
4: $fail$ – NagError * Input/Output: The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

NE_ALLOC_FAIL: Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
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_E04VGC_NOT_INIT: The initialization function e04vgc 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.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.