nag_opt_sparse_nlp_option_set_file (e04vkc) (PDF version)
e04 Chapter Contents
e04 Chapter Introduction
NAG Library Manual

# NAG Library Function Documentnag_opt_sparse_nlp_option_set_file (e04vkc)

## 1  Purpose

nag_opt_sparse_nlp_option_set_file (e04vkc) may be used to supply optional arguments 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).

## 2  Specification

 #include #include
 void nag_opt_sparse_nlp_option_set_file (Nag_FileID fileid, Nag_E04State *state, NagError *fail)

## 3  Description

nag_opt_sparse_nlp_option_set_file (e04vkc) may be used to supply values for optional arguments 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 argument. It is only necessary to supply values for those arguments whose values are to be different from their default values.
Each optional argument 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 $\left[=\right]$. Alphabetic characters may be upper or lower case. The string
`Print Level = 1`
is an example of a string used to set an optional argument. 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
End```
Optional argument settings are preserved following a call to nag_opt_sparse_nlp_solve (e04vhc) and so the keyword ${\mathbf{Defaults}}$ is provided to allow you to reset all the optional arguments to their default values before a subsequent call to nag_opt_sparse_nlp_solve (e04vhc).
A complete list of optional arguments, their abbreviations, synonyms and default values is given in Section 12 in nag_opt_sparse_nlp_solve (e04vhc).

None.

## 5  Arguments

1:    $\mathbf{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:    $\mathbf{state}$Nag_E04State *Communication Structure
state contains internal information required for functions in this suite. It must not be modified in any way.
3:    $\mathbf{fail}$NagError *Input/Output
The NAG error argument (see Section 3.6 in the Essential Introduction).

## 6  Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.2.1.2 in the Essential Introduction for further information.
NE_BAD_PARAM
On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.
NE_E04VGC_NOT_INIT
The initialization function nag_opt_sparse_nlp_init (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.
An unexpected error has been triggered by this function. Please contact NAG.
See Section 3.6.6 in the Essential Introduction for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 3.6.5 in the Essential Introduction for further information.
NE_OPTIONS_FILE_READ_FAILURE
At least one line of the options file is invalid.
Could not read options file on unit ${\mathbf{fileid}}=〈\mathit{\text{value}}〉$.
Could not read options file on unit ${\mathbf{fileid}}$. This may be due to:
 (a) ${\mathbf{fileid}}$ is not a valid unit number; (b) a file is not associated with unit ${\mathbf{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.

Not applicable.

## 9  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 arguments to nag_opt_sparse_nlp_solve (e04vhc).

## 10  Example

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 arguments 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).

### 10.1  Program Text

Program Text (e04vkce.c)

### 10.2  Program Data

Program Options (e04vkce.opt)

Program Data (e04vkce.d)

### 10.3  Program Results

Program Results (e04vkce.r)

nag_opt_sparse_nlp_option_set_file (e04vkc) (PDF version)
e04 Chapter Contents
e04 Chapter Introduction
NAG Library Manual