NAG CL Interface
e04vkc (nlp2_​sparse_​option_​file)

Note: this function is deprecated. Replaced by e04src.
This was an option setting function for e04vhc which has been superseded by e04src. e04src is part of the NAG optimization modelling suite (see Section 4.1 in the E04 Chapter Introduction) which uses the option setting facilities common to that suite.
Settings help

CL Name Style:

1 Purpose

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

2 Specification

#include <nag.h>
void  e04vkc (Nag_FileID fileid, Nag_E04State *state, NagError *fail)
The function may be called by the names: e04vkc, nag_opt_nlp2_sparse_option_file or nag_opt_sparse_nlp_option_set_file.

3 Description

e04vkc may be used to supply values for optional parameters to e04vhc. e04vkc reads an external file whose fileid has been returned by a call to x04acc. 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:
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 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 e04vhc.
A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in e04vhc.

4 References


5 Arguments

1: fileid Nag_FileID Input
On entry: the ID of the option file to be read as returned by a call to 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 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
On entry, argument value had an illegal value.
The initialization function 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 7.5 in the Introduction to the NAG Library CL Interface for further information.
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.
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:
  1. (a)fileid is not a valid unit number;
  2. (b)a file is not associated with unit fileid, 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.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
e04vkc is not threaded in any implementation.

9 Further Comments

e04vlc, e04vmc or e04vnc may also be used to supply optional parameters to e04vhc.

10 Example

This example solves the same problem as the example in the document for e04vhc, but sets and reads some optional parameters first. See e04vhc for further details.
The example in the document for e04vjc also solves the same problem (see e04vjc), but it first calls e04vjc to determine the sparsity pattern before calling 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)