NAG CPP Interface
nagcpp::opt::nlp1_option_string (e04ue)

Keyword Search:

NAG Library Manual, Mark 30.3

Interfaces: FL CL CPP AD PY MB

NAG CPP Interface Introduction

E04 (Opt) Chapter Contents

e04ue: FL CL CPP AD PY MB

Namespace: nagcpp

Namespace: opt

Function: nlp1_option_string

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Exceptions and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

Settings help

CPP Name Style:
NAG (a00aa)
Short (impl_details)
Long (info::impl_details)
Full (nagcpp::info::impl_details)

1 Purpose

nlp1_option_string may be used to supply individual optional parameters to nlp1_solve(_old)

nlp1_option_string can also be used to supply individual optional parameters to e04uff (no CPP interface).

2 Specification

#include "e04/nagcpp_e04ue.hpp"
#include "e04/nagcpp_class_CommE04WB.hpp"

template <typename COMM>

void function nlp1_option_string(const string optstr, COMM &comm, OptionalE04UE opt)

template <typename COMM>

void function nlp1_option_string(const string optstr, COMM &comm)

3 Description

nlp1_option_string may be used to supply values for optional parameters to nlp1_solve(_old). It is only necessary to call nlp1_option_string for those arguments whose values are to be different from their default values. One call to nlp1_option_string sets one argument value.

Each optional parameter is defined by a single character string, of up to

72

characters, consisting of one or more items. The items associated with a given option must be separated by spaces, or equals signs

[=]

. Alphabetic characters may be upper or lower case. The string

Print Level = 1

is an example of a string used to set an optional parameter. For each option the string contains one or more of the following items:

–a mandatory keyword;
–a phrase that qualifies the keyword;
–a number that specifies an integer or real value. Such numbers may be up to $40$ contiguous characters in Fortran's I, F, E or D formats, terminated by a space if this is not the last item on the line.

Blank strings and comments are ignored. A comment begins with an asterisk (*) and all subsequent characters in the string are regarded as part of the comment.

Printing of user-specified options is turned off by default. It may be turned on at any time using the keyword List.

Optional parameter settings are preserved following a call to nlp1_solve(_old) and so the keyword Defaults is provided to allow you to reset all the optional parameters to their default values before a subsequent call to nlp1_solve(_old).

A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in nlp1_solve(_old).

4 References

None.

5 Arguments

1: $optstr$ – string Input: On entry: a single valid option string (as described in Section 3 and in Section 12 in nlp1_solve(_old)).
2: $comm$ – CommE04WB Input/Output: Communication structure. This argument must have been initialized by a prior call to init (no CPP interface).
3: $opt$ – OptionalE04UE Input/Output: Optional parameter container, derived from Optional.

6 Exceptions and Warnings

All errors and warnings have an associated numeric error code field, errorid, stored either as a member of the thrown exception object (see errorid), or as a member of opt.ifail, depending on how errors and warnings are being handled (see Error Handling for more details).

Raises: ErrorException