NAG Library Function Document

nag_opt_sparse_nlp_option_set_file (e04vkc)


    1  Purpose
    7  Accuracy


nag_opt_sparse_nlp_option_set_file (e04vkc) may be used to supply optional parameters to nag_opt_sparse_nlp_solve (e04vhc) from an external file. The initialization function nag_opt_sparse_nlp_init (e04vgc) must have been called before calling nag_opt_sparse_nlp_option_set_file (e04vkc).


#include <nag.h>
#include <nage04.h>
void  nag_opt_sparse_nlp_option_set_file (Nag_FileID fileid, Nag_E04State *state, NagError *fail)


nag_opt_sparse_nlp_option_set_file (e04vkc) may be used to supply values for optional parameters to nag_opt_sparse_nlp_solve (e04vhc). nag_opt_sparse_nlp_option_set_file (e04vkc) reads an external file whose fileid has been returned by a call to nag_open_file (x04acc). nag_open_file (x04acc) must be called to provide fileid. Each line of the file defines a single optional parameter. It is only necessary to supply values for those arguments whose values are to be different from their default values.
Each optional parameter is defined by a single character string 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 double value. Such numbers may be up to 16 contiguous characters which can be read using C's d or g 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.
The file containing the options must start with Begin and must finish with End. An example of a valid options file is:
Begin * Example options file 
   Print level = 5 
Optional parameter settings are preserved following a call to nag_opt_sparse_nlp_solve (e04vhc) 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 nag_opt_sparse_nlp_solve (e04vhc).
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in nag_opt_sparse_nlp_solve (e04vhc).




1:     fileid Nag_FileIDInput
On entry: the ID of the option file to be read as returned by a call to nag_open_file (x04acc).
2:     state Nag_E04State *Communication Structure
state contains internal information required for functions in this suite. It must not be modified in any way.
3:     fail NagError *Input/Output
The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

Error Indicators and Warnings

Dynamic memory allocation failed.
See Section in How to Use the NAG Library and its Documentation for further information.
On entry, argument value had an illegal value.
The initialization function nag_opt_sparse_nlp_init (e04vgc) has not been called.
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 2.7.6 in How to Use the NAG Library and its Documentation for further information.
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.
At least one line of the options file is invalid.
Could not read options file on unit fileid =value.
Could not read options file on unit fileid. This may be due to:
(a) fileid is not a valid unit number;
(b) a file is not associated with unit fileid, or if it is, is unavailable for read access;
(c) one or more lines of the options file is invalid. Check that all keywords are neither ambiguous nor misspelt;
(d) Begin was found, but end-of-file was found before End was found;
(e) end-of-file was found before Begin was found.


Not applicable.

Parallelism and Performance

nag_opt_sparse_nlp_option_set_file (e04vkc) is not threaded in any implementation.

Further Comments

nag_opt_sparse_nlp_option_set_string (e04vlc), nag_opt_sparse_nlp_option_set_integer (e04vmc) or nag_opt_sparse_nlp_option_set_double (e04vnc) may also be used to supply optional parameters to nag_opt_sparse_nlp_solve (e04vhc).


This example solves the same problem as the example in the document for nag_opt_sparse_nlp_solve (e04vhc), but sets and reads some optional parameters first. See Section 10 in nag_opt_sparse_nlp_solve (e04vhc) for further details.
The example in the document for nag_opt_sparse_nlp_jacobian (e04vjc) also solves the same problem (see Section 10 in nag_opt_sparse_nlp_jacobian (e04vjc)), but it first calls nag_opt_sparse_nlp_jacobian (e04vjc) to determine the sparsity pattern before calling nag_opt_sparse_nlp_option_set_file (e04vkc).

Program Text

Program Text (e04vkce.c)

Program Data

Program Options (e04vkce.opt)

Program Data (e04vkce.d)

Program Results

Program Results (e04vkce.r)

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