# NAG FL Interfacee04vkf (nlp2_​sparse_​option_​file)

Note: this routine is deprecated. Replaced by e04srf.
This was an option setting routine for e04vhf which has been superseded by e04srf. e04srf is part of the NAG optimization modelling suite (see Section 3.1 in the E04 Chapter Introduction) which uses the option setting facilities common to that suite.

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

e04vkf may be used to supply optional parameters to e04vhf from an external file. The initialization routine e04vgf must have been called before calling e04vkf.

## 2Specification

Fortran Interface
 Subroutine e04vkf ( cw, iw, rw,
 Integer, Intent (In) :: ispecs Integer, Intent (Inout) :: iw(*), ifail Real (Kind=nag_wp), Intent (Inout) :: rw(*) Character (8), Intent (InOut) :: cw(*)
#include <nag.h>
 void e04vkf_ (const Integer *ispecs, char cw[], Integer iw[], double rw[], Integer *ifail, const Charlen length_cw)
The routine may be called by the names e04vkf or nagf_opt_nlp2_sparse_option_file.

## 3Description

e04vkf may be used to supply values for optional parameters to e04vhf. e04vkf reads an external file and 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 $\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 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 $16$ 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.
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 parameter settings are preserved following a call to e04vhf 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 e04vhf.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in e04vhf.

None.

## 5Arguments

1: $\mathbf{ispecs}$Integer Input
On entry: the unit number of the option file to be read.
Constraint: ispecs is a valid unit open for reading.
2: $\mathbf{cw}\left(*\right)$Character(8) array Communication Array
Note: the actual argument supplied must be the array cw supplied to the initialization routine e04vgf.
3: $\mathbf{iw}\left(*\right)$Integer array Communication Array
Note: the actual argument supplied must be the array iw supplied to the initialization routine e04vgf.
4: $\mathbf{rw}\left(*\right)$Real (Kind=nag_wp) array Communication Array
Note: the actual argument supplied must be the array rw supplied to the initialization routine e04vgf.
5: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, $-1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $-1$ means that an error message is printed while a value of $1$ means that it is not.
If halting is not appropriate, the value $-1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-1$, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
${\mathbf{ifail}}=1$
The initialization routine e04vgf has not been called.
${\mathbf{ifail}}=2$
At least one line of the options file is invalid.
Could not read options file on unit ${\mathbf{ispecs}}=⟨\mathit{\text{value}}⟩$.
Could not read options file on unit ispecs. This may be due to:
1. (a)ispecs is not a valid unit number;
2. (b)a file is not associated with unit ispecs, or if it is, is unavailable for read access;
3. (c)one or more lines of the options file is invalid. Check that all keywords are neither ambiguous nor misspelt;
4. (d)Begin was found, but end-of-file was found before End was found;
5. (e)end-of-file was found before Begin was found.
${\mathbf{ifail}}=-99$
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

Not applicable.

## 8Parallelism and Performance

e04vkf is not threaded in any implementation.

e04vlf, e04vmf or e04vnf may also be used to supply optional parameters to e04vhf.

## 10Example

This example solves the same problem as the example in the document for e04vhf, but sets and reads some optional parameters first. See e04vhf for further details.
The example in the document for e04vjf also solves the same problem (see e04vjf), but it first calls e04vjf to determine the sparsity pattern before calling e04vkf.

### 10.1Program Text

Program Text (e04vkfe.f90)

### 10.2Program Data

Program Options (e04vkfe.opt)
Program Data (e04vkfe.d)

### 10.3Program Results

Program Results (e04vkfe.r)